7. Refund
Return Service
Refund
POST
{{Private Base Address}}/api/paywall/private/refund
You just need to send a request to the address provided above. You can use the 'Base Address' as you wish for both the test environment and the production environment.
Important: To use the return service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field. PaymentAPI Address
Parameter | Type | Mandatory | Description |
---|---|---|---|
apikeyprivate | string | Yes | The Private Key obtained from the member business panel. |
apiclientprivate | string | Yes | The Private Client you have obtained from the member business panel. |
The parameters that need to be sent to the service are as follows:
Parameter | Type | Mandatory | Description |
---|---|---|---|
Date | date | Yes | The date of the payment transaction. |
MerchantUniqueCode | string | Yes | The MerchantUniqueCode sent within the payment initiation request must be the same value. This code represents a unique identifier provided by your side for the transaction. It is used to uniquely identify and track a payment across various operations such as cancellation, refund, and payment inquiries. |
Response from the service:
Parameter | Type | Description |
---|---|---|
Body | object | JSON containing payment details (optional) |
ErrorCode | int | Error code. Returns '0' if the operation is successful. |
Result | bool | Returns a true or false value. Returns 'true' if the operation is successful. |
Message | string | If the operation fails, this is the specified error message that provides language support based on the 'locale' parameter. |
Last updated