Serviço de consulta de transação
import ApiDoc from '../../src/components/api-doc/ApiDoc';
Essa chamada permite que o 3DS Requestor consulte o status de uma transação. Essa operação deve ser usada pelo 3DS Requestor caso haja problemas no recebimento do CRes. Retornaremos status, ECI e CAVV, ou seja, o que é necessário para prosseguir com uma autorização.
Detalhes da chamada
<ApiDoc method="get" path="/v2/transaction/{trans_id}" apiFile="3DS.yaml" />
- Recurso:
/v2/transaction/{ID da transação 3DS Server} - Método HTTP:
GET - Resposta HTTP OK:
200 - Formato da requisição: não há parâmetros de requisição
- Formato da resposta:
JSON - Parâmetros de cabeçalho:
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
merchant_id | Código da loja no 3DS Server. Os códigos de produção e certificação serão diferentes. | < 15 AN | SIM |
merchant_key | Chave de autenticação da loja no 3DS Server. As chaves de produção e certificação serão diferentes. | < 80 AN | SIM |
Para informações sobre a futura v3, veja Quick Start.
Exemplos
Abaixo estão alguns exemplos de chamada do serviço de consulta utilizando a ferramenta cURL.
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",
"eci": "05",
"device_channel": "02",
"authentication": {
"value": "1234567890123456789012345678"
},
"message_version": "2.2.0"
}
Exemplo com cancelamento de challenge
Abaixo está um exemplo utilizando challenge cancel na resposta
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"
}
Parâmetros de resposta
Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de consulta de transações:
| Parâmetro | Descrição | Formato |
|---|---|---|
brand_id | ID da bandeira | < 4 N |
eci | Indicador de comércio eletrônico | < 2 N |
device_channel | Canal do dispositivo.
| < 2 N |
challenge_cancel | Indicador que informa ao ACS e DS que a autenticação foi cancelada.
| = 2 AN |
message_version | Versão utilizada na transação (essa versão deve ser utilizada na requisição do CRes) | < 8 AN |
| three_ds_server | ||
trans_id | ID da transação 3DS Server | = 35 AN |
status | Status no 3DS Server. Saiba mais. | = 3 AN |
| authentication | ||
value | Valor da autenticação (CAVV) | < 28 AN |
| error | ||
code | Código do erro. Saiba mais. | < 3 N |
component | Indica qual componente identificou o erro.
| = 1 AN |
description | Descrição do erro | < 2048 AN |
detail | Detalhamento do erro | < 28 AN |