API Reference
StatusPlazaCreate Account
  1. API Gateway
  2. Sales

Create a sale

post
https://api.buckaroo.io/v1/sales
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Optional store identifier. If not provided, the oldest existing store will be used.

string
required

The sale reference. This value has to be URL safe: it may only contain letters, digits and the characters '-', '.', '_' and '~'.

string
required

The currency of the sale

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

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

breakdown
object | null

Breakdown of the sale amount including fees and taxes

string | null

Description of the sale

string | null

The locale for the sale

string | null
enum

The sequence type

Allowed:
string | null
enum

The intent type

Allowed:
string | null

Description for the bank statement of the consumer

paymentMethods
array of objects | null

The allowed payment methods for this sale

paymentMethods
Allowed:
paymentMethodOptions
object | null

Payment method specific options for the sale

string | null

URL for the consumer to return to after completing payment

string | null

URL for the consumer to return to after cancelling payment

customer
object | null

Customer information for the sale

sessionData
object | null

Session data to be stored with the sale

string | null

The mandate identifier for recurring payments

metadata
object | null

Additional metadata. You can provide a flat JSON object with key-value pairs. Include any additional information that you want to store with the sale.

shippingCustomer
object | null

Shipping customer information for the sale

shipments
array of objects | null

Shipments associated with the sale

shipments
orderLines
array of objects | null

Order lines for the sale

orderLines
Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json

Updated 6 days ago

Did this page help you?