Connect a payment account

POST

/payments/account

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

Creates an account with the selected provider and returns where to finish setup. Call it again for a fresh link whenever setup was left half done.

Authorizations

• sessionCookie
  billing:write
• apiKey
  billing:write

Parameters

Query Parameters

provider

string

Responses

200

The account, with somewhere to go next

Media typeapplication/json

object

status

required

string

Allowed values: none pending ready

provider

required

object

id

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

Media typeapplication/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

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

409

A different provider is already connected

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

503

Payments are not configured on this installation

Media typeapplication/json

object

error

required

string

message

required

string

Example

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