Valut Gateway
  1. Transactions
Valut Gateway
  • Overview
  • Webhooks
  • Error codes
  • Transactions
    • Criar uma Transação
      POST
    • Criar uma Transação Com 3DS
      POST
    • Criar uma Transação PIX
      POST
    • Estornar uma transação
      POST
    • Capturando uma Transação
      POST
    • Buscar Transação
      GET
    • Listar Transações
      GET
    • Retornar Histórico de uma Transação
      GET
    • Retornar Parcelas de uma transação
      GET
  • Payment Links
    • Criar Link
      POST
    • Atualizar Link
      PUT
    • Buscar Link
      GET
    • Listar Links
      GET
    • Transações de um link
      GET
  • Customer
    • Criar Cliente
      POST
    • Encontrar Cliente
      POST
    • Cartões do Cliente
      POST
    • Atualizar Cliente
      PUT
    • Buscar Cliente
      GET
    • Listar Clientes
      GET
    • Deletar um cliente
      DELETE
  • Cards
    • Criar Cartão
      POST
    • Obter Bandeira
      POST
    • Buscar Cartão
      GET
    • Listar Cartões
      GET
  • Webhook
    • Criar um webhook
    • Atualizar Webhook
    • Retornar Webhooks Cadastrados
    • Retornar um Webhook
    • Remover um Webhook
  • Simulate
    • Tax
  1. Transactions

Criar uma Transação Com 3DS

POST
/v1/transactions

3DS 2.0 - Autenticação Segura de Transações#

Nossa plataforma oferece a tecnologia 3DS 2.0 integrada, proporcionando maior segurança nas transações de crédito online. Para utilizar este recurso, inclua o objeto "ThreeDSecure" no corpo da requisição de autorização da transação.
Com o 3DS 2.0, as transações de crédito são autenticadas de forma segura, seguindo o fluxo abaixo:
1.
O portador do cartão insere os dados do cartão.
2.
O estabelecimento solicita a autenticação.
3.
A plataforma solicita a autenticação 3DS 2.0 à bandeira do cartão.
4.
A bandeira realiza a análise de risco.
5.
A bandeira retorna a URL de autenticação para a plataforma.
6.
A plataforma retorna a URL de autenticação para o estabelecimento.
7.
O estabelecimento apresenta a URL de autenticação ao portador.
8.
O portador visualiza a tela de autenticação.
9.
O portador realiza a autenticação (desafio).
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/transactions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1500,
    "async": false,
    "capture": false,
    "installments": 1,
    "descriptor": "testpostman",
    "payment_method": "credit_card",
    "card": {
        "card_number": "5502091556851234",
        "card_holder_name": "Luke Skywalker",
        "card_expiration_date": "0333",
        "card_cvv": "111"
    },
    "threeDSecure": {
        "urlSuccess": "https://webhook.site/3b161386-94f6-448d-a770-89141e5f58c4",
        "urlFail": "https://webhook.site/098a2406-c69e-49ce-875a-5d36404e2c21",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36",
        "ipAddress": "45.6.35.42",
        "device": {
            "colorDepth": "1",
            "deviceType3ds": "browser",
            "javaEnabled": true,
            "language": "br",
            "screenHeight": 900,
            "screenWidth": 600,
            "timeZoneOffset": -3
        }
    },
    "billing": {
        "name": "Tatooine",
        "address": {
            "country": "br",
            "street": "Rua 12 de Outubro",
            "street_number": "220",
            "zipcode": "16520970",
            "state": "SP",
            "city": "Bacuriti",
            "neighborhood": "Centro"
        }
    },
    "customer": {
        "name": "Luke Skywalker",
        "email": "luke@skywalker.com",
        "type": "individual",
        "country": "BR",
        "external_id": "6564",
        "documents": [
            {
                "type": "CPF",
                "number": "01234567890"
            }
        ],
        "phone_numbers": [
            "+5511916621234"
        ]
    },
    "items": [
        {
            "external_id": "5550134",
            "title": "Sabonete de Luxo",
            "unit_price": 10000,
            "quantity": 1,
            "tangible": true
        },
        {
            "external_id": "5550134",
            "title": "Sabonete de Luxo",
            "unit_price": 10000,
            "quantity": 1,
            "tangible": false
        }
    ]
}'
Response Response Example
200 - Criar uma Transação
{
    "id": 23,
    "ip_address": "127.0.0.1",
    "tid": null,
    "amount": 15090,
    "capture_amount": 15090,
    "paid_amount": null,
    "ref_id": "5992873329",
    "status": "processing",
    "created_at": "2022-02-02T18:05:37.000000Z",
    "updated_at": "2022-02-02T18:05:37.000000Z",
    "card": {
        "card_id": 409902444,
        "card_holder_name": "Customer Name",
        "created_at": "2022-02-02T17:47:10.000000Z",
        "updated_at": "2022-02-02T18:05:36.000000Z",
        "card_first_digits": "0000",
        "card_last_digits": "0009",
        "brand": "0"
    },
    "installments": 1,
    "reference_key": null,
    "session": null,
    "local_time": null,
    "payment_method": "credit_card",
    "customer": {
        "id": 4642,
        "external_id": "1234f",
        "name": "James Bond",
        "type": "individual",
        "country": "br",
        "email": "james@bond.com",
        "birthday": null,
        "phone_numbers": [
            "+5511987654321"
        ],
        "created_at": "2022-02-02T18:05:37.000000Z",
        "updated_at": "2022-02-02T18:05:37.000000Z",
        "documents": [
            {
                "id": 4563,
                "type": "cpf",
                "number": "47009616000"
            }
        ]
    },
    "billing": {
        "id": 4418,
        "name": "Nome do pagador",
        "created_at": "2022-02-02T18:05:37.000000Z",
        "updated_at": "2022-02-02T18:05:37.000000Z",
        "address": {
            "street": "Alamenda Rio Negro",
            "street_number": "500",
            "zipcode": "06454000",
            "country": "br",
            "state": "sp",
            "city": "barueri",
            "neighborhood": "Alphaville",
            "complementary": null
        }
    },
    "items": [
        {
            "id": 8912,
            "external_id": "123",
            "title": "Nome do Produto 1",
            "unit_price": 1590,
            "quantity": 1,
            "tangible": 1,
            "category": null,
            "venue": null,
            "date": null,
            "created_at": "2022-02-02T18:05:37.000000Z",
            "updated_at": "2022-02-02T18:05:37.000000Z"
        }
    ],
    "threeDSecure": {
        "url": "https://api.sandbox-userede.com.br/erede/redirect/auth?token=ge%2bWZOLO342fawASD8jasdmjwqe%ndnuqwneqiU32cI609RVSc%3d"
    },
    "metadata": null
}

