Skip to main content
POST
Create an idempotent settlement order

Authorizations

Authorization
string
header
required

Integration API key. Send as Bearer copby_live_pk_….

Headers

Idempotency-Key
string
required

Unique key for one logical order

Maximum string length: 200

Body

application/json
quoteId
string
required
Maximum string length: 40
reference
string
Maximum string length: 200

Response

Settlement order created

orderId
string
required
Example:

"ord_example"

status
enum<string>
required
Available options:
CREATED
health
enum<string>
required
Available options:
HEALTHY
fundsStatus
enum<string>
required
Available options:
IN_USER_WALLET
execution
object
required