Documentation
Search
K

Payments

Payments Data Model

Field
Type
Example
id
String
"PMT-13ea4c32-7eee-4201-bead-51bbd090c472"
externalId
String
"020d0f3f9d004f492b38b499712c3767b6f5313f0152c87c48d3bed4c88ec747"
status
Enum [
NEW,
SUCCESS,
PARTIAL_SUCCESS,
FAILED,
EXPIRED,
PENDING,
CANCELLED,
FROZEN
]
"SUCCESS"
orderId
String
"ORD-d9317522-919d-4a62-adf8-7abbb49ff464"
currency
Enum [
BTC,
ETH,
USDT,
TRX,
EUR,
USD,
UAH,
KZT,
TRY,
IDR
]
"USDT"
blockchain
Enum [
ETHEREUM,
TRON
]
"ETHEREUM"
amount
Float
100
orderType
Enum [
PAYIN,
PAYOUT,
EXCHANGE
TRANSFER
]
"PAYOUT"
transactionType
Enum [
CREDIT,
DEBIT
]
"CREDIT"
method
Enum [
CRYPTOCOIN,
CC_VISAMC,
VA_QR
]
"CC_VISAMC"
createdAt
String
"2022-02-16T16:07:18.708563Z"
reason
String
"Bank decline"
comment
String
"Comment"
clientOrderId
String
"000001"
payUrl
String
"https://example.com/"
payoutCryptoAddress
String
"TN7K8k7ASf4rPrD5YjffnXWdbd8sj23363"
payoutCardNumber
String
"1234123412341234"
transferTo
String
"OWN-b9b88002-93a7-48df-856c-b9be73aad5eb"
balanceAfterPayment
Float
200
payinBankAccount
String
"14123421"
The following payment statuses are considered final:
  • SUCCESS
  • PARTIAL_SUCCESS - in case the amount processed is less than the requested amount. The unprocessed difference is returned to the balance. The unprocessed difference can be found in payment details
  • FAILED
  • EXPIRED
  • CANCELLED

Payments API

All the requests described below require authentication headers. For more information please refer to the "Authentication" page.
If you are interested in receiving order updates in webhook style pay attention to the "Callbacks" page.
get
/v1/user/methods
Get payment methods
get
/v1/user/payments
Get all payments
get
/v2/user/payments/search
Search payments
get
/v1/user/payments/{id}
Get payment
post
/v1/user/payments/payin
Create pay-in
post
/v1/user/payments/payout
Create pay-out