GET
/
api
/
v1
/
payments
curl --request GET \
  --url 'https://brain.orcuspay.com/api/v1/payments?limit=10' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx'

{
  "data": [
    {
      "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"
      },
      "created_at": "2025-03-31T12:00:00.000Z",
      "updated_at": "2025-03-31T12:01:30.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

​
Headers

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

​
Query Parameters

​
limit
number
default:"20"
Number of payments to return. Maximum 100.
​
cursor
string
Cursor for pagination. Pass the next_cursor value from the previous response to get the next page.
​
status
string
Filter by payment status. One of: PENDING, SUCCEEDED, FAILED, CANCELLED, REFUNDED.

​
Response

​
data
array
List of payment objects.
​
has_more
boolean
Whether there are more payments beyond this page.
​
next_cursor
string
Pass this value as cursor in the next request to fetch the next page. null if there are no more results.
curl --request GET \
  --url 'https://brain.orcuspay.com/api/v1/payments?limit=10' \
  --header 'x-api-key: ak_prod_xxxxxxxxxxxx' \
  --header 'x-api-secret: sk_prod_xxxxxxxxxxxx'

{
  "data": [
    {
      "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"
      },
      "created_at": "2025-03-31T12:00:00.000Z",
      "updated_at": "2025-03-31T12:01:30.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}