Sign in
Transactions

Refund a transaction

Process a refund on a transaction.

post/transactions/{transaction_id}/refund

Request body

refund_amountstring required

Set the refund amount. It cannot exceed the total minus any refunds or chargebacks.

cancel_order_offerboolean

Cancel any active order offer associated with the transaction.

cancel_active_shipmentboolean

Cancel any active shipment associated with the transaction.

check_refundboolean

Should it be sent as a check refund. This will not process at the gateway and a check will need to be manually issued.

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"
    }
  ]
}

Changes

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