Beneficiaries

Get beneficiary form schema

Changed on

Returns the form schema containing all fields required to create a beneficiary for the given country, currency, entity type, and transfer method combination. Use this to dynamically render the beneficiary creation form.

get/beneficiaries/schema

Request

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

Query parameters

bankCountryCodestring required

Two-letter ISO 3166-1 alpha-2 country code for the bank location

Example:AU
accountCurrency'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL' required

Three-letter ISO 4217 currency code for the beneficiary account

Example:AUD
entityType'PERSONAL' | 'COMPANY' required

Whether the beneficiary is an individual or a company

Example:COMPANY
transferMethod'LOCAL' | 'SWIFT'

Transfer method: SWIFT for international wire transfers, LOCAL for domestic transfers

Example:LOCAL
localClearingSystemstring

Local clearing system for domestic transfers (e.g., NPP, BANK_TRANSFER, BPAY for Australia). Only applicable when transferMethod is LOCAL.

Example:NPP
fieldValuesobject

Current values of fields with refresh=true. Used to get dynamic schema updates based on user selections.

{
  "beneficiary.bank_details.account_routing_type1": "phone_number"
}

Response

OK

unavailableReason'UNSUPPORTED_COMBINATION'

When present, the selected country, currency, recipient type or transfer options are unsupported and fields is empty.

selectedTransferMethod'LOCAL' | 'SWIFT'

The transfer method used to generate this schema. When not provided in the request, LOCAL is auto-selected if available.

selectedLocalClearingSystemstring

The local clearing system used to generate this schema, if applicable.

Example response

{
  "fields": [
    {
      "path": "beneficiary.bank_details.account_number",
      "enabled": true,
      "required": true,
      "field": {
        "type": "INPUT",
        "options": [
          {
            "flightTime": {
              "unit": "day"
            }
          }
        ]
      }
    }
  ],
  "selectedTransferMethod": "LOCAL",
  "selectedLocalClearingSystem": "NPP"
}

Changes