Transaction query service

This call allows 3DS Requestor to query the status of a transaction. This operation must be used by 3DS Requestor in case of problems receiving the CRes. We will return status, ECI and CAVV, which are necessary to proceed with an authorization.

Call details#

  • Recurso: /v2/transaction/{3DS Server Transaction Id}
  • HTTP Method: GET
  • HTTP Response OK: 200
  • Request format: there are no request parameters
  • Response format: JSON
  • Header parameters:
ParameterDescriptionFormatMandatory
merchant_idMerchant code on 3DS Server. The production and certification codes will be different.< 15 ANYES
merchant_keyMerchant authentication key on 3DS Server. The production and certification keys will be different.< 80 ANYES

Examples#

Below is an example of the transaction query service call using the cURL tool.

Request: To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br

curl
--request GET "https://mpi-homolog.softwareexpress.com.br/3ds-server/v2/transaction/123456789-aaaa-bbbb-cccc-ddddddddddd"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Response:

{
"three_ds_server": {
"trans_id": "12345678-1234-1234-1234-123456789012",
"status": "AUY"
},
"brand_id": "2",
"eci": "05",
"device_channel": "02",
"authentication": {
"value": "1234567890123456789012345678"
},
"message_version": "2.2.0"
}

Examples with challenge cancel#

Below is an example of the transaction query service call using challenge cancel in response

Requisição:

curl
--request GET "https://mpi-homolog.softwareexpress.com.br/3ds-server/v2/transaction/123456789-aaaa-bbbb-cccc-ddddddddddd"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
"three_ds_server": {
"trans_id": "12345678-1234-1234-1234-123456789012",
"status": "AUY"
},
"brand_id": "2",
"challenge_cancel": "01",
"eci": "05",
"device_channel": "02",
"authentication": {
"value": "1234567890123456789012345678"
},
"message_version": "2.2.0"
}

Response parameters#

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes the response parameters of the transaction query service:

ParameterDescriptionFormat
brand_idBrand ID< 4 N
eciElectronic Commerce Indicator< 2 N
device_channelDevice channel.
  • 01 = application (APP)
  • 02 = browser (BRW)
< 2 N
challenge_cancelIndicator that informs the ACS and DS that the authentication has been canceled.
  • 01 = The cardholder has initiated the cancellation.
  • 03 = Transaction expired. Decoupled flow
  • 04 = Transaction expired in the ACS
  • 05 = Transaction expired in the ACS. First CReq was not received by the ACS.
  • 06 = Error in the transaction.
  • 08 = Transaction expired in the 3DS SDK
  • 09 = Error message in response to the CRes message sent by the ACS.
  • 10 = Error message in response to the CReq message sent by the ACS.
= 2 AN
message_versionTransaction Version (This version must be used on CRes request)< 8 AN
three_ds_server
trans_id3DS Server ID transaction= 35 AN
status3DS Server Status. Learn more.= 3 AN
authentication
valueAuthentication value (CAVV)< 28 AN
error
codeError code. Learn more.< 3 N
componentIndicates which component identified the error.
  • C = 3DS SDK
  • S = 3DS Server
  • D = DS
  • A = ACS
= 1 AN
descriptionError description< 2048 AN
detailError details< 28 AN