API Reference
Start typing to search…

Refund

post
https://api.openpath.io/api/transact.php

Refund (refund)

Transaction refunds will reverse a previously settled or pending settlement transaction. If the transaction has not been settled, a transaction void can also reverse it.

NOTE: Besides the response body, OpenPath will also include our internal payment packet ID, the server which executed the transaction, the OpenPath Payment Provider/Gateway "Connector" ID and the name of that connector in the following format:

  • X-OpenPath-PacketId
  • X-OpenPath-Server
  • X-OpenPath-GatewayId
  • X-OpenPath-GatewayName
Query Params
string
required

Type of transaction. Values: 'refund'

string
required

Site Username assigned to a merchant Site account as API Login ID.

string
required

Site Password assigned to a merchant Site account as Transaction Key.

integer
required

Original payment gateway transaction ID.

number

Total amount to be refunded. This amount may be equal to or less than the settled amount. Setting the amount to 0.00 will refund the entire amount. Format: x.xx

string

The type of payment. Default: 'creditcard' Values: 'creditcard' or 'check'

Body Params
Response

Updated 9 months ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated 9 months ago