Refund

put

https://api.prahsys.com/payments/n1/merchant/{merchantId}/payment/{paymentId}/refund

Path Params

merchantId

string

required

The merchant ID

paymentId

string

required

The payment ID. This is defined when you create/update a Pay Portal or Pay Session.

Body Params

amount

number | null

Transaction Amount. Expressed as a decimal number in the units of the currency. For example 12.34 in USD is the amount 12 dollars and 34 cents. Must be a string consisting of characters 0-9 and '.' representing a valid decimal number. Length: 1-14 characters.

currency

string | null

The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD. Must consist of uppercase letters A-Z only. Length: exactly 3 characters.

targetTransactionId

string | null

The identifier for the transaction you wish to refund ('id' field returned in transaction responses). Can consist of any characters. Length: 1-40 characters.

session

object | null

Session details

terminal

string | null

Card Present terminal ID

Headers

X-Prahsys-Version

string

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response from refunding an payment transaction

400Validation error response

401Authorization error response

500Error response