GAgalileo-ft
Transactions

Cancel Bill Payment

Use the Cancel Bill Payment endpoint to cancel the following types of billpay transactions:

  • Paper transactions in status N, W or P.
  • Electronic (RPPS) transactions in status N
  • Non-recurring paper or electronic transactions that are scheduled for a future date

If the transaction is in another status, the endpoint returns status_code: 435-02See <a href="doc:managing-billpay-transactions" target="_blank">Managing Billpay Transactions</a> for instructions on using this endpoint.

post/cancelBillPayment

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/cancelBillPayment
  • 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. Pattern: PAN or PRN Example: "074103447228"

billpayTransactionIdinteger required

The billpay transaction ID (billpay_transaction_id) as returned by the <a href="ref:post_createbillpayment" target="_blank">Create Bill Payment</a> or <a href="ref:post_getbillpayhistory" target="_blank">Get Bill Payment History</a> endpoint. Pattern: Positive integer Example: 3433443

Example request

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

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.