PIpismo
Accounts

List accounts by document number

Search for accounts by document_number. You can also optionally specify program_ID or account_status.

post/accounts/v3/accounts/search

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/accounts/v3/accounts/search
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number.

perPageinteger
Example:100

Items per page.

Request body

document_numberstring required

Document number, such as a government tax ID.

program_idinteger

Program ID

account_statusstring

Account status. The pre-defined account statuses are DEBIT_ONLY, NORMAL, BLOCKED, and CANCELLED. You can create your own account statuses with the Create status endpoint.

Example request

{
  "document_number": "31457828046",
  "program_id": 12345,
  "account_status": "NORMAL"
}

Response

Account returned

account_idinteger

Account ID

customer_idinteger

Customer ID

account_statusstring

Account status. The pre-defined account statuses are DEBIT_ONLY, NORMAL, BLOCKED, and CANCELLED. You can create your own account statuses with the Create status endpoint.

acquisition_idinteger

ID of the application form that originated the account

program_idinteger

Program ID

Example response

[
  {
    "account_id": 1001,
    "customer_id": 100211299,
    "account_status": "NORMAL",
    "acquisition_id": 1234,
    "program_id": 12345
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.