Skip to content
Bottle

What the business's payment provider reports

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

Where supported: money in the account, pending money, payouts and anything the provider needs from the owner. Read only: the provider pays the business and Bottle never moves money.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The normalised provider account summary

Media typeapplication/json
object
connected
required
boolean
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
payoutsEnabled
required
boolean | null
availablePence
required
integer | null
pendingPence
required
integer | null
nextPayout
required
object
date
required
string format: date
pence
required
integer
lastPayout
required
object
date
required
string format: date
pence
required
integer
disabledReason
required
string | null
problems
required
Array<object>
object
code
required
string
kind
required
string
Allowed values: bank identity_document terms date_of_birth address identity_number contact website business_activity company_number people business_details other
requirement
required
string
when
required
string
Allowed values: now soon later
reason
required
string | null
deadline
required
string | null format: date

Example 

{
  "provider": {
    "capabilities": [
      "account_onboarding"
    ]
  },
  "problems": [
    {
      "kind": "bank",
      "when": "now"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “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"
}

503

Section titled “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"
}