CREDITVOID request
CREDITVOID request is used to complete both REFUND and REVERSAL transactions.
REVERSAL transaction is used to cancel hold from funds on card account, previously authorized by AUTH transaction.
REFUND transaction is used to return funds to card account, previously submitted by SALE or CAPTURE transactions.
This request is sent by POST in the background (eg, through PHP CURL).
Request parameters
| Parameter | Description | Values | Required field |
| action | CREDITVOID | CREDITVOID | + |
| client_key | Unique client key (CLIENT_KEY) | + | |
| trans_id | Transaction ID in the Payment Platform | String up to 255 characters | + |
| amount | The amount for partial refund. Several partial refunds allowed. | Numbers in the form XXXX.XX (without leading zeros) | – |
| hash | Special signature to validate your request to Payment Platform | **(Appendix A) | + |
Response parameters
| Parameter | Description |
| action | CREDITVOID |
| result | ACCEPTED |
| order_id | Transaction ID in the Client’s system |
| trans_id | Transaction ID in the Payment Platform |
Callback parameters
Successful refund/reversal response
| Parameter | Description |
| action | CREDITVOID |
| result | SUCCESS |
| status | REFUND/REVERSAL |
| order_id | Transaction ID in the Client system |
| trans_id | Transaction ID in the Payment Platform |
| creditvoid_date | Date of the refund/reversal |
| amount | Amount of refund. |
| hash | Special signature, used to validate callback**(Appendix A) |
Unsuccessful refund/reversal response
| Parameter | Description |
| action | CREDITVOID |
| result | DECLINED |
| order_id | Transaction ID in the Client system |
| trans_id | Transaction ID in the Payment Platform |
| decline_reason | Description of the cancellation of the transaction |
| hash | Special signature, used to validate callback **(Appendix A) |
