Documentação
  1. GESTÃO DE TRANSAÇÕES
  2. Smart checkout

Criar smart checkout

A criação do smart checkout é o primeiro passo para iniciar o fluxo. Nessa etapa, o parceiro envia à Paytime todas as informações necessárias para gerar uma experiência de pagamento pronta para uso.

Após a criação, a API retorna um checkout_token, que deve ser utilizado para renderizar o checkout nos canais suportados, como Web, iFrame, entre outros.


🔼

POST urlServidor/v1/marketplace/checkout

Importante: substitua urlServidor pela URL do seu ambiente (produção ou homologação).


Parâmetros da requisição

Header

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração fornecida pela Paytime.
x-tokenstringSimToken de autenticação. Pode ser encontrado em nosso portal na guia de integração.
AuthorizationAuth Type Bearer TokenSimToken gerado na rota de autenticação.
establishment_idstringSimID do estabelecimento.

Exemplo de header da requisição

curl--request POST \
--location 'urlServidor/v1/marketplace/checkout' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'establishment_id;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearer_token}}' \

Body

🔹 Dados principais

CampoTipoObrigatórioDescrição
titlestringSimDescrição do smart checkout (máx. 100 caracteres).
amountnumberSimValor, em centavos.

👤 Objeto cliente (client)

CampoTipoObrigatórioDescrição
first_namestringSimNome ou razão social.
last_namestringNãoSobrenome ou nome fantasia.
emailstringSimE-mail do cliente.
documentstringSimCPF ou CNPJ.
phonestringNãoTelefone.
addressobjectNãoEndereço do cliente.
Objeto endereço (address)

Campos condicionais — obrigatórios caso o objeto seja informado:

  • city, state, zip_code, street, number, neighborhood
  • complement (opcional)

💳 Configuração de pagamento (payment_order)

CampoTipoDescrição
payment_type_allowedarrayMétodos aceitos: CREDIT PIX GOOGLEPAY APPLEPAY BANK_SLIP
max_number_installmentsnumberNúmero máximo de parcelas.
pix_expiration_intervalnumberTempo de expiração do PIX (em minutos).
discountsarrayDescontos por método de pagamento.
Descontos (discounts)
CampoTipoDescrição
methodstringMétodo de pagamento.
valuenumberValor do desconto.
typestringPERCENTAGE ou CURRENCY

Boleto (billet)

Para detalhes do objeto billet consulte Criar transação Boleto


🎨 Personalização (theme)

CampoTipoDescrição
mainstringCor principal.
secondarystringCor secundária.
logo_urlstringURL do logotipo.
Formato: .PNG
Tamanho: 145 x 36 pixels
favicon_urlstringURL do favicon.
Formato: .PNG
Tamanho: 48 x 48 pixels
wallet_icon_urlstringURL do ícone nas wallets (quando aplicável).
Formato: .PNG
Tamanho: 180 x 180 pixels
font_familystringTipo de fonte do checkout.
Valores aceitos: roboto poppins sf-pro-text
card_border_radiusnumberArredondamento dos cards.
Valores aceitos: de 0 a 2
button_border_radiusnumberArredondamento dos botões.
Valores aceitos: de 0 a 2

⚙️ Configurações adicionais

CampoTipoDescrição
durationnumberTempo de duração do smart checkout (minutos). Caso não seja informado, a duração será de 24h.
reference_idstringIdentificador definido pelo cliente para rastreamento interno. Esse campo, quando preenchido, será enviado no payload da transação.
intereststring
  • CLIENT: as taxas são repassadas ao comprador, resultando no aumento do valor bruto da transação.
  • STORE: as taxas são cobradas do estabelecimento, mantendo inalterado o valor bruto da transação.
brand_planstringBandeira utilizada para calcular as taxas quando o interest for CLIENT. Permitido: MASTERCARD,VISA,ELO,OTHERS
multiple_paymentsboleanoPermite definir se o smart checkout aceitará múltiplos pagamentos durante sua validade.
  • Quando false, é encerrado automaticamente após a confirmação do primeiro pagamento.
  • Quando true, permanece ativo e pode receber múltiplos pagamentos até o momento de sua expiração.


📥 Exemplo do body da requisição

{
  "title": "Pedido #123",
  "amount": 15000,
  "client": {
    "first_name": "Joao Desenvolvedor",
    "last_name": "Desenvolvedor",
    "document": "46238585021",
    "phone": "27990020000",
    "email": "[email protected]",
    "address": {
      "street": "Nazaré",
      "number": "110",
      "neighborhood": "Centro",
      "city": "São Luís",
      "state": "MA",
      "zip_code": "65010410"
    }
  },
  "payment_order": {
    "payment_type_allowed": ["CREDIT", "PIX"],
    "max_number_installments": 12
  },
  "multiple_payments": false,
  "reference_id": "PED-123",
  "interest": "CLIENT"
}

📤 Modelo da resposta

{
    "_id": "69f66a81e77609f30dcce49e",
    "checkout_token": "0ec49a17-2459-4729-a420-e064523f713f"
}

📊 Campos da resposta

CampoTipoDescrição
_idstringID do smart checkout.
checkout_tokenstringToken para ser utilizado na URL do smart checkout.

Observações importantes

  • O checkout_token deve ser tratado como identificador do smart checkout e utilizado apenas para renderização do checkout.
  • A confirmação final do pagamento deve ser baseada nos eventos recebidos via webhook, e não apenas no redirecionamento do usuário.

Códigos de resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.

Updated about 1 month ago

Did this page help you?