Developer Docs

Creditor account list​

GET
/business-creditor-account/v1/business-creditor-accounts

Lists the organisation's bank accounts enabled to receive payments. Used in flow configuration and destination validation.

Paginated list of the beneficiary accounts (IBANs) registered for an organisation. With no status filter, the listing returns all accounts including those in DISABLED status. Each result exposes the uuid (the creditorAccountUuid) referenced when creating payment flows.

Autorizaciones​

OAuth2

OAuth2 security scheme

clientCredentials Flow
URL del token"/idp/oauth2/token"
Ámbitos:
  • "api"Access to the API

Parámetros​

Header Parameters

x-tenant-id

UUID of the consuming organisation in Zertiban.

Tipo
string
Formato
"uuid"

Query Parameters

q_businessUuid*

Filter accounts by the UUID of the associated organisation.

Tipo
string
Requerido
Formato
"uuid"
limit*

Maximum number of results to return.

Tipo
integer
Requerido
Ejemplo10
Mínimo
1
Máximo
100
Por defecto
10
offset*

Number of items to skip before starting to collect the result set.

Tipo
integer
Requerido
Ejemplo0
Mínimo
0
Por defecto
0
q_status

Optional filter by creditor account status. When omitted, returns all statuses.

Tipo
string
Valores válidos
"ACTIVE""DISABLED"
q_isDefault

Optional filter by whether the account is the default.

Tipo
boolean

Respuestas​

List of creditor accounts

application/json
JSON
{
  
"results": [
  
  
{
  
  
  
"uuid": "c32de618-28cd-4799-9f5e-8e85ea7d645c",
  
  
  
"accountNumber": "ES700487************9679",
  
  
  
"type": "IBAN",
  
  
  
"alias": "My bank account",
  
  
  
"status": "ACTIVE",
  
  
  
"isDefault": false,
  
  
  
"aspsp": {
  
  
  
  
"uuid": "ef10759a-4fc7-4268-b7eb-35a2c13affdb",
  
  
  
  
"commercialName": "Caixabank",
  
  
  
  
"icon": "data:image/png;base64,iVBORw0KG...SuQmCC"
  
  
  
}
  
  
}
  
],
  
"total": 0
}

Playground​

Servidor
Autorización
Headers
Variables
Key
Value

Ejemplos​