Save beneficiary
create_beneficiarySave a recipient and bank account for a currency and network so later transfers can pay it by ID. Validates bank details exactly as a transfer and refreshes or revives existing saved accounts.
Instructions
Save a recipient and their bank account for a currency and network, so later transfers can pay it by id. The details are validated exactly as a transfer on that network would be. Saving an account that is already saved returns the existing beneficiary with its details refreshed, and revives it if archived.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iban | No | IBAN (EU/international) | |
| cnaps | No | CNAPS (China) | |
| label | No | Display name (e.g. 'Acme Supplies (EUR)'). Defaults to the account holder name | |
| payId | No | PayID alias (AUD only). Requires payIdType | |
| bicCode | No | BIC (EUR/GBP international) | |
| bsbCode | No | BSB code (Australia) | |
| network | Yes | Network the beneficiary is paid by: bank = local transfer, swift = international wire | |
| bankCode | No | Bank code / institution number (CAD) | |
| bankName | No | Name of the destination bank | |
| ifscCode | No | IFSC code (India) | |
| sortCode | No | Sort code (UK) | |
| payIdType | No | PayID alias type. Required when payId is given | |
| swiftCode | No | SWIFT code | |
| branchCode | No | Branch code / transit number (CAD) | |
| accountType | No | Account type. Required for CAD and USD bank payouts | |
| addressCity | No | Beneficiary city | |
| bankCountry | No | Bank country, ISO 2-letter (e.g. 'AU', 'US') | |
| dateOfBirth | No | Beneficiary date of birth, YYYY-MM-DD. Required when recipientType is individual for AED, CAD, EUR, GBP, MXN, USD | |
| addressState | No | Beneficiary state or region | |
| bankCurrency | No | Payout currency, ISO 3-letter (e.g. 'EUR') | |
| accountNumber | No | Bank account number, if not using IBAN | |
| addressStreet | No | Beneficiary street address | |
| recipientType | No | Beneficiary type. Required for AED, CAD, EUR, GBP, MXN, USD | |
| routingNumber | No | ABA routing number (US) | |
| addressCountry | No | Beneficiary country, ISO 2-letter. The complete address is required for AED, CAD, EUR, GBP, MXN, USD | |
| accountHolderName | No | Account holder's full name, or the company name when recipientType is business | |
| addressPostalCode | No | Beneficiary postal code |