curl --request POST \
  --url https://nexus.ticto.com.br/api/v1/financial/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Client-Token: <api-key>' \
  --data '
{
  "offer_code": "O994032E5",
  "payment_method": "pix",
  "installments": 1,
  "customer": {
    "name": "João Silva",
    "email": "joao.silva@test.com",
    "document": "84742753003",
    "phone": "11987654321"
  },
  "customer_address": {
    "zip_code": "01310100",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil",
    "street": "Avenida Paulista",
    "street_number": "1578",
    "neighborhood": "Bela Vista",
    "complement": "Apto 101",
    "reference": "Próximo ao metrô"
  },
  "freight_value": 3462,
  "freight_method": "pac",
  "freight_type": "shipping_company",
  "freight_days": 8,
  "discount_amount": 0,
  "order_items": []
}
'

{
  "status": "success",
  "message": "Recurso criado com sucesso.",
  "data": {
    "hash": "TOP0412WJO18IY",
    "amount": 15000,
    "discount": 0,
    "installments": 1,
    "created_at": "04/12/2025 13:17:37",
    "freight": {
      "value": 3462,
      "type": "shipping_company",
      "method": "pac",
      "days": 8
    },
    "customer": {
      "name": "João Silva",
      "email": "joao.silva@test.com",
      "code": "7KCMDSUYJP1764715168",
      "public_token": "TIC-0cb5d556-fbab-4d0c-85d1-0bfc96f55e03"
    },
    "items": [
      {
        "type": "main",
        "amount": 15000,
        "status": "waiting_payment",
        "quantity": 1,
        "subtotal": 15000,
        "subtotal_discount": 0,
        "offer": {
          "name": "Physical Offer QA Updated",
          "code": "O994032E5",
          "type_of_charge": "one-time",
          "price": 15000
        }
      }
    ],
    "transaction": {
      "hash": "TPP3DBB0412WQ38AJY"
    },
    "payment": {
      "pix": {
        "qr_code": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/6f61fd6130c84867b16de368fd5670a25204000053039865802BR5921Ticto Tecnologia Ltda6008Campinas62070503***630462BB"
      }
    }
  }
}

Financeiro

Criar checkout

Cria um novo checkout para processamento de pagamento.

Campos obrigatórios:

offer_code - Código da oferta
payment_method - Método de pagamento (opcional quando a oferta principal é gratuita e não há bumps pagos)
installments - Número de parcelas (opcional nas mesmas condições de payment_method)
customer ou customer_code - Dados do cliente (objeto) ou código de cliente já existente
card_token ou card_code - Apenas quando payment_method for credit_card

Campos obrigatórios para produtos físicos:

freight_value - Valor do frete em centavos
freight_method - Método de envio (pac, sedex, by_producer)
freight_type - Tipo de frete (free, fixed, shipping_company)
customer_address - Endereço completo de entrega

Observações:

Para produtos digitais (course, ebook), os campos de frete e endereço não são necessários
Para produtos físicos, todos os campos de frete e endereço são obrigatórios
O formato canônico do endereço é customer_address (top-level). Compatível com customer_code sem enviar o objeto customer
O formato legado customer.address (aninhado) ainda é aceito e normalizado automaticamente para customer_address pelo Nexus
Quando ambos forem enviados, customer_address tem precedência
O campo freight_days é opcional, mas recomendado
Os campos complement e reference do endereço são opcionais, mas devem ser enviados explicitamente (mesmo que como null) quando o endereço estiver presente
Para produtos físicos com blocked_states configurado no frete da oferta, o checkout será recusado (HTTP 422) se o estado do endereço do cliente estiver na lista de estados bloqueados

POST

financial

checkout

curl --request POST \
  --url https://nexus.ticto.com.br/api/v1/financial/checkout \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Client-Token: <api-key>' \
  --data '
{
  "offer_code": "O994032E5",
  "payment_method": "pix",
  "installments": 1,
  "customer": {
    "name": "João Silva",
    "email": "joao.silva@test.com",
    "document": "84742753003",
    "phone": "11987654321"
  },
  "customer_address": {
    "zip_code": "01310100",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil",
    "street": "Avenida Paulista",
    "street_number": "1578",
    "neighborhood": "Bela Vista",
    "complement": "Apto 101",
    "reference": "Próximo ao metrô"
  },
  "freight_value": 3462,
  "freight_method": "pac",
  "freight_type": "shipping_company",
  "freight_days": 8,
  "discount_amount": 0,
  "order_items": []
}
'

