DELETE
Delete a beneficiary
Removes a payee. The delete is soft: the payee drops out of the list, getting it answers 422 BENEFICIARY_DELETED, and a payment to it is refused with BENEFICIARY_DELETED. Deleting a payee that’s already deleted succeeds with 200. No confirmation is needed, and no email is sent.
You can’t delete a beneficiary that a pending payment (single or batch) or a scheduled payment still uses — the request returns 422 with PENDING_SCHEDULED_BATCH_PAYMENTS_EXIST. Let the pending payments complete, or cancel them, first.

Authorizations

Authorization
string
header
required

The user's access_token from authentication. The program and environment come from the token.

Path Parameters

customerId
string
required

The customer's id. It's the customerId from the signed-in user's application (the onboarding response, also returned on the customer's accounts).

beneficiaryId
string
required

The beneficiary's id, returned when you create a beneficiary or list them.

Response

Done

success
boolean
Example:

true

message
string
Example:

"Beneficiary deleted successfully"

data
null

Always null: the top-level message is the whole result.

Example:

null