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:
Parameter | Description | Format | Mandatory |
---|---|---|---|
merchant_id | Merchant code on 3DS Server. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on 3DS Server. The production and certification keys will be different. | < 80 AN | YES |
Examples
Below is an example of the transaction query service call using the cURL tool.
Request:
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"
}
}
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:
Parameter | Description | Format |
---|---|---|
brand_id | Brand ID | < 4 N |
eci | Electronic Commerce Indicator | < 2 N |
device_channel | Device channel.
| < 2 N |
three_ds_server | ||
trans_id | 3DS Server ID transaction | = 35 AN |
status | 3DS Server Status. Learn more. | = 3 AN |
authentication | ||
value | Authentication value (CAVV) | < 28 AN |
error | ||
code | Error code. Learn more. | < 3 N |
component | Indicates which component identified the error.
| = 1 AN |
description | Error description | < 2048 AN |
detail | Error details | < 28 AN |