{
  "status": "success",
  "message": "Recurso criado com sucesso.",
  "data": {
    "hash": "TOP0412WJO18IY",
    "amount": 15000,
    "discount": 0,
    "installments": 1,
    "created_at": "04/12/2025 13:17:37",
    "freight": {
      "value": 3462,
      "type": "shipping_company",
      "method": "pac",
      "days": 8
    },
    "customer": {
      "name": "João Silva",
      "email": "joao.silva@test.com",
      "code": "7KCMDSUYJP1764715168",
      "public_token": "TIC-0cb5d556-fbab-4d0c-85d1-0bfc96f55e03"
    },
    "items": [
      {
        "type": "main",
        "amount": 15000,
        "status": "waiting_payment",
        "quantity": 1,
        "subtotal": 15000,
        "subtotal_discount": 0,
        "offer": {
          "name": "Physical Offer QA Updated",
          "code": "O994032E5",
          "type_of_charge": "one-time",
          "price": 15000
        }
      }
    ],
    "transaction": {
      "hash": "TPP3DBB0412WQ38AJY"
    },
    "payment": {
      "pix": {
        "qr_code": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/6f61fd6130c84867b16de368fd5670a25204000053039865802BR5921Ticto Tecnologia Ltda6008Campinas62070503***630462BB"
      }
    }
  }
}

Authorizations

X-Api-Client-Token

string

header

required

Token de autenticação do cliente obtido via endpoint /auth

Body

application/json

Os campos payment_method e installments são obrigatórios exceto quando a oferta principal é gratuita (price = 0) e não há order bumps pagos.

offer_code

string

required

Código da oferta

customer

object

Show child attributes

customer_address

object

Endereço de entrega no formato canônico (top-level). Obrigatório para produtos físicos. Pode ser enviado junto com customer ou com customer_code. Quando customer.address (formato legado) também for enviado, este campo tem precedência.

Show child attributes

customer_code

string

Código do cliente (alternativa ao objeto customer)

card_token

string

Token do cartão (obrigatório para pagamento com cartão)

card_code

string

Código do cartão (alternativa ao card_token)

discount_amount

number

Valor do desconto

installments

integer

Número de parcelas

Required range: 1 <= x <= 12

payment_method

enum<string>

Método de pagamento.

pix_recurring (PIX Automático): exige oferta recorrente (type_of_charge=recurring) com allow_pix_recurring habilitado e o PIX Automático liberado para o produtor na Ticto (liberação feita pela Ticto, não disponível via API; ver allow_pix_recurring em Ofertas). Sem isso o checkout é recusado com 422. A resposta traz payment.pix_recurring.qr_code, que o pagador escaneia uma vez para autorizar o débito recorrente.

Available options:

credit_card,

pix,

bank_slip,

pix_recurring

freight_value

integer

Valor do frete em centavos (obrigatório para produtos físicos)

Required range: x >= 0

Example:

3462

freight_method

enum<string>

Método de envio (obrigatório para produtos físicos)

Available options:

pac,

sedex,

by_producer

Example:

"pac"

freight_type

enum<string>

Tipo de frete (obrigatório para produtos físicos)

Available options:

free,

fixed,

shipping_company

Example:

"shipping_company"

freight_days

integer

Prazo de entrega em dias úteis (opcional)

Required range: x >= 0

Example:

8

order_items

object[]

Itens adicionais do pedido (order bumps). Campo opcional.

Show child attributes

pid

string | null

Identificador do PID do checkout

pids

string[]

Lista de PIDs do checkout (valores distintos, máximo 2)

Required array length: 1 - 2 elements

fgpt_id

string | null

Identificador de fingerprint do checkout (rastreamento anti-fraude)

Response

Checkout criado com sucesso

items

object[]

required

Lista de itens do checkout

Show child attributes

hash

string

Hash do checkout

amount

integer

Valor total do checkout em centavos

Required range: 0 <= x <= 99999999

discount

integer

Valor do desconto aplicado em centavos

Required range: 0 <= x <= 99999999

installments

integer

Número de parcelas

Required range: 1 <= x <= 36

platform_fee

integer | null

Taxa percentual da plataforma em centavos (pode ser null)

platform_fixed_fee

integer | null

Taxa fixa da plataforma em centavos (pode ser null)

created_at

string | null

Data de criação (formato dd/mm/aaaa HH:MM:SS)

Example:

"04/12/2025 13:17:37"

freight

object

Informações de frete (presente apenas para produtos físicos, pode ser null para produtos digitais)

Show child attributes

customer

object

Show child attributes

transaction

object | null

Dados da transação

Show child attributes

payment

object

Show child attributes

customer_address

object

Endereço de entrega persistido no checkout (presente quando um endereço foi enviado na requisição, em qualquer formato aceito)

Show child attributes

comissions

any | null

Comissões da venda (presente apenas quando aplicável). Observação: a chave é retornada com a grafia comissions.

subscription

object

Informações da assinatura

Show child attributes

Autenticação

Configurações do Cliente

Usuários

Onboarding de usuário

Contas Bancárias

Faixas de Taxa

Frete

Financeiro

PIX Automático

Produtos

Integrações

Webhooks: Usuários

Webhooks: Contas Bancárias

Webhooks: Produtos e Ofertas

Webhooks: Financeiro

Webhooks: Faixas de Taxa

Webhooks: Pedidos

Webhooks: Cobranças

Webhooks: Assinaturas

Criar checkout

Authorizations

Body

Response