Remove payees
POST
/beneficiaries/remove Creates a batch operation to remove one or more trusted payees from the logged-in identity's list.
Removal follows the same two-step pattern as
adding payees: the batch is created in
PENDING_CHALLENGE and is only applied once the logged-in user completes a Strong Customer
Authentication challenge. Issue the challenge with
one-time password or
push notification, then confirm it with
Verify a payee batch.
Removed payees move to the REMOVED state and can no longer be used as a destination. Transactions
already made to them are unaffected.
Request
Available on
SandboxProduction
Header parameters
Request body
*application/json
objectobject · 1 field
Responses
200OK
Success
Headers
Body
application/json
BeneficiaryBatchBeneficiaryBatch · object · 3 fields
Response example
{ "operationBatchId": { "batchId": "123456789", "operation": "CREATE" }, "tag": "customer-123", "state": "INITIALISED"}