GET
/
api
/
v1
/
payments
/
{id}
curl --request GET \
  --url 'https://brain.orcuspay.com/api/v1/payments/pay_prod_8f499d0627da46a797fe998d7c4aa735' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx'
{
  "id": "pay_prod_8f499d0627da46a797fe998d7c4aa735",
  "status": "SUCCEEDED",
  "amount": 500.00,
  "currency": "BDT",
  "transaction_id": "BGT649020260331166821",
  "payment_method": "sslcommerz",
  "customer": {
    "name": "Rahim Ahmed",
    "email": "rahim@gmail.com",
    "phone": "01827297490",
    "address": "House 81, Road 22, Sector 7, Uttara"
  },
  "created_at": "2025-03-31T12:00:00.000Z",
  "updated_at": "2025-03-31T12:01:30.000Z"
}

Headers

x-api-key
string
required
Your API access key.
x-api-secret
string
required
Your API secret key.

Path Parameters

id
string
required
The ID of the payment to retrieve.

Response

id
string
Unique payment ID.
status
string
Payment status: PENDING, SUCCEEDED, FAILED, CANCELLED, or REFUNDED.
amount
number
Payment amount in BDT (taka).
currency
string
Currency code. Always BDT.
transaction_id
string
Gateway transaction ID, if available.
payment_method
string
Payment method used (e.g. bkash_merchant, sslcommerz).
customer
object
Customer details.
created_at
string
ISO 8601 timestamp.
updated_at
string
ISO 8601 timestamp.
curl --request GET \
  --url 'https://brain.orcuspay.com/api/v1/payments/pay_prod_8f499d0627da46a797fe998d7c4aa735' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx'
{
  "id": "pay_prod_8f499d0627da46a797fe998d7c4aa735",
  "status": "SUCCEEDED",
  "amount": 500.00,
  "currency": "BDT",
  "transaction_id": "BGT649020260331166821",
  "payment_method": "sslcommerz",
  "customer": {
    "name": "Rahim Ahmed",
    "email": "rahim@gmail.com",
    "phone": "01827297490",
    "address": "House 81, Road 22, Sector 7, Uttara"
  },
  "created_at": "2025-03-31T12:00:00.000Z",
  "updated_at": "2025-03-31T12:01:30.000Z"
}