Skip to content
/
Remove payees

Remove payees

Request

Payees (previously "beneficiaries"). Removes one or more payees from the payees list identified by the id path parameter used in the array.

Security
auth_token and api-key
Headers
idempotency-refstring

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.

Bodyapplication/jsonrequired
beneficiaryIdsArray of strings, non-emptyrequired

A list of Beneficiary Ids.

curl -i -X POST \
  https://sandbox.weavr.io/multi/beneficiaries/remove \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "beneficiaryIds": [
      "string"
    ]
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
operationBatchIdobject(BeneficiaryOperationBatchId)required
tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

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

statestring(BeneficiaryBatchState)required
Enum:"INITIALISED""FAILED""PENDING_CHALLENGE""CHALLENGE_FAILED""CHALLENGE_COMPLETED""COMPLETED"
Response
{
  "operationBatchId": {
    "batchId": "string",
    "operation": "CREATE"
  },
  "tag": "string",
  "state": "INITIALISED"
}