Trusted payees

Remove payees

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.

post/beneficiaries/remove

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/beneficiaries/remove
  • Auth: HTTP bearer and API key in header api-key

Headers

idempotency-refstring
Example:transfer-2026-08-07-001

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Request body

beneficiaryIdsstring[] required

A list of Beneficiary Ids.

Response

Success

tagstring

The tag field is a custom field that can be used to search and filter.

state'INITIALISED' | 'FAILED' | 'PENDING_CHALLENGE' | 'CHALLENGE_FAILED' | 'CHALLENGE_COMPLETED' | 'COMPLETED' required

Example response

{
  "operationBatchId": {
    "batchId": "123456789",
    "operation": "CREATE"
  },
  "tag": "customer-123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.