Transactions

Reverse Fee

Use the Reverse Fee endpoint to reverse out a fee that was created with the <a href="ref:post_assessfee" target="_blank">Assess Fee</a> endpoint or created elsewhere in the system.

If the fee was created with Assess Fee, pass the transactionId of the endpoint request to be reversed instead of passing a new value. If the fee was not created by Assess Fee, pass feeId, which you can retrieve with the <a href="ref:post_getfeehistory" target="_blank">Get Fee History</a> endpoint.

post/reverseFee

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/reverseFee
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"

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>. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

feeIdinteger nullable

The fee ID (fee_id) of the fee to reverse, as returned by the <a href="ref:post_getfeehistory" target="_blank">Get Fee History</a> endpoint. Pass this value only if the fee was not created by the <a href="ref:post_assessfee" target="_blank">Assess Fee</a> endpoint.

verifyOnly'0' | '1' nullable

Pass 1 to test the validity of the parameter data without committing the information to the system. Pattern: Integer Example: "0"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "verifyOnly": "0"
}

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

Changes

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