POST v1/Generic/Refund
Updates order / invoice record for refunds or voids coming from PRC
Request Information
URI Parameters
None.
Body Parameters
RefundRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| requestTransactionID | integer |
None. |
|
| ReverseResponse | ReverseTransactionResponse |
None. |
Request Formats
application/json, text/json
Sample:
{
"requestTransactionID": 1,
"ReverseResponse": {
"transactionID": 1,
"token": "sample string 2",
"amountDetails": {
"attemptedSubtotalAmount": 1.1,
"appliedSubtotalAmount": 2.1,
"attemptedTaxAmount": 3.1,
"appliedTaxAmount": 4.1,
"attemptedTipAmount": 5.1,
"appliedTipAmount": 6.1,
"attemptedTotalAmount": 7.1,
"approvedTotalAmount": 8.1,
"cashoutAmount": 9.1
},
"issuerResponseDetails": {
"issuerResponseCode": "sample string 1",
"issuerResponseDescription": "sample string 2",
"avsResponseCode": "sample string 3",
"avsResponseDescription": "sample string 4",
"cvvResponseCode": "sample string 5",
"cvvResponseDescription": "sample string 6",
"authCode": "sample string 7",
"processingNetwork": 0
},
"accountDetails": {
"paymentMethod": 1,
"cardBIN": "sample string 2",
"paymentAccountLast4": "sample string 3",
"nameOnAccount": "sample string 4",
"expirationMonth": 5,
"expirationYear": 6,
"cardEntryMethod": 7,
"routingNumber": "sample string 8",
"achAuthorizationType": 9
},
"emvDetails": {
"emvApplicationIdentifier": "sample string 1",
"emvApplicationName": "sample string 2",
"emvCryptogramType": "sample string 3",
"emvCryptogramValue": "sample string 4",
"emvVerificationType": "sample string 5"
},
"signatureDetails": {
"signatureGathered": true
},
"actionGuid": "sample string 3",
"isSuccessful": true,
"responseCode": 5,
"responseDetails": [
{
"message": "sample string 1"
},
{
"message": "sample string 1"
}
],
"durationInMilliseconds": 6
}
}
application/xml, text/xml
Sample:
<RefundRequestModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<requestTransactionID>1</requestTransactionID>
<ReverseResponse>
<actionGuid>sample string 3</actionGuid>
<isSuccessful>true</isSuccessful>
<responseCode>5</responseCode>
<responseDetails>
<FSResponseModelDetail>
<message>sample string 1</message>
</FSResponseModelDetail>
<FSResponseModelDetail>
<message>sample string 1</message>
</FSResponseModelDetail>
</responseDetails>
<durationInMilliseconds>6</durationInMilliseconds>
<transactionID>1</transactionID>
<token>sample string 2</token>
<amountDetails>
<attemptedSubtotalAmount>1.1</attemptedSubtotalAmount>
<appliedSubtotalAmount>2.1</appliedSubtotalAmount>
<attemptedTaxAmount>3.1</attemptedTaxAmount>
<appliedTaxAmount>4.1</appliedTaxAmount>
<attemptedTipAmount>5.1</attemptedTipAmount>
<appliedTipAmount>6.1</appliedTipAmount>
<attemptedTotalAmount>7.1</attemptedTotalAmount>
<approvedTotalAmount>8.1</approvedTotalAmount>
<cashoutAmount>9.1</cashoutAmount>
</amountDetails>
<issuerResponseDetails>
<issuerResponseCode>sample string 1</issuerResponseCode>
<issuerResponseDescription>sample string 2</issuerResponseDescription>
<avsResponseCode>sample string 3</avsResponseCode>
<avsResponseDescription>sample string 4</avsResponseDescription>
<cvvResponseCode>sample string 5</cvvResponseCode>
<cvvResponseDescription>sample string 6</cvvResponseDescription>
<authCode>sample string 7</authCode>
<processingNetwork>None</processingNetwork>
</issuerResponseDetails>
<accountDetails>
<paymentMethod>1</paymentMethod>
<cardBIN>sample string 2</cardBIN>
<paymentAccountLast4>sample string 3</paymentAccountLast4>
<nameOnAccount>sample string 4</nameOnAccount>
<expirationMonth>5</expirationMonth>
<expirationYear>6</expirationYear>
<cardEntryMethod>7</cardEntryMethod>
<routingNumber>sample string 8</routingNumber>
<achAuthorizationType>9</achAuthorizationType>
</accountDetails>
<emvDetails>
<emvApplicationIdentifier>sample string 1</emvApplicationIdentifier>
<emvApplicationName>sample string 2</emvApplicationName>
<emvCryptogramType>sample string 3</emvCryptogramType>
<emvCryptogramValue>sample string 4</emvCryptogramValue>
<emvVerificationType>sample string 5</emvVerificationType>
</emvDetails>
<signatureDetails>
<signatureGathered>true</signatureGathered>
</signatureDetails>
</ReverseResponse>
</RefundRequestModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
RefundResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| isSuccess | boolean |
None. |
|
| transactionID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"isSuccess": true,
"transactionID": 2
}
application/xml, text/xml
Sample:
<RefundResponseModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <isSuccess>true</isSuccess> <transactionID>2</transactionID> </RefundResponseModel>
