Trusted payees

Get a payee

Returns the trusted payee identified by id, including its recipient and destination details.

A trusted payee is a saved recipient belonging to one identity. Reference it by beneficiaryId when creating a send or outgoing wire transfer. Eligible transactions to a trusted payee can skip Strong Customer Authentication and report TRUSTED_BENEFICIARY as their challenge exemption reason.

get/beneficiaries/{id}

Request

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

Path parameters

idstring required
Example:123456789

The unique identifier of the payee.

Response

Success

trustLevel'TRUSTED' required

The value that determines whether a Beneficiary is trusted or not.

externalRefsstring[]

The id of the entity as it is represented on the caller system.

groupstring

A custom field that can be used to categorize a beneficiary for easier searching and filtering.

idstring required

The unique identifier of a Beneficiary.

state'INITIALISED' | 'INVALID' | 'PENDING_CHALLENGE' | 'CHALLENGE_FAILED' | 'ACTIVE' | 'REMOVED' required
validationFailure'INSTRUMENT_DETAILS_NOT_FOUND' | 'BENEFICIARY_DETAILS_ALREADY_EXIST' | 'BENEFICIARY_BELONGS_TO_SAME_IDENTITY'

Example response

{
  "group": "Suppliers",
  "beneficiaryInformation": {
    "businessName": "Acme Ltd"
  },
  "beneficiaryDetails": {
    "instrument": {
      "id": "123456789",
      "type": "managed_accounts"
    }
  },
  "id": "123456789",
  "relatedOperationBatches": [
    {
      "batchId": "123456789",
      "operation": "CREATE"
    }
  ]
}

Changes

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