Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Accounts

Get account hierarchy ascendants

Get account hierarchy information including all parent/ancestor accounts.

This endpoint returns the account details along with an array of all parent accounts in the hierarchy, with each parent containing information about its level, centralizer status, and relationship to other accounts in the hierarchy.

get/accounts/v4/accounts/{accountId}/hierarchy/ascendants

Path parameters

accountIdinteger required
Example:6912345

Account ID

Response

OK

account_idinteger

Account ID

namestring

Name

document_numberstring

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

customer_idinteger

Pismo customer ID.

social_namestring

Social name.

entity_idinteger

Entity ID

program_idnumber

Pismo program ID.

status'NORMAL' | 'BLOCKED' | 'CANCELLED'

Account status

postal_address_idinteger

Postal address ID

creation_datetimestring date-time

Datetime the account was created in the Pismo system (in UTC). The datetime format follows the ISO 8601 standard: yyyy-mm-ddThh:mm:ss.sssZ.<br> Note that milliseconds are represented as 000, for example: 2024-02-22T16:51:49.000Z.<br> This field accepts datetime values from the present or past. Future dates are not allowed.<br> minLength: 24 maxLength: 24

external_idstring

Client-created ID from an external system or application. REQUIRED for VIRTUAL accounts.

account_type'CACC' | 'SLRY' | 'SVGS' | 'TRAN'

Account type: <br /> CACC - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking.<br /> SVGS - Savings account<br /> TRAN - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.<br /> SLRY - Salary account. Employer deposits a fixed amount every month.<br />

account_namestring

Custom account's name

division_idstring uuid

Pismo generates the division ID when you use the Create division endpoint.

currency_numeric_codestring

Numeric code (ISO 4217) for the currency used by the program.<br> minLength: 3 maxLength: 3

Example response

{
  "account_id": 6912345,
  "name": "Hyman Roth",
  "document_number": "7777888hh",
  "customer_id": 5648988,
  "social_name": "Jack",
  "entity_id": 1234567891,
  "program_id": 1010,
  "status": "NORMAL",
  "postal_address_id": 456,
  "creation_datetime": "2024-01-04T10:25:30.123Z",
  "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f",
  "account_type": "TRAN",
  "account_name": "Account cash management",
  "division_id": "6f8a456a-8b1a-4022-a2f8-7612595330b5",
  "currency_numeric_code": "840",
  "parents": [
    {
      "account_id": 6912345,
      "level": 1,
      "parent_account_id": 6912345,
      "currency_numeric_code": "840",
      "program_id": 1010,
      "division_id": "6f8a456a-8b1a-4022-a2f8-7612595330b5"
    }
  ]
}