GET
/
v2
/
beneficiaries
curl --request GET \
  --url https://thirdparty.qonto.com/v2/beneficiaries \
  --header 'Authorization: Bearer <token>'
{
  "beneficiaries": [
    {
      "id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
      "name": "Alice In Wonderland",
      "status": "validated",
      "trusted": true,
      "bank_account": {
        "iban": "<string>",
        "bic": "<string>",
        "currency": "<string>",
        "account_number": "<string>",
        "routing_number": "<string>",
        "intermediary_bank_bic": "<string>",
        "swift_sort_code": "<string>"
      },
      "created_at": "2021-01-27T22:05:07.000Z",
      "updated_at": "2021-01-27T22:05:07.000Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": "<any>",
    "prev_page": "<any>",
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

​
X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Query Parameters

​
trusted
boolean

Beneficiaries can be filtered by their trusted field.

​
status[]
enum<string>[]

Beneficiaries can be filtered by their status. This filter accepts an array of statuses.

Available options:
pending,
validated,
declined
Example:

"status[]=pending&status[]=validated&status[]=declined"

​
iban[]
string[]

Beneficiaries can be filtered by their iban. This filter accepts an array of IBANs as value.

​
updated_at_from
string

Beneficiaries can be filtered by their updated_at property. This filter can be used in combination with the updated_at_to query parameter to get beneficiaries updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2019-01-10T11:47:53.123Z"

​
updated_at_to
string

Beneficiaries can be filtered by their updated_at property. This filter can be used in combination with the updated_at_from query parameter to get beneficiaries updated within a specific timeframe. Please use a valid date time format (ISO 8601 for instance).

Example:

"2019-01-10T11:47:53.123Z"

​
sort_by
enum<string>
default:updated_at:desc

Beneficiaries can be sorted by their updated_at property in 2 possible orders: asc (Ascending) / desc (Descending).

Available options:
updated_at:desc,
updated_at:asc
​
page
string

Returned page (cf. Pagination).

​
per_page
string

Number of beneficiaries per page (cf. Pagination).

Response

200
application/json
Returns the list of beneficiaries for the authenticated organization.

The response is of type object.