Create Fiat Beneficiary
This Operation allows user to save beneficiary
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
create beneficiary for customer
Beneficiary bank code
3 - 12Beneficiary account number, for international payments like SEPA, this is the IBAN, and for Mobile Money, this is the phone number.
Beneficiary account name
Discriminator value for beneficiary type. Possible values are:
- CreateLocalBankAccountBeneficiary: Local bank transfer beneficiary, maps to BeneficiaryLocalBankAccount
- CreateSepaBankAccountBeneficiary: SEPA instant and standard transfer beneficiary. Use this for beneficiaries that will receive SEPA payments. Maps to BeneficiarySepaBankAccount
- CreateACHBankAccountBeneficiary: ACH, FedWire and FedNow transfer beneficiary. Maps to BeneficiaryACHBankAccount
- CreateSwiftBankAccountBeneficiary: SWIFT transfer beneficiary. Maps to BeneficiarySwiftBankAccount
- CreateMobileWalletAccountBeneficiary: Use this for beneficiaries that will receive mobile wallet payments. Maps to BeneficiaryMobileWalletAccount.
^Create(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet)AccountBeneficiary$INDIVIDUAL, BUSINESS To get the payment channels available, call the /currencies endpoint. The payment channel ID to be used for transfer to this beneficiary. The payment channel ID and the beneficiaryType are mutually exclusive. For example BANK_TRANSFER_NIGERIA uses CreateLocalBankAccountBeneficiary
Beneficiary bank name
Flag to indicate if the beneficiary is a third party
Response
Beneficiary details saved successfully
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Fiat beneficiary object
Beneficiary bank code
3 - 12Beneficiary identifier
Beneficiary account number, for international payments like SEPA, this is the IBAN
Beneficiary account name
INDIVIDUAL, BUSINESS Beneficiary bank name
Discriminator value for beneficiary type. Allowed values include:
- BeneficiaryLocalBankAccount
- BeneficiarySepaBankAccount
- BeneficiaryACHBankAccount
- BeneficiarySwiftBankAccount
- BeneficiaryMobileWalletAccount
Flag to indicate if the beneficiary is a third party