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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Account ID

Body Params
string
required
length between 1 and 128

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.

string

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

string
length between 1 and 60

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

string

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

excluded_steps
array of objects

Steps to skip when closing a delinquent account

excluded_steps
Headers
string

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.

Responses

400

Bad Request

409

The specified resource status conflicts with the current request.

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json