API ReferencePayees
Preview a payee destination before saving
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 when the payee is created or the account added.
Request Body
application/json
Request to resolve a payee destination's registered name before saving. The required fields depend on type. Bank accounts are not yet verifiable, so they are not previewable.
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": "WAITING_LIST", "description": "User is in the waiting list"}{ "code": "TOO_MANY_REQUESTS", "description": "Too Many Requests"}{ "code": "INTERNAL_SERVER_ERROR", "description": "Internal Server Error"}