Skip to main content

Get Payment Details

POST
/payments/status/

Retrieve detailed information about a specific payment. There is no separate GET /payments/{id}/ endpoint. To get a single payment's details, use POST /payments/status/ with the transaction_id in the request body.

Authentication

Requires OAuth 2.0 authentication with read and write scopes.

Request Body

ParameterTypeRequiredDescription
transaction_idstring (UUID)YesThe unique identifier of the payment to retrieve

Example Request

curl -X POST {{BASE_URL}}/payments/status/ \
-H "Authorization: Bearer your_access_token" \
-H "Content-Type: application/json" \
-d '{
"transaction_id": "550e8400-e29b-41d4-a716-446655440000"
}'

Response

Success Response (200 OK)

{
"transaction_id": "550e8400-e29b-41d4-a716-446655440000",
"blockchain": "TRX",
"currency": "USDTTRC20",
"status": "completed",
"amount_usd": "100.00",
"amount_crypto": "100.050000",
"address": "TYN2WuEqttM5JjGk4ynGkxcnMRR9SZcvVx",
"token": "USDT",
"transaction_hash": "abc123def456...",
"order_id": "ORDER-12345",
"order_description": "Premium subscription",
"callback_url": "https://your-site.com/webhook/payment",
"expiry_time": "2026-01-15T10:30:00Z",
"created_at": "2026-01-15T10:00:00Z",
"updated_at": "2026-01-15T10:20:00Z",
"is_fixed_rate": true,
"is_fee_paid_by_user": false
}

Response Fields

Returns the full TransactionDetailSerializer — see Get Payment Status for the complete field reference.

FieldTypeDescription
transaction_iduuidUnique payment identifier
blockchainstringBlockchain network (e.g., "TRX", "ETH")
currencystringCombined currency code (e.g., "USDTTRC20")
statusstringCurrent payment status
amount_usddecimalAmount in price currency (USD)
amount_cryptostringCryptocurrency amount
addressstringBlockchain payment address
tokenstringToken symbol
transaction_hashstringBlockchain transaction hash (null until payment detected)
order_idstringYour order identifier
order_descriptionstringPayment description
callback_urlstringWebhook URL
expiry_timedatetimeISO 8601 expiration timestamp
created_atdatetimeISO 8601 creation timestamp
updated_atdatetimeISO 8601 last update timestamp
is_fixed_ratebooleanWhether fixed exchange rate was used
is_fee_paid_by_userbooleanWhether the customer pays network fees

Error Responses

404 Not Found

{
"error": {
"code": "not_found",
"message": "Payment not found",
"details": {
"transaction_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
}

400 Bad Request

{
"error": {
"code": "invalid_request",
"message": "Invalid transaction ID format"
}
}

Notes

  • This page documents how to retrieve a single payment. The API does not have a GET /payments/{id}/ endpoint.
  • Use POST /payments/status/ with the transaction_id in the JSON body to get full payment details.
  • This is the same endpoint documented on the Get Payment Status page.
  • For real-time updates, use webhooks instead of polling.

Related Endpoints