PIpismo
Delinquent account closure

Close delinquent account

Sends the specified account to the delinquent account closure process. This endpoint generates a Delinquent account closed event.

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.

post/v1/accounts/{account_id}/close

Request

  • Base URL
    https://sandbox.pismolabs.io/delinquent-account
  • URL
    https://sandbox.pismolabs.io/delinquent-account/v1/accounts/{account_id}/close
  • 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.

Request body

tracking_idstring required

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.

processing_codestring

Processing code for the transaction that the Pismo platform creates to zero out the account balance.

reasonstring

external_id of the status reason. This is the external ID that was used to create the reason.

final_account_statusstring

Final status for the closed delinquent account. Use the List statuses endpoint to list the available account statuses.

excluded_stepsExcludedStep[]

Steps to skip when closing a delinquent account

Example request

{
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
  "processing_code": "008000",
  "reason": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f",
  "final_account_status": "CANCELLED",
  "excluded_steps": [
    "SET_CARD_AS_BLOCKED"
  ]
}

Response

Accepted - Indicates that the server has accepted the request, and the specified account has been sent to the delinquent account closure process.

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

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.

Example response

{
  "open_due_date": "2023-01-01",
  "due_days": 10,
  "created_at": "2023-03-30T12:26:41",
  "status": "CREATED"
}

Changes

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