Skip to main content
POST
Transações de Pagamento

Transações de Pagamento

Este endpoint unificado permite criar transações utilizando diferentes métodos de pagamento. A mesma rota é usada tanto para cartão de crédito quanto para PIX, diferenciando-se apenas pelo valor do campo paymentMethod e seus parâmetros específicos.

Autenticação

Este endpoint utiliza autenticação via Basic Auth:

Parâmetros Comuns da Requisição

paymentMethod
string
required
Método de pagamento (“credit_card” ou “pix”)
amount
integer
required
Valor total em centavos
customer
object
required
Dados do cliente
customer.name
string
required
Nome completo do cliente
customer.email
string
required
Email do cliente
customer.phone
string
required
Telefone do cliente
customer.document.type
string
required
Tipo do documento (cpf ou cnpj)
customer.document.number
string
required
Número do documento
externalRef
string
required
Referência externa para identificação da transação
postbackUrl
string
required
URL para receber notificações de alteração de status
traceable
boolean
required
Se a transação é rastreável
items
array
required
Lista de itens do pedido
ip
string
required
Endereço IP do cliente
metadata
string
required
Dados adicionais em formato JSON string

Parâmetros para Cartão de Crédito

paymentMethod
string
required
Deve ser “credit_card”
installments
string
required
Número de parcelas
card.hash
string
required
Token do cartão gerado previamente

Parâmetros para PIX

paymentMethod
string
required
Deve ser “pix”
pix.expiresInDays
integer
required
Dias para expiração do PIX

Exemplos de Requisição

Exemplos de Resposta

Exemplo com cURL

Status de Transação

Códigos de Resposta

  • 201 - Transação criada com sucesso
  • 401 - Erro de autenticação
  • 400 - Dados inválidos

Observações

  • Para cartão de crédito, é necessário tokenizar o cartão previamente usando o endpoint /card-token.
  • Para PIX, o QR Code é enviado no formato base64 e pode ser exibido diretamente em uma tag de imagem HTML.
  • Utilize o webhook (postbackUrl) para receber notificações automáticas quando o status da transação mudar.