Skip to content
Developer Docs

Creditor account details

GET
/business-creditor-account/v1/business-creditor-accounts/{uuid}

Returns the detail of a specific beneficiary account. Lets you validate the IBAN, status and associated configuration.

Includes the masked account number, alias, status and, when applicable, the details of the ASPSP (bank) the IBAN belongs to.

Authorizations

OAuth2

OAuth2 security scheme

clientCredentials Flow
Token URL"/api/v2/auth/token"
Scopes:
  • "zertiban-api"Access to the API

Parameters

Header Parameters

x-tenant-id*

UUID of the consuming business in Zertiban.

Type
string
Required
Format
"uuid"

Path Parameters

uuid*

UUID of the creditor account to retrieve.

Type
string
Required
Format
"uuid"

Responses

Creditor account details

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

Playground

Authorization
Headers
Variables
Key
Value

Samples