Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Transactions

Mark transaction as alert

By default, Vrio will flag the customer as Blacklisted and cancel any active order offers associated with the charge. Note - if the Alert Refund happens outside of the gateway, leave refund_transaction=0. Learn more <a href='https://vrio.zendesk.com/hc/en-us/articles/16089666241815-Disputes-Alert-Handling' target='_blank'>here</a>.

post/transactions/{transaction_id}/alert

Request body

datestring date required

Set the date of the alert.

amountstring

Amount. If amount is not passed, the full amount of the transaction will be used.

refund_transactionboolean

Should the original transaction be automatically refunded at the gateway.

codestring

Alert code.

alert_case_idstring

Alert case ID.

cancel_all_customer_order_offerboolean

Pass this flag if you would like to cancel All active order offers associated with the customer, not just the ones associated with the charge.

cancel_active_shipmentboolean

Cancel any active shipment 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
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"
    }
  ]
}