Refund Transaction
Description¶
The refundTransaction endpoint submits a refund transaction for a payment whose funds have been captured to a payment gateway.
Request¶
Endpoint¶
/ui/v1/refundTransactionMethod¶
POSTHeader¶
Content-Type: application/json
Authorization: Basic $TOKEN
Note
Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.
Given a username of username and a password of password, the request header would appear as follows:
Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Attributes¶
| ELEMENT | DESCRIPTION | FORMAT |
|---|---|---|
| orderId | Required Order ID of a Capture or Sale transaction |
|
| refundAmount | Required Refund Amount |
10.00 or 1000 Include decimal (e.g., 10.00) for CyberSource, omit (e.g., 1000) for Realex |
| refundMethod | Required The method of refunding a payment |
Refund Methods |
Request Body¶
{
$ORDER_ID
}
Note
Replace $ORDER_ID with the Order ID of the auth transaction.
Response¶
{
"tiList": [{
"id": 13,
"originalOrderId": "9e1a68c2-12e9-4915-844b-53bb52b806cf",
"pymtGtwyRefNumber": "5130156641506661104012",
"authCode": "",
"parentPymtGtwyRefNumber": "5130109941946473204012",
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"money": {
"amount": 10.000,
"currency": {
"id": null,
"currencyCode": "USD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null
}
},
"orderId": "f8c9d801-df8d-449c-9bb4-862513f98fb0",
"splitPaymentsTxnSequence": "2",
"encryptedPaymentMethod": null,
"paymentMethodType": {
"value": "VISA",
"name": "VISA"
},
"encodedMetaData": null,
"responseMsg": "ACCEPT",
"responseCode": "100",
"createdDateTime": null,
"lastUpdatedDateTime": null,
"transactionStatus": {
"value": "Success",
"name": "SUCCESS"
},
"application": {
"id": 1,
"applicationName": "Test Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1513010147000,
"companyId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"paymentMethods": [{
"id": 5,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513010181000,
"lastUpdatedDateTime": null,
"position": 42
}, {
"id": 1,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513010180000,
"lastUpdatedDateTime": null,
"position": 11
}, {
"id": 7,
"paymentMethodType": {
"value": "eCheck",
"name": "ECHECK"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "eCheck",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513010181000,
"lastUpdatedDateTime": null,
"position": 47
}, {
"id": 9,
"paymentMethodType": {
"value": "PayPal",
"name": "PAYPAL"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "PayPal",
"name": "PAYPAL"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "PayPal",
"name": "PAYPAL"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513010181000,
"lastUpdatedDateTime": null,
"position": 50
}, {
"id": 8,
"paymentMethodType": {
"value": "VISA Checkout",
"name": "VISA_CHECKOUT"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA Checkout",
"name": "VISA_CHECKOUT"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513010181000,
"lastUpdatedDateTime": null,
"position": 48
}
],
"createdUserId": 1,
"lastModifiedUserId": 1,
"userCount": null,
"assignedPaymentMethods": null,
"message": null
},
"geolocationInfo": "{\"city\":\"Arnold\",\"country\":{\"name\":\"United States\",\"code\":\"US\"},\"location\":{\"accuracy_radius\":1000,\"latitude\":38.4231,\"longitude\":-90.4006,\"time_zone\":\"America/Chicago\"},\"ip\":\"74.223.27.18\",\"remoteHost\":\"127.0.0.1\",\"userAgent\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36\"}",
"transactionType": {
"value": "Void",
"name": "VOID"
},
"batchStatus": {
"value": "New",
"name": "NEW"
},
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"reconcileTransactionRefNumber": null,
"batchID": null,
"voidActionInd": false,
"refundActionInd": false,
"captureActionInd": false,
"paymentType": "SINGLE_PAYMENT",
"recurringInd": false,
"paymentCycle": "ONCE",
"totalRefundedAmount": null,
"refundStatus": {
"value": "None",
"name": "NONE"
},
"refundMethod": null,
"scheduledPaymentDateTime": null,
"subscriptionId": "9909000191270720",
"transactionOwnerId": 3,
"vcOrderId": null,
"invoiceNumber": "",
"returnURL": null,
"cancelURL": null,
"geoLocation": null,
"paymentRedirectURL": null,
"cardType": null,
"realex3DSecureVISAPit": "",
"realex3DSecureURL": "",
"realex3DSecurePaReq": "",
"realex3DSecureEncodedMD": "",
"realexRequestID": "",
"createdUserName": null,
"capturePymtGtwyRefNumber": null,
"transactionOwnerUserName": null,
"ipaymentMethod": null,
"ssoenabledInd": ""
}
]
}