Cowdidocs
API ReferencePayees

Delete a payee

DELETE
/v1/user/payees/{payeeId}

Delete one of the caller's payees and all of its accounts. Requires an authenticated, active user. Returns 404 when the payee does not exist or does not belong to the caller.

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

Path Parameters

payeeId*string

Unique identifier of the payee.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/user/payees/550e8400-e29b-41d4-a716-446655440000"
Empty
{  "code": "BAD_REQUEST",  "description": "Bad Request"}
{  "code": "UNAUTHORISED",  "description": "Unauthorised"}
{  "code": "FORBIDDEN",  "description": "Forbidden"}
{  "code": "BAD_REQUEST",  "description": "Invalid input"}
{  "code": "RATE_LIMIT_EXCEEDED",  "description": "Too Many Requests"}
{  "code": "INTERNAL_ERROR",  "description": "Internal Server Error"}

Update a payee PATCH

Update the label, the favourite flag, or both, on one of the caller's payees. A field left out of the request is unchanged. Requires an authenticated, active user. Returns 404 when the payee does not exist or does not belong to the caller.

Add a payee account POST

Add a payable account to one of the caller's payees, verified inline against Confirmation of Payee. The required destination fields depend on `type` (`SEND_MONEY`, `POCHI`, `PAY_BILL`, `BUY_GOODS`, or `BANK_ACCOUNT`), and an unlinked destination needs an `account_holder_name`. Returns 404 when the payee does not exist, or 409 when it already has an account for that destination. A partial or no name match, or a provider outage, returns 422 `PAYEE_ACCOUNT_CONFIRMATION_REQUIRED`. Resubmit with `confirm=true` to save the account anyway. Requires an authenticated, active user.