Below are the details for the response that will be received after sending a CardDetailsTransaction request.
|
Tag/Attribute Name |
Data Type |
Max Length |
Always Present |
Comments |
||||
|
CardDetailsTransactionResponse |
Yes |
|
||||||
|
|
CardDetailsTransactionResult |
Yes |
|
|||||
|
|
AuthorisationAttempted (attribute) |
B |
– |
Yes |
This indicates whether the transaction was actually sent to the acquirer for authorisation, or whether it failed before authorisation |
|||
|
|
StatusCode |
N |
|
Yes |
This indicates the status of the transaction |
|||
|
|
Message |
A |
|
Yes |
This gives a more detailed description of the status of the transaction |
|||
|
|
ErrorMessages |
No |
|
|||||
|
|
|
MessageDetail |
Yes |
|
||||
|
|
Detail (multiple) |
A |
256 |
Yes |
If there were multiple error messages(e.g.multipleinput variable validation errors, then they will be detailed here) |
|||
|
|
PreviousTransactionResult |
No |
|
|||||
|
|
StatusCode |
N |
|
Yes |
If the transaction was deemed to be a duplicate transaction, this indicates the status of the previous transaction |
|||
|
|
Message |
A |
|
Yes |
If the transaction was deemed to be a duplicate transaction, this givesamore detailed description of the status of the previous transaction |
|||
|
|
TransactionOutputData |
No |
|
|||||
|
|
CrossReference (attribute) |
A |
25 |
Yes |
This is the unique cross reference for this transaction. If the card has been determined as requiring 3D Secure authentication this must be used as the merchant reference. If the transaction required 3D Secure authentication, then this must be passed to the ACS as ‘MD’. If the transaction was rejected as a duplicate transaction, this value will hold the cross reference of the previous transaction |
|||
|
|
ExternalCrossReference (attribute) |
A |
– |
No |
If requested in the CardDetailsTransaction request message, this gives the unique cross reference of the transaction from the bank’s external system passed back to the Payment Gateway. If the card has been determined as requiring 3D Secure authentication this will not be present in the response. |
|
|
ExternalClientReference (attribute) |
A |
– |
No |
If requested in the CardDetailsTransaction request message, this gives the unique client reference of the transaction from the bank’s external system passed back to the Payment Gateway. If the card has been determined as requiring 3D Secure authentication this will not be present in the response. |
|
|
ExternalTransactionUID (attribute) |
A |
– |
No |
If requested in the CardDetailsTransaction request message, this gives the unique identifier of the transaction from the bank’s external system passed back to the Payment Gateway. If the card has been determined as requiring 3D Secure authentication this will not be present in the response. |
|
|
AuthCode |
A |
15 |
No |
If the transaction was successful, then the auth code is passed out here |
|
|
AddressNumericCheckResult |
– |
– |
No |
If requested in the CardDetailsTransaction request message, this gives the results of the address numeric check – will be PASSED, FAILED, PARTIAL, NOT_CHECKED or UNKNOWN |
|
|
PostCodeCheckResult |
– |
– |
No |
If requested in the CardDetailsTransaction request message, this gives the results of the post code check – will be PASSED, FAILED, PARTIAL, NOT_CHECKED or UNKNOWN |
||
|
|
CV2CheckResult |
– |
– |
No |
If requested in the CardDetailsTransaction request message, this gives the results of the CV2check – will be PASSED, FAILED, NOT_CHECKED or UNKNOWN |
||
|
|
CardTypeData |
No |
|
||||
|
|
CardType |
A |
– |
Yes |
If requested in the CardDetailsTransaction request message, this gives the card type for the transaction. (See Appendix 4 for details) |
||
|
|
Issuer |
A |
100 |
No |
The card issuer (if known) |
||
|
|
AmountReceived |
N |
15 |
No |
If requested in the CardDetailsTransaction request message, this gives the amount that was passed to the gateway via the request message |
||
|
|
ThreeDSecureOutputData |
No |
|
||||
|
|
PaREQ |
A |
– |
Yes |
If the card has been determined as requiring 3D Secure authentication, this gives the base64 encoded payment request that must be passed to the ACS for authentication. This must be sent to the ACS as ‘PaReq’ |
||
|
|
ACSURL |
A |
– |
Yes |
If the card has been determined as requiring 3D Secure authentication, this gives the URL of the ACS server that the PaREQ must be sent to |
||
|
|
GatewayEntryPoints |
Yes |
|
||||
|
|
|
GatewayEntryPoint (multiple) |
Yes |
|
|||
|
|
EntryPointURL (attribute) |
A |
256 |
Yes |
The URL of the active gateway entry point |
||
|
|
Metric (attribute) |
N |
5 |
Yes |
A metric value giving an indication of whether transactions should be sent to this gateway entry point |
||
Things to Note
-
If requested, the AmountReceived will always echo the amount passed to the gateway in the CardDetailsTransaction message, regardless of the outcome of the transaction (apart from if the message could not be validated due to content errors)
-
If the CV2 is not submitted in the CardDetailsTransaction message, then the CV2CheckResult returned in the CardDetailsTransactionResponse will be deemed as UNKNOWN, rather than FAILED
-
If the address or the post code information is not submitted in the CardDetailsTransaction message, then the AddressNumericCheckResult and/or the PostCodeCheckResult returned in the CardDetailsTransactionResponse will be deemed as UNKNOWN rather than FAILED
-
If the transaction requires 3D Secure validation, then the CrossReference will be used as the variable “MD” which needs to be posted to the Access Control Server (ACSURL) along with the PaREQ
-
If the External Data was requested in the CardDetailsTransaction message (EchoExternalData=TRUE) and the transaction requires 3D Secure validation, the External Data will not be passed back in the CardDetailsTransactionResponse. Such External Data will be returned in the ThreeDSecureAuthenticationResponse.
-
The Amount can be zero (0) if the TransactionType is passed as PREAUTH.
-
If the CardDetailsTransaction message contains AlternatePaymentMethod details, Zero (0) Amount is not allowed.
