Payment Refund
Note: Please be sure you are not sending amount and currency for full refund. If your account does not support partitial refund your request will be declined.
Live URL : https://api.openpaydpsp.com/pw/v3/payment/refund
Test URL : https://testapi.openpaydpsp.com/pw/v3/payment/refund
The refund request will try to make the transaction refund, if it’s possible. If you make refund process via API, you will get the result straight away. Refund status will not come with IPN.
Request
Parameter Name | Detail | Example | Type | Is Required |
|---|---|---|---|---|
apiKey | Your Api Key provided from us. | 4d41d21a935f5bba9dee7c7be4a7ca04 | Char 32 | ✔ |
transactionId | Our unique transaction identifier. | 529-1438673740-2 | Char 32 | ✔ |
referenceNo | Your own transaction identifier. | 1-1386413490-0089-14 | Char 32 | ✔ |
amount | Amount in cents of the transaction. | 1234 for 12.34 € 1550 for 15.50 USD | Int | |
currency | The currency of transaction. | EUR | Char 3 |
Response
Parameter Name | Detail | Example | Type | Is Required |
|---|---|---|---|---|
code | Error Code Number | 00 | Int | ✔ |
status | Response status | APPROVED | Char 32 | ✔ |
message | Response message | Approved | Char 32 | ✔ |
transactionId | Our unique transaction identifier. | 12345-1234567890-123 | Char 32 | ✔ |
referenceNo | Your own transaction identifier. | 123456 | Char 32 | ✔ |
amount | Amount in cents of the transaction. | 1234 for 12.34 € 1550 for 15.50 USD | Int | ✔ |
currency | The currency of transaction. | EUR | Char 3 | |
date | Transaction timestamp | 1476187198 | Int | |
isLive | The Transaction live status | false | Boolean |
APPROVED Response Example
{
"code": "00",
"status": "APPROVED",
"message": "Approved",
"transactionId": "12345-1234567890-123",
"referenceNo": "123456",
"amount": "1234",
"currency": "EUR",
"date": 1476187198,
"isLive": false
}DECLINED Response Example
{
"code": 32,
"status": "DECLINED",
"message": "Already refunded",
"transactionId": "12345-1234567890-123",
"referenceNo": "123456",
"amount": "1234",
"currency": "EUR",
"date": 1476187472
}
Refundable Payment Methods
- CREDITCARD
- VISA
All other payment methods are non-refundable. If you try to make a refund with any of non-refundable methods, you will get Error response.
Partial Refund
You can use optional amount and currency parameter for partial refund.
As default partial refund is disabled on our system. If you would like to use this feature, please inform us before start to using it.
Updated 5 months ago