Create Order

Creates a client exchange order. The order is scoped to the exchanges accessible by the API key. Status begins at ORDERINIT.

POST /partner/orders

Create a new exchange order

cURL

curl --request POST \
  --url https://api.example.com/api/v1/partner/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cashbox": {
    "id": 1
  },
  "currency1": {
    "id": 1
  },
  "currency2": {
    "id": 2
  },
  "operationType": "offer",
  "clientAmount": 1000
}
'

201

{
  "id": 1001,
  "hashedId": "a3f7b2c1d4e5",
  "status": "CLIENTPAYMENTWAIT",
  "clientAmount": 1000,
  "exchangeAmount": 41500,
  "currency1": {
    "id": 123,
    "code": "USD"
  },
  "currency2": {
    "id": 123,
    "code": "UAH"
  },
  "cashbox": {
    "id": 1
  },
  "user": {
    "id": 1
  },
  "comment": "<string>",
  "clientComment": "<string>",
  "operationType": "offer",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Partner API key. Format: sk_branch_<32chars>, sk_personal_<32chars>, or pk_<32chars> (public, read-only)

Body

application/json

cashbox · object · required

The cashbox (exchange point) to process the order

Show child attributes

currency1 · object · required

Source currency

Show child attributes

currency2 · object · required

Destination currency

Show child attributes

operationType · enum<string> · required

Available options: offer, finop

Example:

"offer"

clientAmount · number

Amount the client provides

Example:

1000

exchangeAmount · number

Amount the exchange provides

Example:

41500

paymentMethodSource · object

Payment method for receiving from client

Show child attributes

paymentMethodDest · object

Payment method for sending to client

Show child attributes

user · object

Client user reference

Show child attributes

comment · string

Example:

"Internal note"

clientComment · string

Example:

"Client note"

userWallet · string

Example:

"43588345943"

tgNickName · string

Example:

"@tgnamenew"

Response

201

application/json

Order created successfully

id · integer

Example:

1001

hashedId · string

Example:

"a3f7b2c1d4e5"

status · enum<string>

Available options: ORDERINIT, CLIENTPAYMENTWAIT, EXCHANGEPAYMENTWAIT, CASHOUT, SUCCESS, CANCEL

Example:

"CLIENTPAYMENTWAIT"

clientAmount · number

Example:

1000

exchangeAmount · number

Example:

41500

currency1 · object

Show child attributes

currency2 · object

Show child attributes

cashbox · object

A reference to another entity, identified by numeric ID

Show child attributes

user · object

A reference to another entity, identified by numeric ID

Show child attributes

comment · string | null

clientComment · string | null

operationType · enum<string>

Available options: offer, finop

createdAt · string<date-time>

updatedAt · string<date-time>