v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Products

Retrieve product

Returns a single product by its Embat id.

get/products/{companyId}/{id}

Path parameters

idstring required

companyIdstring required

Response

Successful Response

idstring required

Embat product ID.

bankIdstring required

Embat ID of the bank relationship this product belongs to. You can get them from "banks" endpoints.

companyIdstring required

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

accountingCodestring nullable

Accounting account code this product is posted to, if it has been reconciled with one.

balancenumber nullable

Current balance of the product, in its own currency.

balanceCreditGrantednumber nullable

Total credit limit granted on the product (e.g. for lines of credit).

countableBalancenumber nullable

Balance used for reporting purposes. Defaults to balance when the bank does not report a countable balance, or reports it as zero.

arrangedBalancenumber nullable

Arranged balance of the product (e.g. amount drawn against a credit line), as reported by the bank.

updatedAtstring date-time nullable

Last time this product was updated in Embat.

createdAtstring date-time nullable

Date this product was created in Embat.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTC' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'ERN' | 'ETB' | 'ETH' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTC' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWG' | 'ZWL' required

productstring required

Product name as reported by the bank.

ibanstring nullable

IBAN or account number identifying the product.

typestring required

Product type reported by the bank, e.g. checking, savings, card, loan, lineofcredit or wallet.

aliasstring nullable

Custom alias given to the product in Embat, if any.

descriptionstring nullable

Description of the product as reported by the bank.

notesstring nullable

Notes attached to the product in Embat. Falls back to description when not set.

bankstring required

Identifier of the bank providing this product.

bankFullNamestring nullable

Full legal name of the bank this product belongs to, if known.

additionalInfoobject nullable

Free-form key/value metadata attached to the product.

hasTransactionsboolean nullable

Whether the product supports bank transactions. Always recomputed by Embat: true for checking, lineofcredit, card and wallet products, false otherwise.

manualboolean

Whether the product was added manually, rather than aggregated from a bank connection.

tagsstring[] nullable

Custom tags assigned to the product in Embat.

financialDetailsobject nullable

Additional financial detail attributes reported for the product.

Example response

{
  "id": "prod_8f3a1c",
  "accountingCode": "5720001",
  "balance": 15234.67,
  "balanceCreditGranted": 50000,
  "countableBalance": 15234.67,
  "arrangedBalance": 10000,
  "product": "Cuenta Corriente",
  "iban": "ES9121000418450200051332",
  "type": "checking",
  "alias": "Main checking account",
  "bank": "bbva",
  "bankFullName": "Banco Bilbao Vizcaya Argentaria",
  "reconciliation": {
    "accountingCode": "5720001",
    "originalBalanceDate": "2024-01-01T00:00:00Z"
  }
}