externalPaymentData
JSON object
externalPaymentData
This data elements is not EMV 3DS related, but returns additional data for authorization from external parties (e.g. acquirer / 3rd party processor).
This data element is only returned if request parameter msgver has been used.
It is currently supported for GICC and CB2A, only.
Data Elements
Please note that all data elements listed below are optional in externalPaymentData – also the element externalPaymentData itself is optional.
| Key | Format | CND | Description | Paygate legacy KVP | |
|---|---|---|---|---|---|
| 1 | externalApprovalCode | string | O | Acquiring Bank’s authorization code / 3rd party approval code | AID / ApprovalCode |
| 2 | externalResponseCode | string | O | 3rd party response code | CodeExt |
| 3 | externalOriginalCode | string | O | In case of credit card payments this represents Issuer/Scheme response code | OriginalCode |
| 4 | externalResponseMessage | string | O | 3rd party response message | ErrorText |
| 5 | externalOriginalMessage | string | O | In case of credit card payments this represents Issuer/Scheme response message | OriginalExtended |
| 6 | externalTransactionID | string | O | 3rd party transaction identifier | TransactionID / GuWID |
| 7 | externalToken | string | O | 3rd party token | TokenExt |
| 8 | externalMerchantID | string | O | 3rd party merchant identifier | VU / VUNr |
| 9 | externalTerminalID | string | O | 3rd party terminal identifier | TID / TerminalID |
| 10 | externalOrderID | string | O | 3rdparty order ID |
Schema
BASEURL= https://www.computop-paygate.com/schemas
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "BASEURL/resultsResponse.json",
"type": "object",
"properties": {
"externalApprovalCode": {
"type": "string"
},
"externalResponseCode": {
"type": "string"
},
"externalOriginalCode": {
"type": "string"
},
"externalResponseMessage": {
"type": "string"
},
"externalOriginalMessage": {
"type": "string"
},
"externalTransactionID": {
"type": "string"
},
"externalToken": {
"type": "string"
},
"externalMerchantID": {
"type": "string"
},
"externalTerminalID": {
"type": "string"
},
"externalOrderID": {
"type": "string"
}
},
"additionalProperties": false
} "type": "object",
"properties": {
"externalApprovalCode": {
"type": "string"
},
"externalResponseCode": {
"type": "string"
},
"externalOriginalCode": {
"type": "string"
},
"externalResponseMessage": {
"type": "string"
},
"externalOriginalMessage": {
"type": "string"
},
"externalTransactionID": {
"type": "string"
},
"externalToken": {
"type": "string"
},
"externalMerchantID": {
"type": "string"
},
"externalTerminalID": {
"type": "string"
},
"externalOrderID": {
"type": "string"
}
},
"additionalProperties": false
}
Sample
Sample 1
received as
externalpaymentdata=e30
and Base64-decoded as:
{ }
Sample 2
received as
externalpaymentdata=eyJleHRlcm5hbEFwcHJvdmFsQ29kZSI6IjE1OTA3OSIsImV4dGVybmFsUmVzcG9uc2VDb2RlIjoiMDAiLCJleHRlcm5hbE1lcmNoYW50SUQiOiI0MzY4MDk0IiwiZXh0ZXJuYWxUZXJtaW5hbElEIjoiNDM2ODA5NCJ9
and Base64-decoded as:
{"externalApprovalCode":"159079","externalResponseCode":"00","externalMerchantID":"4368094","externalTerminalID":"4368094"}
