Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Accounts and Cards

Charge Off Account

Use the Charge Off Account endpoint to charge off the specified account (sweep funds and set balance to 0.00) and move the account to status: R (charged off).

These are the rules for using the chargeOffDetails parameter:

  • chargeOffDetails accepts a JSON-formatted list with chargeOffAmount and chargeOffReason as the two keys.
  • The only valid values for chargeOffReason are the numerals 1-13, as shown in the <a href="ref:post_chargeoffaccount#chargeoffreason" target="_blank">chargeOffReason</a> table.
  • chargeOffAmount is a float that must be greater than 0. If you pass 0 the request will fail.
  • chargeOffAmount is required when chargeOffReason does not equal 1.

Example: [{"chargeOffAmount": 2.6, "chargeOffReason": 5}, {"chargeOffAmount": 4.75, "chargeOffReason": 2}]

To recover a charged-off account use the <a href="ref:post_recoverchargedoffaccount" target="_blank">Recover Charged-Off Account</a> endpoint.

post/chargeOffAccount

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.