Recipients

Add a payout account

POST
/v1/recipients

Register a bank account that collections pay out to. Pulse verifies the account with the bank and returns the registered name.

Set is_default to make it the account for collections created without recipient_id. A new default replaces the previous one.

Authorization

ApiKeyAuth
X-API-Key<token>

The API key identifies your business. Requests do not include a business ID.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/recipients" \  -H "Content-Type: application/json" \  -d '{    "type": "bank_account",    "is_default": true,    "bank_account": {      "bank_code": "058",      "account_number": "0123456789"    }  }'
{  "status": true,  "data": {    "id": "0199d1a4-6b2e-7c31-a8f0-3d5e9c1b7a42",    "type": "bank_account",    "is_default": true,    "bank_account": {      "bank_code": "058",      "bank_name": "GTBank",      "account_number": "0123456789",      "account_name": "ACME SAVINGS LTD"    },    "created_at": "2026-10-15T09:12:40Z"  }}