1. Transactions
1.0.0
  • 1.0.0
  • 1.1.0
Default module
  • Default module
  • Teste
  • Overview
  • Webhooks
  • Error codes
  • Ambiente de Testes
  • Transactions
    • Criar uma Transação
      POST
    • Criar uma Transação Com 3DS
      POST
    • Criar uma Transação PIX
      POST
    • Criar uma Transação Boleto
      POST
    • Criar uma Transação Débito
      POST
    • Criar uma Transação - Split
      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
    • Obter Bandeira
    • Buscar Cartão
    • Listar Cartões
  • Simulate
    • Tax
  • Split
    • Receivers
      • Criando um recebedor
      • Atualizando um recebedor
      • Retornar um recebedor
      • Retornar recebedores
      • Deletar um recebedor
    • Receiver Bank Accounts
      • Criar banco para um recebedor
      • Retornar contas de um recebedor
      • Retornar conta de um recebedor por id da conta bancária
      • Deletar uma conta bancária de um recebedor
      • Atualizar o status da conta bancária de um recebedor
  • Recurrence
    • Prices
      • Criar novo preço
      • visualizar os preços de um plano
      • visualizar os preços de um plano Copy
      • Atualizar preço
      • Deletar preço
    • Plans
      • Criar um Plano
      • Atualizar Um Plano
      • Listar Planos
      • Buscar um Plano
      • Deletar um Plano
    • Subscriptions
      • Criar uma Assinatura (IDs)
      • Criar uma Assinatura (Sem IDs)
      • Atualizar uma Assinatura
      • Buscar uma Assinatura
      • Buscar Assinaturas
      • Cancelar uma Assinatura
      • Deletar uma Assinatura
  • Webhook
    • Criar um webhook
    • Atualizar Webhook
    • Retornar Webhooks Cadastrados
    • Retornar um Webhook
    • Remover um Webhook
  • Configuration
    • Adding Acquirers
    • Setting Main Acquirer
    • Configuring Anti Fraud
  • Esquemas
    • Teste 3
  1. Transactions

Criar uma Transação Débito

POST
/v1/transactions
Última modificação:2026-03-31 17:24:26
13988aef-94d3-4635-a613-584b7575c2eb.jfif

Requisição

Parâmetros Bodyapplication/json

Exemplo
{
    "amount": 1500,
    "async": false,
    "capture": true,
    "installments": 1,
    "descriptor": "testpostman",
    "payment_method": "debit_card",
    "card": {
        "card_number": "5502091556851234",
        "card_holder_name": "Luke Skywalker",
        "card_expiration_date": "0333",
        "card_cvv": "111"
    },
    "threeDSecure": {
        "provider" : "ugo",
        "urlFail": "https://www.threeDSecure.com.br/?threeDSecure=fail",
        "urlSuccess": "https://www.threeDSecure.com.br/?threeDSecure=success",
        "onFailure": "decline",
        "userAgent": "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405",
        "ipAddress": "192.168.130.20",
        "device": {
            "colorDepth": 1,
            "deviceType3ds": "BROWSER",
            "javaEnabled": false,
            "language": "BR",
            "screenHeight": 500,
            "screenWidth": 500,
            "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
        }
    ]
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://prod.your-api-server.com/v1/transactions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1500,
    "async": false,
    "capture": true,
    "installments": 1,
    "descriptor": "testpostman",
    "payment_method": "debit_card",
    "card": {
        "card_number": "5502091556851234",
        "card_holder_name": "Luke Skywalker",
        "card_expiration_date": "0333",
        "card_cvv": "111"
    },
    "threeDSecure": {
        "provider" : "ugo",
        "urlFail": "https://www.threeDSecure.com.br/?threeDSecure=fail",
        "urlSuccess": "https://www.threeDSecure.com.br/?threeDSecure=success",
        "onFailure": "decline",
        "userAgent": "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405",
        "ipAddress": "192.168.130.20",
        "device": {
            "colorDepth": 1,
            "deviceType3ds": "BROWSER",
            "javaEnabled": false,
            "language": "BR",
            "screenHeight": 500,
            "screenWidth": 500,
            "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
        }
    ]
}'

