Developer Docs

Lista de cuentas de cobro​

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

Lista las cuentas bancarias de la organización habilitadas para recibir pagos. Se usa en la configuración de flujos y la validación de destino.

Lista paginada de las cuentas de cobro (IBAN) registradas para una organización. Sin filtro de estado, el listado devuelve todas las cuentas, incluidas las que están en estado DISABLED. Cada resultado expone el uuid (el creditorAccountUuid) referenciado al crear flujos de pago.

Autorizaciones​

OAuth2

Esquema de seguridad OAuth2

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

Parámetros​

Header Parameters

x-tenant-id

UUID de la organización consumidora en Zertiban.

Tipo
string
Formato
"uuid"

Query Parameters

q_businessUuid*

Filtra cuentas por el UUID de la organización asociada.

Tipo
string
Requerido
Formato
"uuid"
limit*

Número máximo de resultados a devolver.

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

Número de elementos a saltar antes de empezar a recoger el conjunto de resultados.

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

Filtro opcional por estado de la cuenta de cobro. Si se omite, devuelve todos los estados.

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

Filtro opcional por si la cuenta es la predeterminada.

Tipo
boolean

Respuestas​

Lista de cuentas de cobro

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​