Skip to content
/
Add payees

Add payees

Request

Payees (previously "beneficiaries"). Create one or more payees for the logged-in corporate or consumer identity.

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
tagstring, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

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

beneficiariesArray of objects(BasicBeneficiary)required

The object representing the beneficiaries' details.

curl -i -X POST \
  https://sandbox.weavr.io/multi/beneficiaries \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "tag": "string",
    "beneficiaries": [
      {
        "trustLevel": "TRUSTED",
        "externalRefs": [
          "string"
        ],
        "group": "string",
        "beneficiaryInformation": {
          "businessName": "string"
        },
        "beneficiaryDetails": {
          "instrument": {
            "id": "string",
            "type": "managed_cards"
          }
        }
      }
    ]
  }'

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"
}