Create a payment session

Creates a payment attempt on a token/chain. Returns the deposit address the buyer pays. A 409 means an active session already exists (the response includes activeSessionId).

Authentication

x-api-keystring
API Key authentication via header

Path parameters

checkoutIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
mintIdintegerRequired
refund_addressstringOptional>=1 character

Response

Existing active session
idstringformat: "uuid"
checkoutIdstringformat: "uuid"
mintIdinteger
rateLockedstring
amountRequiredstring
amountReceivedstring
refundAddressstring
minConfirmationsinteger
expiresAtdatetime
statusenum
riskFlagmap from strings to any or null
quarantineDeadlineAtdatetime or null
depositAddressstring
Send payment here
depositAddressPathstring
chainenum
tokenstring
createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error