Trusted payees

Get a batch of payees

Returns the trusted payee batch identified by id, including the requested payee changes, operation type, and current state.

Use the state to determine whether the batch needs a Strong Customer Authentication challenge or has been executed.

get/beneficiaries/batch/{id}

Request

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

Path parameters

idstring required
Example:123456789

The unique identifier of the payee batch.

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.