Cowdidocs
API ReferencePayees

Preview a payee destination

POST
/v1/user/payees/preview

Resolve a destination's registered account-holder name before the payee is saved, so the client can hint the recipient. Persists nothing and matches nothing. The authoritative Confirmation of Payee runs later, when the payee is created or the account is added. Requires an authenticated, active user.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Request Body

application/json

Request to resolve a payee destination's registered name before saving. The required fields depend on type.

Resolve a send-money destination's registered name before saving

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/user/payees/preview" \  -H "Content-Type: application/json" \  -d '{    "type": "SEND_MONEY",    "mobile_number": "254712345678"  }'
{  "account_holder_name": "Kenya Power Ltd",  "account_valid": true,  "message": "string"}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Unblock a payee POST

Unblock one of the caller's payees so payments to its accounts proceed again. Clears any recorded block reasons and details. Requires an authenticated, active user. Returns 404 when the payee does not exist or does not belong to the caller.

Brand & design

Official Cowdi logos, colours, and typography guidelines.