DELETE
Delete a beneficiary
Removes a payee.
You can’t delete a beneficiary that a scheduled payment still uses. Cancel the scheduled payment first.

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. 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"