Skip to content
Authorization<token>

Use a public key (pk./pk_test.) for payment initialization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment — there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

per_page?integer | null

Must be at least 1. Must not be greater than 100.

cursor?string | null
search?string | null

Must not be greater than 255 characters.

type?"individual" | "business"
"individual""business"
status?"active" | "inactive" | "blocked"
"active""inactive""blocked"
country?string | null

Must be 2 characters.

customer_group?string | null

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/customers" \  -H "Content-Type: application/json" \  -d '{}'
GET
/customers
{
  "code": 200,
  "status": "OK",
  "message": "Customers retrieved",
  "items": [
    {
      "id": "cus_01JXXX",
      "email": "amina@example.com",
      "name": "Amina Diallo"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 16,
    "per_page": 25,
    "total": 156
  }
}
{
  "code": 401
}
{
  "code": 429
}