Beneficiaries
Show beneficiary
OAuth scope: organization.read
Get a single beneficiary.
Attributes details
Trusted
trusted indicates whether you can automate transfer through API to the beneficiary or not.
Timestamps
Each beneficiary contains two timestamps:
- created_at, UTC, the time at which the beneficiary was first recorded.
- updated_at, UTC, the time at which the beneficiary was last updated.
Status
status can contain the following values
- pending: Beneficiary is created but no Strong Customer Authentication or Transfer has ever been done on this beneficiary.
- validated: Beneficiary is created and at least one Strong Customer Authentication or Transfer has been done to this beneficiary.
- declined: Beneficiary is malformatted and prevent from Qonto to processing transfer.
Bank account
Fields in the bank_account object will be populated depending upon the type of the account. If the type is:
- Swift BIC or SEPA: iban, currency and bic will be present.
- Swift code: account_number, swift_sort_code, intermediary_bank_bic and currency will be present.
- Swift routing number: account_number, routing_number, intermediary_bank_bic and currency will be present.
get/v2/beneficiaries/{id}
Path parameters
idstring required
Headers
X-Qonto-Staging-Tokenstring
Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.
Response
returns a beneficiary
Example response
{
"beneficiary": {
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"name": "Alice In Wonderland",
"status": "validated",
"created_at": "2021-01-27T22:05:07.000Z",
"updated_at": "2021-01-27T22:05:07.000Z"
}
}