Checkout
Create one-shot payment
Charge a customer once, with no subscription and no stored mandate.
POST/v1/checkout/one_shot
Parameters
| Parameter | Description |
|---|---|
| amount_centsintegerrequired | No description in the spec. |
| currencystringrequired | At most 3 characters. |
| customer_idstringrequired | At most 64 characters. |
| methodenumrequired | One of creditcard, directdebit, ideal, bancontact, eps, applepay. |
| success_urlstring (uri)required | Must be an absolute URL. At most 2083 characters. |
| cancel_urlstring (uri) | nulloptional | Must be an absolute URL. At most 2083 characters. |
| descriptionstring | nulloptional | At most 255 characters. |
| metadataobject | nulloptional | At most 50 keys. |
| refund_window_daysinteger | nulloptional | Between 0 and 365. |
| tax_behaviorenum | nulloptional | One of inclusive, exclusive. |
Returns
Returns an OneShotPaymentResponse object.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the checkout_sessions:write scope. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other checkout operations
- Get one-shot payment GET /v1/checkout/one_shot/{one_shot_id}
- Create a Checkout session POST /v1/checkout/sessions
- Get checkout session GET /v1/checkout/sessions/{checkout_id}
BillKit