Beneficiaries

Validate beneficiary request

Changed on

Validates a beneficiary request against Airwallex rules without creating the beneficiary. Use this to provide real-time validation feedback before submission.

post/beneficiaries/validate

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/beneficiaries/validate
  • Auth: API key in header x-tenant-id

Request body

transfer_methodsstring[] required

Transfer methods supported for this beneficiary

Example request

{
  "transfer_methods": [
    "LOCAL"
  ],
  "beneficiary": {
    "entity_type": "COMPANY"
  }
}

Response

OK

validboolean required

Whether the beneficiary request passed all validation rules

Example response

{
  "valid": true,
  "errors": [
    {
      "source": "beneficiary.bank_details.account_number",
      "code": "001",
      "message": "This field is required"
    }
  ]
}

Changes