Fetch Beneficiary by Id
Fiat Beneficiaries
Get Fiat Beneficiary
This operation allows the client to fetch a beneficiary by its Id
GET
Fetch Beneficiary by Id
Fetches a single fiat beneficiary by ID.
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.
Path Parameters
The unique ID of a beneficiary
Response
Beneficiary fetched
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Fiat beneficiary object
Beneficiary bank code
Required string length:
3 - 12Beneficiary identifier
Beneficiary account number, for international payments like SEPA, this is the IBAN
Beneficiary account name
Available options:
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