Respostas

🟢200Criar uma Transação
application/json
Body

Exemplo
{
    "id": 1160552,
    "ip_address": "191.232.180.254",
    "installments": 1,
    "tid": null,
    "nsu": null,
    "authorization_code": null,
    "amount": 100,
    "capture_amount": 100,
    "paid_amount": null,
    "refund_amount": null,
    "payment_method": "debit_card",
    "ref_id": "H2RMXRL6T6",
    "status": "request_authentication",
    "created_at": "2024-05-17T21:18:47.000000Z",
    "updated_at": "2024-05-17T21:18:48.000000Z",
    "card": {
        "card_id": 1542470679,
        "card_holder_name": "Lucas Nalon",
        "created_at": "2024-05-17T21:18:46.000000Z",
        "updated_at": "2024-05-17T21:18:46.000000Z",
        "card_first_digits": "520048",
        "card_last_digits": "9887",
        "brand": "mastercard"
    },
    "pix_qr_code": null,
    "pix_expiration_date": null,
    "pix_additional_fields": null,
    "boleto": {
        "barcode_line": null,
        "code": null
    },
    "split_rules": [],
    "customer": {
        "id": 1383269,
        "external_id": "6564",
        "name": "Fulano Nogue",
        "email": "fulano2nogue@email.com",
        "type": "individual",
        "country": "BR",
        "phone_numbers": null,
        "documents": [
            {
                "id": 696424,
                "type": "cpf",
                "number": "30267903030"
            }
        ],
        "birthday": null,
        "created_at": "2024-05-17T21:18:46.000000Z",
        "updated_at": "2024-05-17T21:18:46.000000Z"
    },
    "billing": {
        "id": 311297,
        "name": "Brasil Cash",
        "created_at": "2024-05-17T21:18:47.000000Z",
        "updated_at": "2024-05-17T21:18:47.000000Z",
        "address": {
            "street": "Rua 12 de Outubro",
            "street_number": "220",
            "zipcode": "16520970",
            "country": "br",
            "state": "SP",
            "city": "Bacuriti",
            "neighborhood": "Centro",
            "complementary": null
        }
    },
    "shipping": null,
    "items": [
        {
            "id": 342584,
            "external_id": "5550134",
            "title": "Sabonete de Luxo",
            "unit_price": 10000,
            "quantity": 1,
            "tangible": 1,
            "category": null,
            "venue": null,
            "date": null,
            "created_at": "2024-05-17T21:18:47.000000Z",
            "updated_at": "2024-05-17T21:18:47.000000Z"
        },
        {
            "id": 342585,
            "external_id": "5550134",
            "title": "Sabonete de Luxo",
            "unit_price": 10000,
            "quantity": 1,
            "tangible": 0,
            "category": null,
            "venue": null,
            "date": null,
            "created_at": "2024-05-17T21:18:47.000000Z",
            "updated_at": "2024-05-17T21:18:47.000000Z"
        }
    ],
    "metadata": null,
    "refused_reason": null,
    "amount_fee": null,
    "descriptor": "descapi",
    "threeDSecure": {
        "url": "https://threeDSecure.com.br/processor/redirect/waBD%2b5zSsrXd26dUQc7DfU9mU8mrpA4q8VwvYFM3MENUCTMQw7Eg2GtdXizHMF2QKoJdC6cXXUUdCsGM2KCAqqMLrlEehGkCPCMOKx%2fTn9c0T7iKxpxi6208IuQl54XI2lYMpMU2HqvYCrfWq8QlmLhf0aKsbwN9x3qqNPRPhii0lpIco1YX%2fbqqsz9Z0%2bQexyQqT6R7JYpXliM%2b61oJhqDA%3d"
    }
}
🟠400Erro integração
Modificado em 2026-03-31 17:24:26
Página anterior
Criar uma Transação Boleto
Próxima página
Criar uma Transação - Split
Built with