Get the payment account

GET

/payments/account

const url = 'https://example.com/payments/account';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/payments/account \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

The business’s own provider account, connected to Bottle. Money settles to them; Bottle never holds it. Until the provider says the account may take charges, no payment link can be sent.

Authorizations

sessionCookie
billing:read
apiKey
billing:read

Responses

200

Where they stand

application/json

object

status

required

string

Allowed values: none pending ready

provider

required

object

required

string

name

required

string

manageUrl

required

string | null format: uri

capabilities

required

Array<string>

Allowed values: account_onboarding connect_existing payment_links payment_link_cancellation hosted_checkout account_summary card_present

chargesEnabled

required

boolean

detailsSubmitted

required

boolean

onboardingUrl

required

string | null format: uri

existingAccountAvailable

boolean

Example

{
  "status": "none",
  "provider": {
    "capabilities": [
      "account_onboarding"
    ]
  }
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

503

Payments are not configured on this installation

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}