Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
Banks

Retrieve bank

Returns a single bank relationship by its Embat id. Unlike the list endpoint, this always returns the relationship even when it currently has no active products, in which case bankProducts is an empty list.

get/banks/{companyId}/{id}

Path parameters

idstring required
companyIdstring required

Response

Successful Response

idstring required

Embat bank relationship ID.

bankServicestring required

Identifier of the banking connection or aggregation service backing this bank relationship.

bankFullNamestring nullable

Full legal name of the bank.

lastAggregationOKstring date-time nullable

Timestamp of the oldest successful data aggregation among this bank's active products (see bankProducts). null if none of its active products has ever aggregated successfully.

updatedAtstring date-time nullable

Last time this bank relationship was updated in Embat.

createdAtstring date-time nullable

Date this bank relationship was created in Embat.

companyIdstring required

Embat company ID. You can get them from "companies" endpoints.

additionalInfoobject

Free-form key/value metadata attached to the bank relationship.

Example response

{
  "id": "bank_5f2c1a",
  "bankService": "bbva",
  "bankFullName": "Banco Bilbao Vizcaya Argentaria",
  "lastAggregationOK": "2024-01-15T08:30:00Z",
  "bankProducts": [
    {
      "id": "prod_8f3a1c",
      "product": "Cuenta Corriente",
      "alias": "Main checking account",
      "type": "checking",
      "balance": 15234.67,
      "lastAggregationOK": "2024-01-15T08:30:00Z",
      "accountNumber": "ES9121000418450200051332"
    }
  ]
}