Beneficiaries

Create a new beneficiary

Changed on
post/beneficiaries

Request

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

Request body

namestring required

The account name for this beneficiary.

gateway'AIRWALLEX' | 'STRIPE' required

The payment gateway used for processing payouts.

gatewayIdstring required

The identifier assigned by the payment gateway to this account.

teamIdstring required

Team that owns this beneficiary account.

teamIdsstring[]

List of team IDs to assign this beneficiary to. Empty array or omitted means available to all teams.

venueIdsstring[]

List of venue IDs to assign this beneficiary to. Empty array or omitted means team-level only.

currency'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 payouts to this beneficiary account

Example request

{
  "name": "My Bank Account",
  "gateway": "STRIPE",
  "gatewayId": "7489cb17-24c5-4acf-a0cf-d93ed38081fe",
  "teamIds": [],
  "venueIds": [],
  "currency": "AUD",
  "airwallex": {
    "transfer_methods": [
      "LOCAL"
    ],
    "beneficiary": {
      "additional_info": {
        "personal_email": "test@session.services"
      },
      "address": {
        "city": "Sydney",
        "country_code": "AU",
        "postcode": "2000",
        "state": "AU-NSW",
        "street_address": "123 George Street"
      },
      "bank_details": {
        "account_currency": "AUD",
        "account_name": "John Doe",
        "account_number": "999994",
        "account_routing_type1": "bsb",
        "account_routing_value1": "062004",
        "bank_country_code": "AU",
        "local_clearing_system": "BANK_TRANSFER"
      },
      "entity_type": "PERSONAL",
      "company_name": "Doe Enterprises Pty Ltd",
      "first_name": "John",
      "last_name": "Doe"
    }
  }
}

Response

OK

Example response

{
  "beneficiary": {
    "id": "ben_01jps5cgse5n6mg1ymkew9tsfh",
    "createdAt": "2026-10-17T08:46:46.697Z",
    "updatedAt": "2026-10-17T08:46:46.697Z",
    "name": "My Bank Account",
    "currency": "AUD",
    "gateway": "STRIPE",
    "gatewayId": "7489cb17-24c5-4acf-a0cf-d93ed38081fe",
    "teamIds": [],
    "venueIds": []
  }
}

Changes

  • 84f157e4443aRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the non-success response with the status

    • info

      the response property / became required for the status

    • info

      added the required property // to the response with the status