Sign in

v1

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

Get account

Get a summary of registration information related to a specific account, as well as some financial data such as its current balance.

Notes

  • Some of the fields returned vary depending on whether the account was created with a person or company object as the account owner. The entity_type (INDIVIDUAL, COMPANY) identifies this.

  • The fields name, email_address, customer_id and document_number are either person or company-related.

  • The field social_name is only specific to a person.

get/accounts/v1/accounts/{accountId}

Path parameters

accountIdinteger required
Example:6912345

Account ID

Query parameters

show_childrenboolean
Example:true

If true, the response lists up to 3 levels of descendant account numbers (children, grandchildren, and great-grandchildren) in the children array. Default is false.

Refer to the Related accounts guide section for information about the parent and child relationship between Pismo platform accounts.

Response

OK

account_idinteger required

Account ID

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

creation_datestring date required

Date of account creation in ISO 8601 format (yyyy-mm-dd).

is_centralizerboolean

Is this a centralizer account? A centralizer account, within the account hierarchy, is the account responsible for invoice billing. Defaults to false.

external_idstring required

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

division_idstring uuid

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

customer_idinteger required

Pismo customer ID.

parent_account_idinteger required

Parent account ID. If provided, the account is the child of the account referenced by parent_account_id. The account referenced by parent_account_id can be in another program or division.

childreninteger[]

List of child account IDs

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

Account status

status_reason_idinteger required

ID of the reason why the account is in its current status. You can create reasons with the Create status reason endpoint.

status_reason_descriptionstring required

Description of why the account is in its current status

account_status_datestring date-time required

Account status date. Format = yyyy-mm-dd:hr:mm:ss.

program_namestring required

Program name

program_type'CREDITO' | 'DEBITO' | 'PRE-PAGO' | 'MERCHANT' | 'CREDITO ZERO-BALANCE' | 'PRE-PAGO ZERO BALANCE' | 'DEBITO ZERO-BALAMCE' | 'CURRENT ACCOUNTS' | 'INTERNAL ACCOUNTS' | 'CORRESPONDENT ACCOUNTS' required

Program type:

  • CREDITO — Full balance credit accounts
  • PRE-PAGO — Full balance prepaid accounts
  • DEBITO — Full balance debit accounts
  • MERCHANT — Merchant accounts
  • CREDITO ZERO-BALANCE — Zero balance credit accounts
  • PRE-PAGO ZERO-BALANCE — Zero balance prepaid accounts
  • DEBITO ZERO-BALANCE — Zero balance debit accounts
  • CURRENT ACCOUNTS — Current accounts
  • INTERNAL ACCOUNTS — Internal accounts
  • CORRESPONDENT ACCOUNTS — Correspondent accounts

For more information, refer to the Program types guide.

program_idnumber required

Pismo program ID.

orgstring required

Organization ID

entity_type'INDIVIDUAL' | 'COMPANY' required

Entity type

namestring required

Name

social_namestring required

Social name.

emailstring email required

Email address.

document_numberstring required

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.

postal_address_typeinteger required

ID of the mailing address registered for this account.

acquisition_idinteger required

ID of the application form that originated the account

currency_numeric_codestring

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

collections_status'NORMAL' | 'OVERDUE' required

Account's financial status for credit programs

open_due_datestring date required

Due date of currently open statement. Format = yyyy-mm-dd.

current_cicleinteger required

Current statement cycle

current_balancenumber float required

Current balance

available_withdrawal_creditnumber float required

Amount available for withdrawal in credit programs

available_monthly_creditnumber float required

Monthly amount available in credit programs

available_total_installment_creditnumber float required

Amount available for installments in credit programs

withdrawal_credit_limitnumber float required

Amount limit for withdrawal in credit programs

monthly_credit_limitnumber float required

Monthly credit limit for credit programs

total_installment_credit_limitnumber float required

Amount limit for installments in credit programs

total_credit_limitnumber float required

User-set total credit limit. This can be any value up to max_credit_limit.

max_credit_limitnumber float required

Maximum credit amount approved for this account

available_limitinteger required

Total available limit to spend, calculated by: max_limit - current_spend_limit. The current_spend_limit, an internal field, is the total amount of all approved transactions in the limit_duration period. It is reset by the evaluation flow when a new transaction is evaluated in the new period according to the reset_datetime.

When available_limit is set in a PATCH request, it resets current_spend_limit. In this case, available_limit cannot be greater than max_limit. Note that available_limit is an integer. Since global currencies vary in the number of digits that are allowed after the decimal point, you must convert the actual maximum spending limit into an integer value to use in this field. To do this, use the following formula:

value = floatNumber * 10^x, where x is the number of digits for the currency as defined in ISO 4217.

For example, if you want to set the value 499.99 for BRL currency transactions, you must set 49999 = 499.99 * 10^2.

On the other hand, the Japanese money system does't use fractions of a yen (the Japanese currency). So, to set the value at 4999 yen, you must set 4999 = 4999.0 * 10^0 = 4999.0 * 1. (In other words, the value doesn't change.)

blocked_amountnumber float required

Amount blocked in this account

exchange_mode'SAME_DAY' | 'CLOSING' required

When a foreign transaction is charged the exchange rate:

  • SAME_DAY - Day the transaction occurred
  • CLOSING - Statement's closing date

This field is valid for credit programs only.

program_due_date_idinteger required

ID of Program due date

custom_fieldsstring required

Key/value field for custom information. (Limited to 1014 bytes.)

Example response

{
  "account_id": 6912345,
  "account_type": "TRAN",
  "account_name": "Account cash management",
  "creation_date": "2021-10-21",
  "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f",
  "division_id": "6f8a456a-8b1a-4022-a2f8-7612595330b5",
  "customer_id": 5648988,
  "parent_account_id": 232,
  "children": [
    102778
  ],
  "status": "NORMAL",
  "status_reason_id": 123,
  "status_reason_description": "Registration restriction",
  "account_status_date": "2021-10-21T18:41:26.000Z",
  "program_name": "Digital wallet program",
  "program_type": "DEBITO",
  "program_id": 1010,
  "org": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be",
  "entity_type": "INDIVIDUAL",
  "name": "Hyman Roth",
  "social_name": "Jack",
  "email": "jenna.flect@email.com",
  "document_number": "7777888hh",
  "postal_address_type": 1,
  "acquisition_id": 1234,
  "currency_numeric_code": "840",
  "collections_status": "NORMAL",
  "open_due_date": "2022-07-03",
  "current_cicle": 3,
  "current_balance": 100.43,
  "available_withdrawal_credit": 100.43,
  "available_monthly_credit": 100.43,
  "available_total_installment_credit": 100.43,
  "withdrawal_credit_limit": 100.43,
  "monthly_credit_limit": 100.43,
  "total_installment_credit_limit": 100.43,
  "total_credit_limit": 100.43,
  "max_credit_limit": 100.43,
  "available_limit": 300,
  "blocked_amount": 100.43,
  "exchange_mode": "SAME_DAY",
  "program_due_date_id": 1234,
  "custom_fields": "{\"field_01\": \"value01\", \"field_02\": \"value02\" }"
}