v1

latestOpenAPI 3.1.02026-07-2413059.7 KB

Refund

The Refund API allows you to issue either full or partial refunds for a Gateway Payment.

post/refund

Request body

api_secretstring required

This is the credential that Vendo will use to authenticate your request

is_testinteger required

Set to 1 if you want to process a test transaction.

merchant_idinteger required

Your Vendo Merchant ID.

transaction_idinteger required

The Vendo Transaction ID you received when requesting the payment.

partial_amountnumber float

Optionally specify the amount for the partial refund. The default is to refund the full amount unless this parameter is present.

currencystring

Optional 3-letter currency code of the amount to be refunded. Currencies.

Response

200

OR

Example response

{
  "status": 1,
  "transaction_id": 240326422,
  "request_id": "yMTU4MTE3Mi4xOS4wLjE0NDk1NjQ5MzU"
}