Skip to main content
POST
Create a payment

Authorizations

X-API-Key
string
header
required

Headers

X-Account-ID
string

Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).

X-Idempotency-Key
string

Idempotency key

Body

application/json

Body

amount
integer
required
Required range: x >= 0
continuation
object
required
currency_code
string
required
order_id
string
required
additional_information
object
customer_id
string<uuid>
distributions
object[]
metadata
object

Key-value pairs. Max 20 entries. Keys max 20 characters, values must be strings max 80 characters. No nested objects.

payment_method
object

Token is required for all types except BANK_TRANSFER. For BANK_TRANSFER, token must not be provided.

vault_payment_method
boolean

When true, customer_id is required.

Response

Success

additional_information
object
amount
integer
continuation
object
created_at
string<date-time>
currency
string
customer_id
string<uuid>
distributions
DistributionResponse · object[]
id
string<uuid>
metadata
object
order_id
string
payment_method
PaymentInstrumentResponse · object
processing
ProcessingResponse · object
processor
ProcessorResponse · object
refunds
RefundResponse · object[]
settlements
SettlementResponse · object[]
status
enum<string>
Available options:
OPEN,
AUTHORIZED,
ACCEPTED,
FAILED,
COMPLETED,
VOIDED
transactions
TransactionResponse · object[]