Account

Update account collection status

Change an account's collection status from NORMAL to OVERDUE or vice-versa. OVERDUE accounts cannot do cash-outs (purchases, cash withdrawals, and so on).

When you try to change an account's collection status to OVERDUE, the Pismo platform first verifies that OpenDueDate is not NULL and that it is a date in the past. If this test fails, it returns 400 Bad request.

No validations are done when you change the collection status to NORMAL.

Changing the account collection status does not affect the account status. So, for example, changing the account collection status from NORMAL to OVERDUE does not cause the account status to change to BLOCKED, even though it does prevent cash-outs by blocking the ledger itself. When you change the account collection status from OVERDUE to NORMAL, the ledger is unblocked and the account is again able to do cash-outs, assuming the account status is not BLOCKED. The two fields are not linked.

<table> <thead> <tr> <th>Collection status</th> <th>Account status</th> <th>Result</th> </tr> </thead> <tbody> <tr> <td><b>`NORMAL`</b> <td><b>`NORMAL`</b></td> <td>Account is usable.</td> </tr> <tr> <td><b>`NORMAL`</b> <td><b>`BLOCKED`</b></td> <td>Account is not usable.</td> </tr> <tr> <td><b>`OVERDUE`</b> <td><b>`NORMAL`</b></td> <td>Account is not usable.</td> </tr> <tr> <td><b>`OVERDUE`</b> <td><b>`BLOCKED`</b></td> <td>Account is not usable.</td> </tr> </tbody> </table>

For more information about the account collection status, refer to the Credit liquidation guide.

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

patch/statements-v2/v1/accounts/{accountId}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/accounts/{accountId}
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Request body

collection_status'NORMAL' | 'OVERDUE'

Collection status:

  • NORMAL
  • OVERDUE

If a customer fails to pay at least the minimum amount due on their credit account by a specified number of days after the due date, the account's collection_status is set to OVERDUE. In all other cases, it should be NORMAL. For more information, refer to Credit liquidation.

Example request

{
  "collection_status": "OVERDUE"
}

Response

Ok

org_idstring

Organization ID

account_idinteger

Account ID

collection_status'NORMAL' | 'OVERDUE'

Collection status:

  • NORMAL
  • OVERDUE

If a customer fails to pay at least the minimum amount due on their credit account by a specified number of days after the due date, the account's collection_status is set to OVERDUE. In all other cases, it should be NORMAL. For more information, refer to Credit liquidation.

Example response

{
  "org_id": "TN-e7091464-cd1e-4c20-8c68-1e4c5774d972",
  "account_id": 1010,
  "collection_status": "OVERDUE"
}

Changes

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