API Reference · Cards
Cardholders
Verified individuals or employees eligible to hold issued rafiqPay cards.
The cardholder object
Represents a cardholder entity in the rafiqPay system.
| Field | Type & Flags | Description |
|---|---|---|
| id | string | Cardholder ID (crh_...). |
| name | string | Name embossed on card. |
Example cardholder JSON
cardholder example payload
{
"id": "crh_01",
"name": "Kelechi Nwachukwu",
"email": "kelechi@kanzu.ng"
}Endpoints & Operations
POST/v1/cardholdersProposed
Create a cardholder
Creates a cardholder profile.
Request Example
POST /v1/cardholders
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/cardholders" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_create-cardholder_01" \
-H "Content-Type: application/json" \
-d '{
"name": "Kelechi Nwachukwu",
"email": "kelechi@kanzu.ng",
"phone": "+2348031112233"
}'Response (200 OK)
Response payload
{
"id": "crh_01",
"name": "Kelechi Nwachukwu"
}GET/v1/cardholders/:idProposed
Retrieve a cardholder
Retrieves a cardholder.
Request Example
GET /v1/cardholders/:id
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/cardholders/:id" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"id": "crh_01"
}PATCH/v1/cardholders/:idProposed
Update a cardholder
Updates cardholder details.
Request Example
PATCH /v1/cardholders/:id
cURL · v1
curl -X PATCH "https://api.rafiqpay.net/v1/cardholders/:id" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Content-Type: application/json" \
-d '{
"phone": "+2348039998877"
}'Response (200 OK)
Response payload
{
"id": "crh_01"
}GET/v1/cardholdersProposed
List cardholders
Lists cardholders.
Request Example
GET /v1/cardholders
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/cardholders" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"object": "list",
"data": [],
"hasMore": false,
"nextCursor": null
}Related Webhook Events
These events are dispatched to your webhook endpoints when actions occur on this resource: