Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Account

Retrieve

Recovers the account resource by its id

get/accounts/{id}

Path parameters

idstring required

Account primary identifier

Response

Retrieve an account.

idstring required

Primary account identifier

type'BANK' | 'CREDIT' required

Top-level account category.

  • BANK: deposit accounts (checking, savings). The bankData object is populated.
  • CREDIT: credit-card accounts. The creditData object is populated.
subtype'SAVINGS_ACCOUNT' | 'CHECKING_ACCOUNT' | 'CREDIT_CARD' required

Account subtype within its type.

  • CHECKING_ACCOUNT: conta corrente (type=BANK).
  • SAVINGS_ACCOUNT: conta poupança (type=BANK).
  • CREDIT_CARD: credit card account (type=CREDIT). For these the number field is masked to the last 4 digits.
numberstring required

External identifier of the account

namestring required

Name of the account in a descriptive format

marketingNamestring

Name of the account as defined externally

balancenumber double required

Funds of the account

itemIdstring uuid required

Attached item's primary identifier

taxNumberstring

Tax ID of the corresponding owner

ownerstring

Name of the owner of the account

currencyCodestring required

Code referencing the currency of the balance

createdAtstring date-time required

Date when the account was first created in Pluggy

updatedAtstring date-time required

Date of the last update of the account data

Example response

{
  "id": "a658c848-e475-457b-8565-d1fffba127c4",
  "type": "BANK",
  "subtype": "SAVINGS_ACCOUNT",
  "number": "40114687/1234",
  "name": "Conta Corrente",
  "marketingName": "SIGNATURE CJA. AHORRO PESOS",
  "balance": 120950,
  "itemId": "a0922d6f-2007-4169-a181-b961500608db",
  "taxNumber": "416.799.495-00",
  "owner": "John Doe",
  "currencyCode": "BRL",
  "createdAt": "2024-01-15T13:21:08.456Z",
  "updatedAt": "2024-07-22T18:05:11.328Z"
}