Skip to main content
POST
A payment page that adds funds to this organization's balance, for a person to open and pay. Nothing is charged by this call, and no card is used: it only creates the page. Leave `amount` out to read the limits without creating anything. Needs a key with the `account:read` scope.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
string

How much to add, in USD dollars, like 25 or 49.99; at most two decimals. Leave it out to read the limits without creating a link.

Required string length: 1 - 32

Response

The limits, and the payment page when an amount was given.

currency
string
required
Allowed value: "USD"
limits
object
required
amount
object | null
required

What the link is for; null when the request named no amount.

checkout_url
string<uri> | null
required

The payment page to open in a browser; null when the request named no amount. Paying it adds the amount to this organization's balance.