The Payment Company Logo

StatusApi

Transaction Status

The Status API retrieves the status of a specific transaction by `transaction_id` or `order_id`. This endpoint returns real-time transaction data, including status, amount, currency, and customer information.

SectionStatusApi
Topics04
PathstatusApi

API Endpoint

Live APIProduction environment
GEThttps://api.thepayment.company/api/live/status/{id}
Test APISandbox environment
GEThttps://api.thepayment.company/api/test/status/{id}

Examples:

  • https://api.thepayment.company/api/live/status/TPC01862809 (lookup with transaction_id)
  • https://api.thepayment.company/api/live/status/order67890 (lookup with order_id)

Query Parameters

ParameterTypeRequiredDescription
transaction_idStringYesUnique transaction ID used to fetch the transaction status.
order_idStringNoOrder ID supplied when the transaction was created.

Headers

Header NameDescription
Content-TypeDefines the content type. Always use application/json.
AuthorizationBearer token used for authentication.

Sample Responses

Note

Response payload format varies by payment method:

  • Card & APM transactions: Standard response with refund and chargeback details.
  • Crypto Payin transactions: Extended response with crypto-specific fields such as crypto_currency, crypto_network, crypto_payment_status, and crypto payment amounts.
Card and APM transaction:
{
"status": "SUCCESS",
"message": "Transaction processed successfully!.",
"data": {
  "amount": "100",
  "currency": "INR",
  "order_id": null,
  "transaction_id": "TPC7663692011084535",
  "customer": {
    "first_name": "Tushar",
    "last_name": "vashishth",
    "email": "test@gmail.com"
  },
  "refund": {
    "status": false,
    "refund_date": null
  },
  "chargeback": {
    "status": false,
    "chargeback_date": null
  },
  "descriptor": "xbank",
  "is_card_WL": false
}
}
Crypto pay-in transaction:
{
"status": "SUCCESS",
"message": "Transaction processed successfully!.",
"data": {
  "amount": 10,
  "currency": "USD",
  "order_id": null,
  "transaction_id": "TPC7945391549251682",
  "customer": {
    "first_name": "James",
    "last_name": "doe",
    "email": "james@gmail.com"
  },
  "refund": {
    "status": false,
    "refund_date": null
  },
  "crypto_currency": "TRX",
  "crypto_network": "TRON",
  "crypto_payment_status": "UNDERPAID",
  "crypto_amount": 10,
  "crypto_paid_amount": 6.4
}
}

Additional Crypto Response Fields:

FieldTypeDescription
crypto_currencyStringCryptocurrency used for the payment, such as TRX, BTC, ETH, or USDT.
crypto_networkStringBlockchain network used for the transaction, such as TRON or Ethereum.
crypto_payment_statusStringCurrent crypto payment status. Possible values are FULLPAID, UNDERPAID, and OVERPAID.
crypto_amountNumberExpected crypto amount for the transaction.
crypto_paid_amountNumberActual crypto amount received from the customer.

Understanding Crypto Payment Status

  • FULLPAID: The exact crypto amount was received, so the transaction is successful.
  • UNDERPAID: The received amount is lower than required, so the transaction may fail.
  • OVERPAID: The received amount is higher than required, and excess handling depends on your configuration.

Previous

Supported Assets

Next

Refund API

On this page