Cowdidocs
API ReferencePayees

Combine payees

Merge another payee's accounts into this one, then delete the source payee.

POST
/v1/user/payees/{payeeId}/combine

Path Parameters

payeeId*string

Target payee ID — the one that survives

Formatuuid

Request Body

application/json

Combine another payee into this one

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/user/payees/497f6eca-6276-4993-bfeb-53cbbbba6f08/combine" \  -H "Content-Type: application/json" \  -d '{    "source_payee_id": "0821b7da-ecf4-4d24-9d42-a5e75712c3e0"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "label": "string",  "display_name": "string",  "is_favorite": false,  "is_blocked": false,  "block_reasons": [    "UNWANTED_PAYMENTS"  ],  "block_details": "string",  "is_cowdi_user": false,  "cowdi_user_id": "3358b8ba-768f-4336-94f0-46ebcf93566d",  "cowdi_user_tag": "@johnd123456",  "accounts": [    {      "resource_id": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "SEND_MONEY",      "account_holder_name": "string",      "linked_user_id": "808bbbe6-53f8-43d8-b004-261579603132",      "linked_user_tag": "@johnd123456",      "mobile_number": "+254712345678",      "transaction_count": 15,      "last_used_at": "2019-08-24T14:15:22Z",      "verification_status": "VERIFIED",      "verified_at": "2019-08-24T14:15:22Z",      "verification": {        "resolved_name": "John Doe",        "account_valid": true,        "requires_confirmation": false,        "message": "string"      }    }  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "resource_id": "string"}
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "WAITING_LIST",  "description": "User is in the waiting list"}
{  "code": "BAD_REQUEST",  "description": "Invalid input"}
{  "code": "TOO_MANY_REQUESTS",  "description": "Too Many Requests"}
{  "code": "INTERNAL_SERVER_ERROR",  "description": "Internal Server Error"}

Add a payee account POST

Add a payable account to an existing payee. The account is verified inline at add time.

Preview a payee destination before saving POST

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.