API ReferenceEndpointsMerchant hosted
Initiate a refund
Requests a refund for a completed transaction using paymentId and amount.
Authorization
basicAuth signatureAuth AuthorizationBasic <token>
In: header
X-Signature<token>
In: header
Header Parameters
X-MERCHANT-BROWSER-FINGERPRINT*string
Merchant browser fingerprint header shown in the docs.
X-MERCHANT-USER-AGENT*string
User agent forwarded by the merchant.
X-MERCHANT-DOMAIN*string
Merchant domain origin.
Format
uriX-MERCHANT-IP*string
Merchant IP address.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.uat.gateway.ompay.com/nac/api/v1/merchant-host/transaction/refund" \ -H "X-MERCHANT-BROWSER-FINGERPRINT: string" \ -H "X-MERCHANT-USER-AGENT: string" \ -H "X-MERCHANT-DOMAIN: http://example.com" \ -H "X-MERCHANT-IP: string" \ -H "Content-Type: application/json" \ -d '{ "paymentId": "string", "amount": 0 }'{
"resCode": 0,
"status": "string",
"data": {
"refundId": "string",
"paymentId": "string",
"orderId": "string",
"receiptId": "string",
"paymentStatus": "string",
"paymentMethod": "string",
"amount": 0,
"currency": "string",
"initiatedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"signature": "string"
}
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}{
"resCode": 0,
"status": "failure",
"errMessage": "string"
}