GAgalileo-ft
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

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/chargeOffAccount
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Do not use the PRN if more than one card has ever been associated with this account. Pattern: PAN or PRN Example: "074103447228"

chargeOffDetailsstring nullable

A JSON object containing a list of charge-off details. See the endpoint description above for details. Pattern: JSON format (list of dictionaries) Example: "[{"chargeOffAmount": 2.6, "chargeOffReason": 5}, {"chargeOffAmount": 4.75, "chargeOffReason": 2}]"

closeAssociatedAccounts0 | 1 nullable

If accountNo is a secondary account, pass 1 to close all accounts with the same balance ID. Pattern: Integer Example: 1

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "chargeOffDetails": "[{\"chargeOffAmount\": 2.6, \"chargeOffReason\": 5}, {\"chargeOffAmount\": 4.7, \"chargeOffReason\": 2}]\"",
  "closeAssociatedAccounts": 1
}

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.