Método : POST
Endpoint : /api/v2/sellers/{sellerId}/orders/credit-card/three-d-secure/authorize
Este endpoint permite autorizar transações com cartão de crédito utilizando o protocolo 3DS 2.0 , garantindo maior segurança durante o processo de pagamento.
Parâmetro Descrição Tipo Obrigatório sellerIdIdentificador único do vendedor. Representa o vendedor que está criando a transação. stringSim
JSON
{
"mode":"DEBIT",
"notificationUrl":"http://google.com",
"installments":3,
"orderReference":"ORDER_001",
"value":1035,
"customer":{
"birthdate":"1992-02-29",
"document":"86548443292",
"name":"John Snow"
},
"card":{
"cvv":"123",
"holder":{
"document":"86548443292",
"name":"John Snow"
},
"expiration":{
"month":"01",
"year":"2028"
},
"brand":"VISA",
"cardNumber":"4918019199883839"
},
"threeDSecure":{
"ipAddress":"10.0.0.1",
"onFailure":"CONTINUE",
"successUrl":"https://meusite.com",
"userAgent":"Mozilla",
"device":{
"screenWidth":500,
"javaEnabled":true,
"deviceFingerprint":"",
"screenHeight":500,
"timeZoneOffset":3,
"deviceType3ds":"BROWSER",
"javascriptEnabled":true,
"language":"BR",
"colorDepth":1
},
"embedded":true,
"failureUrl":"https://meusite.com",
"billing":{
"address":{
"zipCode":"88137084",
"lineTwo":"Sala 101",
"streetNumber":"38",
"city":"Palhoça",
"street":"Rua Jair Hamms",
"neighborhood":"Pedra Branca",
"state":"SC"
},
"phone":{
"country":"BRAZIL",
"number":"988957195",
"areaCode":"11"
},
"email":"[email protected] "
}
}
}
Utilize os cartões abaixo para simular cenários de testes.
Cartão Cenário Modalidade 4918019199883839 Transação com desafio (Challenge). DEBIT 4918019160034602 Transação sem desafio (Frictionless). DEBIT
⚠️ No ambiente de Sandbox (homologação) utilize somente a o valor DEBITno atributo mode.
Campo Descrição Tipo Obrigatório Exemplo customer Dados do cliente. objectSim customer.name Nome do cliente. stringSim "Tony Stark" customer.document CPF/CNPJ do cliente. stringSim "51190844001" customer.birthdate Data de nascimento do cliente no formato YYYY-MM-DD. dateNão "2000-01-01" customer.phone Telefone do cliente. objectNão customer.phone.countryCode Código do país. integerSim 55 customer.phone.areaCode Código de área do telefone. integerSim 11 customer.phone.number Número de telefone. integerSim 999991234 customer.email Email do cliente. stringNão "[email protected] " customer.address Endereço do cliente. objectNão customer.address.street Logradouro do endereço. stringSim "Rua Jair Hamms" customer.address.streetNumber Número do endereço. stringSim "38" customer.address.lineTwo Complemento do endereço. stringNão "Sala 101" customer.address.neighborhood Bairro do endereço. stringSim "Pedra Branca" customer.address.city Cidade do endereço. stringSim "Palhoça" customer.address.state Estado do endereço (formato ISO 3166-2). stringSim "SC" customer.address.zipCode Código postal (CEP). stringSim "88137084" card Dados do cartão de crédito. objectSim card.cardNumber Número do cartão de crédito. stringSim "5448280000000007" card.cvv Código de segurança do cartão. stringNão "123" card.holder Dados do titular do cartão. objectSim card.holder.name Nome do titular do cartão. stringSim "Tony Stark" card.holder.document CPF/CNPJ do titular do cartão. stringNão "51190844001" card.expiration Validade do cartão. objectSim card.expiration.month Mês de validade do cartão no formato MM. integerSim 1 card.expiration.year Ano de validade do cartão no formato YYYY. integerSim 2035 value Valor da cobrança em centavos. integerSim 1000 installments Número de parcelas. integerSim 1 orderReference Referência externa única para o pedido. stringNão "Order-123456A" notificationUrl URL que receberá notificações do pedido. stringSim "https://meusite.com.br" threeDSecure Dados relacionados ao protocolo 3DS Secure. objectSim threeDSecure.device Informações do dispositivo do cliente. objectSim threeDSecure.device.colorDepth Profundidade de cor da tela do dispositivo. integerSim 1 threeDSecure.device.deviceType3ds Tipo de dispositivo para autenticação 3DS. stringSim "BROWSER" threeDSecure.device.javaEnabled Se o navegador do cliente suporta Java. booleanSim true threeDSecure.device.javascriptEnabled Se o navegador do cliente suporta JavaScript. booleanSim true threeDSecure.device.language Idioma do navegador do cliente. stringSim "BR" threeDSecure.device.screenHeight Altura da tela do dispositivo. integerSim 500 threeDSecure.device.screenWidth Largura da tela do dispositivo. integerSim 500 threeDSecure.device.timeZoneOffset Diferença de horas em relação ao UTC. integerSim 3 threeDSecure.ipAddress Endereço IPv4 do cliente. stringSim "10.0.0.1" threeDSecure.onFailure O que fazer em caso de falha no protocolo 3DS. stringSim "CONTINUE" threeDSecure.billing Informações de cobrança relacionadas ao cliente. objectSim threeDSecure.billing.address Endereço de cobrança do cliente. objectSim threeDSecure.billing.phone Telefone de cobrança do cliente. objectSim threeDSecure.billing.email Email de cobrança do cliente. stringSim "[email protected] " threeDSecure.successUrl URL de sucesso após autenticação 3DS. stringSim "https://meusite.com" threeDSecure.failureUrl URL de falha após autenticação 3DS. stringSim "https://meusite.com" threeDSecure.userAgent Agente ou navegador do cliente. stringSim "Mozilla" mode Modo de transação (DEBIT ou CREDIT). stringSim "DEBIT"
Http Status Descrição ✅ 201 O recurso da cobrança foi criado. ❌ 401 Não autorizado. Verifique o token da integração. ❌ 400 O request enviado está inválido ❌ 422 Não foi possível processar a requisição.