Requisição

Parâmetros Bodyapplication/json
amount
integer 
requerido
Valor da Transação. Deve ser passado em centavos Ex: R$ 190,90 = 19090. mínimo 1 real (100)
async
boolean 
requerido
Utilize false caso queira manter o processamento síncrono de uma transação. Ou seja, a resposta da transação é recebida na hora.
capture
boolean 
requerido
Após a autorização de uma transação, você pode escolher se irá capturar ou adiar a captura do valor. Caso opte por postergar a captura, atribua o valor false
installments
integer 
requerido
Somente se payment_method for credit_card. Número de parcelas da transação, sendo mínimo: 1 e Máximo: 21.
descriptor
string 
requerido
Descrição que aparecerá na fatura depois do nome de sua empresa. Máximo de 13 caracteres, somente letras sem espaço.
payment_method
string 
requerido
Método de pagamento da transação. 3DS aceita apenas Cartão de Crédito.
card
object 
requerido
Apenas para transações de Cartão de crédito e caso o card_id não seja informado.
card_number
string 
requerido
Número do cartão
card_holder_name
string 
requerido
Nome do portador do cartão
card_expiration_date
string 
requerido
Data de validade do cartão no formato MMYY
card_cvv
string 
requerido
Código verificador do cartão
threeDSecure
object 
requerido
Para transações com autenticação 3DS 2.0 enviar este objeto na requisição
urlFail
string 
requerido
URL para redirecionamento do comprador em caso de falha na autenticação.
urlSuccess
string 
requerido
URL para redirecionamento do comprador em caso de sucesso na autenticação.
onFailure
string 
requerido
Sempre enviar o valor 'decline'.
userAgent
string 
requerido
Identificador do navegador utilizado pelo comprador no momento da compra.
ipAddress
string 
requerido
Endereço IP do comprador. Suporta apenas IPv4. Exemplo: 10.0.0.1.
device
object 
requerido
Dispositivo
billing
object 
requerido
Endereço de cobrança do cliente. O campo billing é obrigatório para todas as transações de cartão de crédito com antifraude habilitado.
name
string 
requerido
Nome do Cliente
address
object 
requerido
Detalhamento do endereço do cliente.
customer
object 
requerido
Obrigatório com o antifraude habilitado. Define os dados do comprador, como nome, email, telefone e data de nascimento
name
string 
requerido
Nome
email
string 
requerido
E-mail
type
string 
requerido
Tipo
country
string 
requerido
País
external_id
string 
requerido
ID Externo
documents
array [object {2}] 
requerido
Documentos
phone_numbers
array[string]
requerido
Número de telefone
items
array [object {5}] 
requerido
Itens
external_id
string 
requerido
ID Externo
title
string 
requerido
Título do Produto
unit_price
integer 
requerido
Preço unitário
quantity
integer 
requerido
Quantidade
tangible
boolean 
requerido
Tangível
Examples

