Ecommerce

Void a transaction

Allows you to void a credit card, debit card, or echeck transaction using the Nexio Payment ID. In order to void a transaction, it must have been authorized but not yet settled.

The entire process for voiding a transaction is as follows:

  1. A transaction using the Run card transaction or Run echeck transaction endpoint occurs.
  2. Retrieve the id from the response. This is the Nexio Payment ID.
  3. Include that id in the body of your request for this endpoint in order to void the transaction.

If you do not know the paymentId, you can get an array of possible transactions that have authorized but are not yet settled with the View transactions endpoint and at least the following query filters:<br/>transactionStatus=10<br/>plugin=

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.<br/><br/>You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right. username: docs@nexiopay.com password: JZdzoXpdDeH6VA<br/><br/>Include the ID as indicated above.

<div style="display:none;">

Request parameters

  • id

Response parameters

  • id
  • merchantId
  • transactionDate
  • authCode
  • transactionStatus
  • transactionType
  • currency
  • message
  • data
  • data.currency
  • data.settlementCurrency
  • gatewayResponse
  • gatewayResponse.gatewayName
  • gatewayResponse.refNumber
</div>
post/pay/v3/void

Request body

idstring required

The Nexio Payment ID. To void a transaction through this endpoint it must have been captured through the Nexio Payment API.

Example request

{
  "id": "eyJuYW1lIjoWJlciI6IjMxCJtZXJjaGFudElkIjoiMoiVVNEIn0="
}

Response

Success

idstring

The Nexio Payment ID.

merchantIdstring

The merchant ID (MID) through which the transaction was originally processed.

authCodestring

Indicates the code for the originally processed and successfully authorized payment request. Not all gateways or connections return a value for authCode, so Nexio recommends against using this for reconciliation or bookkeeping.

transactionTypestring
transactionDatestring

The original transaction date and time, formatted as an ISO-8601 date expressed in UTC.

transactionStatusstring

The current transaction status. If the void request is successful, this value will be voided.

messagestring

A message describing the status of the request.

currencystring

The three-character ISO code for the currency used in the original transaction.

random-nnnnnnnRandomNnnn — unresolved $ref

Changes