The EdgePay Payment Responses contain non-sensitive data that you use to validate the status of the transaction and confirm your next step in your software workflow. This may be updating your order status, building receipts or updating your customer’s browser. You may even be storing tokens for future payments.
The Payment Response header contains general HTTP standards that your server will be expecting for processing.
{
"result": "A",
"responseCode": "A0000",
"responseMessage": "Success",
"merchantID": "6320340123456900",
"terminalID": "88800000282601",
"timestamp": "2018-06-11 18:43:10",
"securityResult": "A",
"securityMessage": "APPROVED",
"authCode": "TAS632",
"Processor": "TSYS",
"amount": "1.23",
"maskedAccount": "401200*****5439",
"cardExpirationDate": "1220",
"tokenID": "4467177699570098",
"customerNumber": "12345",
"transactionID": "CS80075829370078570",
"customerNumber": "51224",
"avsResponse": "Exact Match (Y) the five-character zip code matches what is on file",
"cvvResponse": "cvv2 verification successful",
"commercialCard": "n",
"avsCode": "Z"
}
The Payment Response supports a JSON encoded listing of fields below:
| Field Name | Max Size | Attribute | Notes |
|---|---|---|---|
| result | 1 | A | A = Approved D = Decline R = Retry C = Call for help You may use this field to drive your software workflow. |
| securityResult | 1 | A | Conditional - A = Approved D = Decline R = Review If the EdgePay Fraud Management Service is enabled FMS will return a result. Use the EdgePay Processing center to review potential security-related transactions. |
| authCode | 6 | AN | Conditional - Returned if provided from issuer and request includes Auth. |
| Processor | 10 | AN | Conditional - Returned if provided from issuer and request includes Auth. |
| responseCode | 5 | AN | SEE TABLE |
| responseMessage | 225 | AN | SEE TABLE |
| merchantId | 19 | N | ECHO Back |
| terminalID | 19 | N | ECHO Back |
| amount | 12 | N | Response to requested amount. If less than requested amount, then use partial approval flow. |
| currencyCode | 3 | N | Conditional ECHO BACK if included in request |
| maskedAccount | 16 | N | Masked account data. Card: first 6, last 4 unmasked. eCheck: last 4 unmasked. |
| cardExpirationDate | 4 | N | Conditional returned if provided |
| tokenID | 16 | N | Conditional - Provided if requested |
| customerNumber | 17 | AN | Conditional - ECHO BACK |
| transactionID | 19 | 19 | Unique Identifier assigned by EdgePay |
| avsResponse | 225 | AN | Conditional - provided for avsOnly or if card not present and billingZip provided. SEE TABLE |
| cvvResponse | 225 | AN | Conditional - Provided for cvvOnly or if cvv2 field used. Match or mismatch. |
| commercialCard | 1 | A | 'Y' - commercial card 'N' - not a commercial card |
| timestamp | 19 | Date | YYYY-MM-DD-hh-mm-ss (UTC) |
| merchantField1 | 200 | AN | Optional - returned if provided |
| merchantField2 | 200 | AN | Optional - returned if provided |