Introduction
This message returns a list of transaction details processed under the queried PayByLink.
Request
Below are the details for the request message to initiate a PayByLinkQuery transaction.
|
Tag/Attribute Name |
Data Type |
Max Length |
Mandatory |
Comments |
||||
|
PayByLinkQueryMessage |
Yes |
|||||||
|
MerchantAuthentication |
Yes |
|||||||
|
MerchantID |
A |
15 |
Yes |
The gateway account merchant ID issued (not to be confused with the MMS username) |
||||
|
Password |
A |
15 |
Yes |
The gateway account password |
||||
|
TransactionDetails |
Yes |
|||||||
|
MessageDetails |
Yes |
|||||||
|
PaymentLinkUID (attribute) |
A |
15 |
Yes |
The unique identifier issued when the PayByLink was created. |
||||
|
TransactionControl |
No |
|||||||
|
EchoCardType |
B |
5 |
No |
Instructs the Gateway to include the CardType results for the transaction in the message response. |
||||
|
EchoAVSCheckResult |
B |
5 |
No |
Instructs the Gateway to include the AVS Check results for the transaction in the message response. |
||||
|
EchoCV2CheckResult |
B |
5 |
No |
Instructs the Gateway to include the CV2 check results for the transaction in the message response. |
||||
|
EchoAmountReceived |
B |
5 |
No |
Instructs the Gateway to include the Amount Received for the transaction in the message response. |
||||
|
EchoExternalData |
B |
5 |
No |
Instructs the Gateway to include the External Data for the transaction in the message response. |
||||
|
EchoFraudProtectionCheckR esult |
B |
5 |
No |
Instructs the Gateway to include the Fraud Protection Check for the transaction in the message response. |
||||
|
EchoThreeDSecureAuthentic ationCheckResult |
B |
5 |
No |
Instructs the Gateway to include the ThreeDSecureAuthenticationC heckResult in the Data for the transaction in the message response. |
||||
|
EchoCardNumberFirstSix |
B |
5 |
No |
Instructs the Gateway to include the first six digits of the card number for the transaction in the message response. |
|
|
EchoCardNumberLastFour |
B |
5 |
No |
Instructs the Gateway to include the last four digits of the card number for the transaction in the message response. |
|
|
EchoCardExpiryDate |
B |
5 |
No |
Instructs the Gateway to include the card Expiry date month and year for the transaction in the message response. |
Response
Below are the details for the response that will be received after sending a PayByLink transaction request.
|
Tag/Attribute Name |
Data Type |
Max Length |
Always Present |
Comments |
|||
|
PayByLinkQueryResponse |
Yes |
||||||
|
PayByLinkQueryResult |
Yes |
||||||
|
StatusCode |
N |
– |
Yes |
This indicates the status of the query |
|||
|
Message |
A |
– |
Yes |
This gives a more detailed description ofthe status of the query |
|||
|
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) |
|||
|
PayByLinkQueryOutputData |
Yes |
||||||
|
Transactions |
No |
||||||
|
Transaction (multiple) |
No |
||||||
|
CrossReference (attribute) |
A |
25 |
Yes |
This is the unique cross reference for this transaction. 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 initial CardDetailsTransaction or CrossReference request message, this gives the unique cross reference of the transaction from the bank’s external system passed back to the Payment Gateway. |
|
|
ExternalClientReference (attribute) |
A |
– |
No |
If requested in the initial CardDetailsTransaction or CrossReference request message, this gives the unique client reference of the transaction from the bank’s external system passed back to the Payment Gateway. |
|
|
ExternalTransactionUID (attribute) |
A |
– |
No |
If requested in the initial CardDetailsTransaction or CrossReference request message, this gives the unique identifier of the transaction from the bank’s external system passed back to the Payment Gateway. |
|
|
StatusCode |
N |
– |
Yes |
This indicates the status of the transaction |
|
|
Message |
A |
– |
Yes |
This gives a more detailed description ofthe status of the transaction |
|
|
AuthCode |
A |
15 |
No |
If the transaction was successful, then the auth code is passed out here |
|
|
AddressNumericCheckResul t |
– |
– |
No |
If requested in the initial CardDetailsTransaction or CrossReferenceTransaction request message, this gives the results of the address numeric check – will be PASSED, FAILED, NOT_CHECKED or UNKNOWN |
|
|
PostCodeCheckResult |
– |
– |
No |
If requested in the initial CardDetailsTransaction or CrossReferenceTransaction request message, this gives the results of the post code check – will be PASSED, FAILED, NOT_CHECKED or UNKNOWN |
|
CV2CheckResult |
– |
– |
No |
If requested in the initial CardDetailsTransaction or CrossReferenceTransaction request message, this gives the results of the CV2check – will be PASSED, FAILED, NOT_CHECKED or UNKNOWN |
||||
|
ThreeDSecureAuthentication CheckResult |
– |
– |
No |
This gives the results of the 3D Secure authentication check – will be PASSED, FAILED or UNKNOWN |
||||
|
CardTypeData |
No |
|||||||
|
CardType |
A |
– |
Yes |
If requested in the initial CardDetailsTransaction or CrossReferenceTransaction 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 initial CardDetailsTransaction or CrossReferenceTransaction request message, this gives the amount that was passed to the gateway via the request message |
||||
|
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 |
||||