Create a payment session for a sale

post

https://api.buckaroo.io/v1/sales/{saleId}/sessions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

saleId

string

required

Body Params

amount

string | null

required

^-?\d+\.\d{2,}$

Decimal value formatted as string with minimum 2 decimal places (e.g., "123.45"). Can be null.

currency

string

required

length ≥ 1

The currency of the session. Has to be the currency of the sale.

intentType

string

enum

required

What the session collects: Pay, Authorize or Credit.

Allowed:

reference

string | null

Reference for the session. The reference of the sale is used when this is not provided.

description

string | null

Description of the session. The description of the sale is used when this is not provided.

statementDescriptor

string | null

Description for the bank statement of the consumer. The statement descriptor of the sale is used when this is not provided.

Headers

string

enum

Defaults to application/hal+json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

application/problem+json

201Created

400Bad Request

401Unauthorized

404Not Found

409Conflict