Respostas

🟢200Criar uma Transação
application/json
Body
id
integer 
requerido
ID da Transação
ip_address
string 
requerido
Endereço de IP
tid
null 
requerido
amount
integer 
requerido
Valor da Transação. Valor apresentado em centavos Ex: R$ 190,90 = 19090.
capture_amount
integer 
requerido
Valor da transação capturado
paid_amount
null 
requerido
Valor pago
ref_id
string 
requerido
ID de Referencia
status
string 
requerido
Status da transação
created_at
string 
requerido
Data de criação
updated_at
string 
requerido
Ultima atualização
card
object 
requerido
Cartão
card_id
integer 
requerido
ID do Cartão
card_holder_name
string 
requerido
Nome do portador
created_at
string 
requerido
Data de cadastro
updated_at
string 
requerido
Última atualização
card_first_digits
string 
requerido
Primeiros dígitos do cartão
card_last_digits
string 
requerido
Últimos dígitos do cartão
brand
string 
requerido
Bandeira
pix_qr_code
null 
requerido
QR Code para pix
pix_expiration_date
null 
requerido
Data de expiração do QRCode
pix_additional_fields
null 
requerido
Campos adicionais do Pix
installments
integer 
requerido
Parcelas
reference_key
null 
requerido
Chave de referencia
session
null 
requerido
Sessão
local_time
null 
requerido
Horário local
payment_method
string 
requerido
Método de pagamento
customer
object 
requerido
Cliente
id
integer 
requerido
ID do Cliente
external_id
string 
requerido
ID Externo
name
string 
requerido
Nome
type
string 
requerido
Tipo
country
string 
requerido
País
email
string 
requerido
E-mail
birthday
null 
requerido
Aniversário
phone_numbers
array[string]
requerido
Número de telefone
created_at
string 
requerido
Data de cadastro
updated_at
string 
requerido
Última atualização
documents
array [object {3}] 
requerido
Documentos
billing
object 
requerido
Endereço de cobrança do cliente. O campo billing é obrigatório para todas as transações de cartão de crédito com antifraude habilitado.
id
integer 
requerido
ID do endereço de cobrança
name
string 
requerido
Nome do Cliente
created_at
string 
requerido
Data de cadastro
updated_at
string 
requerido
Última atuaalização
address
object 
requerido
Endereço
items
array [object {11}] 
requerido
Itens
id
integer 
opcional
ID do Item
external_id
string 
opcional
ID Externo
title
string 
opcional
Título do produto
unit_price
integer 
opcional
Preço unitário
quantity
integer 
opcional
Quantidade
tangible
integer 
opcional
Tangível
category
null 
opcional
Categoria
venue
null 
opcional
date
null 
opcional
Data
created_at
string 
opcional
Data de cadastro
updated_at
string 
opcional
Última atualização
threeDSecure
object 
requerido
3DS
url
string 
requerido
URL para desafio do 3DS
metadata
null 
requerido
🟠400Erro integração
Modificado em 2025-05-26 19:09:20
Página anterior
Criar uma Transação
Próxima página
Criar uma Transação PIX
Built with