Partial / Full Transaction Refund by Transaction ID (Refund By Transaction ID)
When to use this function?
Businesses that want to manage and refund transactions on their own side, without accessing the CardCom interface, can use this function.
Note:
The transaction refund does not generate a document.
Here is a link to the function in JSON format.
Request Method: POST
Refund By Transaction Id
https://secure.cardcom.solutions/api/v11/Transactions/RefundByTransactionId
Below are the parameters that need to be passed to the RefundByTransactionId function.
Legend:
Red parameter – Mandatory
Bold parameter – Recommended
Parameter that is neither red nor bold – Optional
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ApiName | "test2025" | name API. |
| 2 | ApiPassword | "test5000$" | API password. |
| 3 | TransactionId | 204961310 | internal deal number. |
| 4 | PartialSum | 100 | partial refund sum. |
| 5 | CancelOnly | boolean - true \ false | cancel deal only |
| 6 | SapakMutav | the business spak mutav | |
| 7 | AllowMultipleRefunds | boolean - true \ false | allow multiple partial refunds on this deal. |
| 8 | CustomFields |
Id - 20 Value - "value" |
the values of the custome fileds. |
RESPONSE של Refund By Transaction Id.
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ResponseCode | 0 |
0 - succesful otherwise it is an error. |
| 2 | Description | "העסקה בוצעה בהצלחה" | the description of the function response. |
| 3 | NewTranzactionId | 204972703 | the new refund deal internal id. |
Below is a sample code for the function along with the response.
Example of a transaction cancellation:
{
"ApiName": "kzFKfohEvL6AOF8aMEJz",
"ApiPassword": "FIDHIh4pAadw3Slbdsjg",
"TransactionId": 204966999,
"CancelOnly": true,
"AllowMultipleRefunds": true
}
Example of a partial transaction refund:
{
"ApiName": "kzFKfohEvL6AOF8aMEJz",
"ApiPassword": "FIDHIh4pAadw3Slbdsjg",
"TransactionId": 204966999,
"PartialSum": 200,
"CancelOnly": false,
"AllowMultipleRefunds": true
}
Example of the response received:
{
"ResponseCode": 0,
"Description": "עסקה זוכתה בהצלחה",
"NewTranzactionId": 204972703
}