VRvrio
Transactions

Void a transaction

This is only available during the allotted timeframe allowed by the gateway to complete a void.

post/transactions/{transaction_id}/void

Request

  • Base URL
    https://api.vrio.app
  • URL
    https://api.vrio.app/transactions/{transaction_id}/void
  • Auth
    API key in header X-Api-Key

Request body

cancel_order_offerboolean

Cancel any active order offer associated with the transaction.

transaction_notesstring

Apply note to the history of this transaction.

Response

OK

successboolean
response_codeinteger
responsestring
gateway_response_idstring
gateway_response_gateway_idstring
gateway_response_codestring
gateway_auth_codestring
gateway_response_cvvstring
gateway_response_avsstring
gateway_response_textstring
gateway_request_textstring
processor_response_textstring
date_requeststring date-time nullable
date_responsestring date-time nullable
merchant_idinteger
merchant_descriptorstring nullable
reasonstring nullable

Reason in case of merchant error.

gateway_response_descriptionstring
gateway_hard_declinestring
transaction_idinteger
transaction_totalstring
transaction_pricestring
transaction_taxstring
transaction_shippingstring
transaction_discount_totalstring
gift_card_appliedstring
customer_balance_appliedstring
post_datastring nullable
shipment_idinteger nullable

Example response

{
  "date_request": "2023-04-01 00:00:00",
  "date_response": "2023-04-01 00:00:00",
  "reattempt_data": [
    {
      "date_request": "2023-04-01 00:00:00",
      "date_response": "2023-04-01 00:00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.