PIpismo
Delinquent account closure

Get delinquent account closure process information

Get a delinquent account closure entity that was accepted in the process.

NOTE: This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

get/v1/accounts/{account_id}

Request

  • Base URL
    https://sandbox.pismolabs.io/delinquent-account
  • URL
    https://sandbox.pismolabs.io/delinquent-account/v1/accounts/{account_id}
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Account ID

Headers

x-cidstring

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

Response

Ok - Indicates that the delinquent account process for the given account was found and returned.

delinquent_account_closure_idinteger

ID for the delinquent account closure

tracking_idstring

Tracking identifier. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128. If a client clicks the button more than once when sending the command to close an account, the Pismo platform could create duplicate requests. The tracking identifier enables the platform to identify duplicates and ignore them.

open_due_datestring

Open due date. This is the first day that the account became overdue. BRT (Brazilian time zone = UTC-03).

due_daysinteger

Due days. The number of days the account has been overdue. (Today minus open_due_date).

created_atstring

Date/time (UTC) that asset was registered on Pismo platform

updated_atstring

Date closure was updated. BRT (Brazilian time zone = UTC-03).

status'CREATED' | 'STARTED' | 'INTEREST_ACCRUAL_POSTED' | 'INSTALLMENTS_ADVANCED' | 'CREDIT_SEPARATED_TRANSACTION_REQUEST' | 'CREDIT_SEPARATED_TRANSACTION_CREATED' | 'CREDIT_TRANSACTION_REQUESTED' | 'ACCOUNT_CANCELLED' | 'CARD_BLOCKED' | 'SUCCESS' | 'SUCCESS_EVENT_SENT'

Delinquent account entity status

This field can have the following values. CREATED—Created a delinquent account register to initiate the process. STARTED—Started posting interest accruals. INTEREST_ACCRUAL_POSTED—Finished posting nterest accruals. INSTALLMENT_ADVANCED—Checked all transactions that need to be deducted separately. CREDIT_SEPARATED_TRANSACTION_REQUEST—Requested a deduction for each transaction selected to be settled separately. CREDIT_SEPARATED_TRANSACTION_CREATED—Created deduction transactions. CREDIT_TRANSACTION_REQUESTED—Posted a credit transaction to the account. ACCOUNT_CANCELLED—Cancelled account. CARD_BLOCKED—Requested that all cards be blocked. SUCCESS—Blocked all cards. Generated account delinquent closure event. SUCCESS_EVENT_SENT—Sent SUCCESS event to customer.

installment_advance_idinteger

Installment advance ID. If the account has any future installments, they need to be advanced to the current cycle before the account can be closed. installment-advance-id is the ID of the debit transaction that is used to advance those installments.

authorization_idinteger

Before the Pismo platform can close an account, the account's balance must be zero. If that is not the case, the platform creates a debit transaction for the non-zero amount. authorization_id is the authorization ID for this transaction.

Example response

{
  "delinquent_account_closure_id": 1,
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
  "open_due_date": "2023-01-01",
  "due_days": 10,
  "created_at": "2023-03-30T12:26:41",
  "updated_at": "2022-02-01",
  "status": "CREATED",
  "installment_advance_id": 1,
  "authorization_id": 1,
  "cards": [
    {
      "id": 1,
      "status": "NORMAL",
      "type": "PLASTIC"
    }
  ]
}

Changes

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