Secure Payments API Void Transaction

General

You may need to void Secure Payments (formerly PCI Wallet) transaction statuses based on a returns file received from a bank or other ACH processor. This article will cover how to void a transaction through the Secure Payments API. A voided payment is one that has settled successfully, but then needs to be undone. Depending on the processor the functionality to void a payment may or may not be present. Returned and failed payments are different as they failed at the processor level and did not settle successfully.

Void Transaction Endpoint

To void a transaction, you will send a PUT request to the endpoint: https://pciwallet.simnang.com/api/transactions/{transaction-id}

The "{transaction-id}" will be replace with the actual transaction id that you wish to void.

The payload will look something like this:

{  
"transaction":{
"message":"Transaction Voided",
"status":"VOIDED"
}
}
  • message - the message should help you remember the reason for changing the transaction's status.
  • status - the status can potentially be any of the following: PROCESSING, FAILED, or SETTLED SUCCESSFULLY. For some processors, the status can also be VOIDED.

Note: Voiding a transaction relies on the integrated processor's ability to void it. If the payment processor is unable to void the transaction, you will be unable to change the transaction to the VOIDED status in Secure Payments.


How did we do?


Powered by HelpDocs (opens in a new tab)