API Reference · Connect
Connected Accounts
Sub-merchant records for platforms and marketplaces. Records only for now: no invitation is emailed and no money is settled to them.
The connected_account object
Represents a connected_account entity in the rafiqPay system.
| Field | Type & Flags | Description |
|---|---|---|
| id | string | Account ID (acct_...). |
| businessName | string | Legal or trading name. |
| kybTier | enum | TIER_1 | TIER_2 | TIER_3. |
Example connected_account JSON
connected_account example payload
{
"id": "acct_seller_01",
"businessName": "Barakah Books Kano",
"kybTier": "TIER_2",
"payoutsEnabled": true
}Endpoints & Operations
POST/v1/connected-accountsProposed
Create a connected account
Proposed. Not built.
Request Example
POST /v1/connected-accounts
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/connected-accounts" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_create-connected-account_01" \
-H "Content-Type: application/json" \
-d '{
"businessName": "Barakah Books Kano",
"email": "books@barakah.ng"
}'Response (200 OK)
Response payload
{
"id": "acct_seller_01",
"kybTier": "TIER_1"
}GET/v1/connected-accounts/:idProposed
Retrieve a connected account
Retrieves a connected account.
Request Example
GET /v1/connected-accounts/:id
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/connected-accounts/:id" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"id": "acct_seller_01"
}GET/v1/connected-accountsProposed
List connected accounts
Lists connected accounts.
Request Example
GET /v1/connected-accounts
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/connected-accounts" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"object": "list",
"data": [],
"hasMore": false,
"nextCursor": null
}POST/v1/connected-accounts/:id/onboarding-linksProposed
Create an onboarding link
Generates a hosted KYB onboarding URL.
Request Example
POST /v1/connected-accounts/:id/onboarding-links
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/connected-accounts/:id/onboarding-links" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_create-onboarding-link_01"Response (200 OK)
Response payload
{
"url": "https://dashboard.rafiqpay.net/connect/onboard/ob_01"
}POST/v1/connected-accounts/:id/inviteProposed
Email the onboarding link
Emails the KYB onboarding invitation to the sub-merchant.
Request Example
POST /v1/connected-accounts/:id/invite
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/connected-accounts/:id/invite" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_invite-connected-account_01"Response (200 OK)
Response payload
{
"sent": true
}GET/v1/connected-accounts/:id/requirementsProposed
List KYB requirements
Lists outstanding KYB documents needed for Tier 2/3.
Request Example
GET /v1/connected-accounts/:id/requirements
cURL · v1
curl -X GET "https://api.rafiqpay.net/v1/connected-accounts/:id/requirements" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"Response (200 OK)
Response payload
{
"currentlyDue": [
"cac_certificate"
]
}POST/v1/connected-accounts/:id/payouts/pauseProposed
Pause payouts
Pauses automatic settlements for a connected account.
Request Example
POST /v1/connected-accounts/:id/payouts/pause
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/connected-accounts/:id/payouts/pause" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_pause-connected-payouts_01"Response (200 OK)
Response payload
{
"payoutsEnabled": false
}POST/v1/connected-accounts/:id/payouts/resumeProposed
Resume payouts
Resumes payouts for a connected account.
Request Example
POST /v1/connected-accounts/:id/payouts/resume
cURL · v1
curl -X POST "https://api.rafiqpay.net/v1/connected-accounts/:id/payouts/resume" \
-H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
-H "Idempotency-Key: idem_resume-connected-payouts_01"Response (200 OK)
Response payload
{
"payoutsEnabled": true
}Related Webhook Events
These events are dispatched to your webhook endpoints when actions occur on this resource: