Reference accounts

Index reference accounts for a business

Returns an array containing all reference accounts associated with the business account specified in the request URL.

get/v1/businesses/{business_id}/accounts/{account_id}/reference_accounts

Path parameters

business_idstring required

account_idstring required

Query parameters

page[number]integer

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[iban]string

Filter the results by IBAN.

filter[status]'ACTIVE' | 'INACTIVE'

Filter the results by account status.

Response

The operation was successful.

idstring

Unique ID of the reference account.

statusstring

Current status of the reference account.

namestring

The reference account holder's name.

ibanstring

The reference account's IBAN.

mandate_numberstring

The number of the SDD mandate associated with the reference account.

mandate_signature_datestring date

The date when the customer signed the SDD mandate.

mandate_type'B2B' | 'Core'

The type of SDD mandate.

Example response

[
  {
    "id": "ee4cc80bee604de09d036d8b7a9b6cb0",
    "status": "ACTIVE",
    "name": "Max Mustermann",
    "iban": "DE32110101001000000029",
    "mandate_number": "example-mandate-number",
    "mandate_signature_date": "2020-01-08",
    "mandate_type": "Core"
  }
]