Skip to main content
POST
Create a new exchange order

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

currency1
object
required

Source currency

currency2
object
required

Destination currency

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

paymentMethodDest
object

Payment method for sending to client

user
object

Client user reference

comment
string
Example:

"Internal note"

clientComment
string
Example:

"Client note"

userWallet
string
Example:

"43588345943"

tgNickName
string
Example:

"@tgnamenew"

Response

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
currency2
object
cashbox
object

A reference to another entity, identified by numeric ID

user
object

A reference to another entity, identified by numeric ID

comment
string | null
clientComment
string | null
operationType
enum<string>
Available options:
offer,
finop
createdAt
string<date-time>
updatedAt
string<date-time>