The Refund Transaction API allows merchants and businesses to initiate refunds for transactions previously processed through their payment gateway. This API enables the seamless handling of refund requests, providing a straightforward way to return funds to customers when necessary.
Refunds can be performed using the transaction ID of the parent Sale transaction as a reference indicator.
Sample Request:
{
"type":"7",
"method":"CC",
"nonce":"12345645",
"reference_transaction_id":" 19207094",
"amount":"70.00",
"card":{
"number":"1165"
}
}
Sample Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209181",
"transaction_uid": "8dd5626f-d835-49bf-80f7-69052f983a63",
"transaction_datetime": "20230511T105634Z",
"account_type": "MC",
"account_last_4": "1165",
"amount": "70.00",
"approved_amount": "70.00",
"method": "CC",
"auth_code": "OK8697",
"avs_result_code": "",
"code_result": "",
"type": "7",
"expiration_date": "1225",
"token": "1338679300301165",
"emv": "",
"emv_tag_data": "",
"entry_mode": "10"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "P",
"product_id": "MC",
"prepaid_indicator": "",
"detailcard_indicator": "C",
"debitnetwork_indicator": "25P30P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00"
}
}
Partial Refund
This partial refund functionality allows merchants to issue refunds for specific portions of a payment while keeping track of the remaining balance. It provides more granular control over the refund process and allows for more accurate accounting of payment and refund amounts.
Sample Request:
{
"amount": "30.00",
"method": "CC",
"type": "7",
"nonce": "12345645",
"reference_transaction_id": "19207093",
"card": {
"number": "1111"
}
}
Sample Response:
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209198",
"transaction_uid": "b4581894-1c5b-4466-af82-1ad36abd2815",
"transaction_datetime": "20230512T071410Z",
"account_type": "VI",
"account_last_4": "1111",
"amount": "30.00",
"approved_amount": "30.00",
"method": "CC",
"auth_code": "OK8687",
"avs_result_code": "",
"code_result": "",
"type": "7",
"expiration_date": "1225",
"token": "919175985821111",
"emv": "",
"emv_tag_data": "",
"entry_mode": "10"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
Force Refund
An unlinked refund is a type of refund that is not directly linked to a payment and does not have an associated payment ID. It is used in situations where the original payment was processed by another payment processor, and there is no payment to link the refund to.
Sample Request:
{
"amount":"51.09",
"method":"CC",
"market_code": "E",
"type":"8",
"nonce":"12345645",
"test": "0",
"card":{
"number":"5487643414089407",
"expiration_date":"0928"
}
}
{
"amount": "40",
"method": "CC",
"type": "8",
"nonce": "12345645",
"test": "0",
"market_code": "R",
"notes": "REFUND",
"card": {
"track_data": "%B379605170000771^ISO/AMEX TEST^2512101071080699?;379605170000771=251210107108069900000???"
}
}
Sample Response
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209199",
"transaction_uid": "a400f64d-cddd-4a62-ac29-7621a2c7d412",
"transaction_datetime": "20230512T072340Z",
"account_type": "MC",
"account_last_4": "9407",
"amount": "51.09",
"approved_amount": "51.09",
"method": "CC",
"auth_code": "",
"avs_result_code": "",
"code_result": "",
"type": "8",
"expiration_date": "0928",
"token": "10e511c7288349bbb94848a0b8e7a5cd",
"emv": "",
"emv_tag_data": "",
"entry_mode": "00"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}
{
"transaction_response": {
"result_code": 1,
"result_sub_code": "000",
"result_text": "APPROVED",
"transaction_id": "19209200",
"transaction_uid": "94b6c190-3076-40a3-b063-7785cd85fdc6",
"transaction_datetime": "20230512T072426Z",
"account_type": "AX",
"account_last_4": "0771",
"amount": "40.00",
"approved_amount": "40.00",
"method": "CC",
"auth_code": "",
"avs_result_code": "",
"code_result": "",
"type": "8",
"expiration_date": "1225",
"token": "b7aca8172c284f51bdf89a22ef4b793b",
"emv": "",
"emv_tag_data": "",
"entry_mode": "02"
},
"nonce": "12345645",
"test": "0",
"customer": {
"first_name": "",
"last_name": "",
"street_1": "",
"street_2": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"phone_number": "",
"company": "",
"customer_id": "",
"email": "",
"email_receipt": "",
"notes": "",
"action_code": ""
},
"card_info": {
"card_class": "",
"product_id": "",
"prepaid_indicator": "",
"detailcard_indicator": "",
"debitnetwork_indicator": ""
}
}