Skip to main content
GET
/
v1
/
recipients
Get Recipients
curl --request GET \
  --url https://api.chessa.ai/v1/recipients
{
  "recipients": [
    {
      "accountName": "John Doe",
      "accountNumber": "0123456789",
      "bankCode": "058",
      "bankName": "Guaranty Trust Bank",
      "country": "NG",
      "createdAt": "2025-01-15T10:30:45.123Z",
      "currency": "NGN",
      "id": "rec_123456789abcdef",
      "type": "bank_account",
      "updatedAt": "2025-01-15T10:30:45.123Z"
    },
    {
      "accountName": "Jane Smith",
      "accountNumber": "9876543210",
      "bankCode": "033",
      "bankName": "United Bank for Africa",
      "country": "NG",
      "createdAt": "2025-02-20T14:22:33.456Z",
      "currency": "NGN",
      "id": "rec_987654321fedcba",
      "type": "bank_account",
      "updatedAt": "2025-02-20T14:22:33.456Z"
    }
  ]
}

Headers

x-client-id
string
Example:

""

x-client-secret
string
Example:

""

Query Parameters

currency
string
Example:

"NGN"

country
string
Example:

"NG"

Response

Success Response

recipients
object[]
Example:
[
{
"accountName": "John Doe",
"accountNumber": "0123456789",
"bankCode": "058",
"bankName": "Guaranty Trust Bank",
"country": "NG",
"createdAt": "2025-01-15T10:30:45.123Z",
"currency": "NGN",
"id": "rec_123456789abcdef",
"type": "bank_account",
"updatedAt": "2025-01-15T10:30:45.123Z"
},
{
"accountName": "Jane Smith",
"accountNumber": "9876543210",
"bankCode": "033",
"bankName": "United Bank for Africa",
"country": "NG",
"createdAt": "2025-02-20T14:22:33.456Z",
"currency": "NGN",
"id": "rec_987654321fedcba",
"type": "bank_account",
"updatedAt": "2025-02-20T14:22:33.456Z"
}
]