Skip to main content
GET
Get payment status by id

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Unique identifier of the payment

Response

200 - application/json

200

Successful response with payment status details

paymentId
string<uuid>
required

Unique payment identifier

status
enum<string>
required

Payment status

Available options:
waiting,
confirming,
failed,
locked,
rejected,
expired,
paid,
paid_over,
paid_partial
payAmount
number
required

Crypto AMOUNT+PERCENT

payAddress
string
required

Payment address

payQrCodeUri
string
required

URI for payment QR code

currency
string
required

Cryptocurrency type (btc, usdt, eth, etc)

Minimum string length: 1
network
string
required

Cryptocurrency network (e.g., erc20)

customerId
string
required

Customer ID (for security)

Minimum string length: 1
customerIp
string
required

Customer IP address (for security)

Minimum string length: 1
orderId
string
required

Order id

platformFeeByUser
boolean
required

Fee by user/merchant

createdAt
string<date-time>
required

Date of creation

updatedAt
string<date-time>
required

Date of update

expiredAt
string<date-time>
required

Date of expire

webhookUrl
string<uri>
required

Webhook url

paidAmount
number
required

Amount paid

merchantAmount
number
required

Amount of money was paid to merchant

paidAddress
string
required

Payment address

additionalData
string

Additional data