Validar Pagamento com 3DS

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

Para validar uma transação com 3DS, é necessário enviar uma requisição utilizando o método POST para o endpoint /v1/payments/3ds/validate. Essa operação confirma a autenticação 3DS e finaliza o processo de validação do pagamento.

POST /v1/payments/3ds/validate

Via request Representational State Transfer (REST) com o body:

Requisição

  {
    "code3ds": "dbe5a61a-836d-45dd-82c1-52d0c5e3c010",  
    "validateToken": "eyJhbGciOiJIUzI1NiJ9[...]9oBbxbtuE_vuu6UzU-Mp5BjK2FNp5XAfoDy2uQ" 
  } 

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO	TAMANHO
code3ds	Código de autorização do 3DS.	guid	body	sim	255
validateToken	Token de validação gerado pelo 3DS ao retornar um desafio.	string	body	sim	256

🟢 200

Pagamento realizado com sucesso

{
  "paymentAuthorization":{  
    "returnCode":"0",  
    "description":"Sucesso",  
    "paymentId":"020006204409231653310000023790740000000000",  
    "authorizationCode":"026603",  
    "orderNumber":"3979908797721",  
    "amount":1111,  
    "releaseAt":"2020-09-23T16:53:34+00:00"  
  } 
}

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
returnCode	Código de retorno da transação.	string
description	Descrição do retorno da transação.	string
paymentId	Identificador da transação.	string
authorizationCode	Código de autorização da transação.	string
orderNumber	Número do pedido.	string
amount	Valor da transação.	decimal
releaseAt	Data e hora da transação.	datetime

🔴 400

Erro na requisição ou na validação do 3DS

[ 
    { 
        "tag": "3DS Fail", 
        "description": "eci: 00 - threeDsVersion: 2.1.0 - threeDsStatus: 
          AUTHENTICATION_SUCCESSFUL - veresEnrolled: U - directoryServerErrorCode: 203 - 
          directoryServerErrorDescription: Format of one or more elements is invalid according to 
          the specification threeDSRequestorURL," 
    } 
] 

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

[ 
    { 
        "tag": "", 
        "description": "Não foi possível executar comando. Erro desconhecido." 
    } 
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string