refund a payment

Securityapi_key
Request
path Parameters
paymentId
required
string
Example: YOUR_PAYMENTID
Request Body schema: application/json
required
object (TMerchantData)

merchant related data

customerId
string

only applicable for registered customer. need to be matched with the original transaction

amount
number
Default: "full amount"

by default, the service will populate the remaining amount - full amount from original transaction minus the approved refund amount. Otherwise, it is partial refund (less or equal to the remaining amount)

channel
string
Default: "ECOMMERCE"
Enum: "ECOMMERCE" "POS" "MAIL_ORDER" "TELEPHONE_ORDER" "OTHER"
object

this metadata is used to address any specific merchants / partners integration requirements.

Responses
200

Successful response.

400

Invalid Request

401

Invalid API key.

403

Forbidden from performing this action.

500
post/online/v1/payment/{paymentId}/refund
Request samples
application/json
{
  • "merchantData": {
    },
  • "amount": 98.49,
  • "channel": "ECOMMERCE"
}
Response samples
application/json
{
  • "transactionReceipt": "string",
  • "payment": {
    },
  • "result": {
    }
}