Trusted payees

List payee batches

Returns the logged-in identity's payee batches, filtered by state, operation, or tag. Payees were previously called beneficiaries, which is why the paths and field names still say beneficiary.

get/beneficiaries/batch

Request

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

Query parameters

offsetinteger

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger
Example:25

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

stateBeneficiaryBatchState[]

Filter by one or more payee batch states.

operationBeneficiaryBatchOperation[]

Filter by one or more operations performed by the payee batch.

tagstring[]

Filter by the payee batch tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

Response

Success

countinteger

The total number of records (excluding the paging limit).

responseCountinteger

The total number of records returned in this response (always capped at 100).

Example response

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

Changes

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