Métodos de Pagamento

Esta página documenta todos os métodos de pagamento que podem aparecer nos eventos da plataforma.

Tipos de Métodos de Pagamento

Tipo	Descrição
`credit_card`	Cartão de crédito
`debit_card`	Cartão de débito
`pix`	PIX
`boleto`	Boleto bancário
`cash`	Dinheiro
`voucher`	Voucher
`deposit`	Depósito bancário
`cheque`	Cheque

CreditCard

{
  "type": "credit_card",
  "brand": "visa",
  "last_digits": "1234",
  "expiration_month": "12",
  "expiration_year": "2028"
}

Campo	Tipo	Descrição
`type`	string	Sempre `credit_card`
`brand`	string \| null	Bandeira do cartão
`last_digits`	string \| null	Últimos 4 dígitos
`expiration_month`	string \| null	Mês de expiração
`expiration_year`	string \| null	Ano de expiração

DebitCard

{
  "type": "debit_card",
  "brand": "visa",
  "last_digits": "5678",
  "expiration_month": "6",
  "expiration_year": "2027"
}

Campo	Tipo	Descrição
`type`	string	Sempre `debit_card`
`brand`	string \| null	Bandeira do cartão
`last_digits`	string \| null	Últimos 4 dígitos
`expiration_month`	string \| null	Mês de expiração
`expiration_year`	string \| null	Ano de expiração

Pix

{
  "type": "pix",
  "qrcode_url": "https://api.exemplo.com/pix/qrcode/abc123",
  "qrcode_signature": "00020101021226820014br.gov.bcb.pix...",
  "expiration_date": 1706745600,
  "pix_key": "[email protected]",
  "pix_key_type": "email"
}

Campo	Tipo	Descrição
`type`	string	Sempre `pix`
`qrcode_url`	string \| null	URL do QR Code
`qrcode_signature`	string \| null	String do QR Code (copia e cola)
`expiration_date`	integer \| null	Timestamp de expiração
`pix_key`	string \| null	Chave PIX
`pix_key_type`	string \| null	Tipo da chave PIX

Tipos de Chave PIX (PixKeyType)

Valor	Descrição
`email`	E-mail
`document`	Documento (CPF/CNPJ)
`phone_number`	Telefone
`random_key`	Chave aleatória (EVP)

Boleto

{
  "type": "boleto",
  "expiration_date": 1706745600,
  "digitable_line": "34191.75124 34567.871230 41234.560005 9 12340000012345",
  "url": "https://api.exemplo.com/boleto/download/abc123.pdf"
}

Campo	Tipo	Descrição
`type`	string	Sempre `boleto`
`expiration_date`	integer \| null	Timestamp de vencimento
`digitable_line`	string \| null	Linha digitável
`url`	string \| null	URL para download

Cash

{
  "type": "cash"
}

Campo	Tipo	Descrição
`type`	string	Sempre `cash`

Voucher

{
  "type": "voucher"
}

Campo	Tipo	Descrição
`type`	string	Sempre `voucher`

Deposit

{
  "type": "deposit"
}

Campo	Tipo	Descrição
`type`	string	Sempre `deposit`

Cheque

{
  "type": "cheque"
}

Campo	Tipo	Descrição
`type`	string	Sempre `cheque`

Uso nos Eventos

O campo payment_method está presente em:

Order - Eventos de pedido
Subscription Transaction - Eventos de transação de assinatura
Checkout - Eventos de checkout

O campo reverse_payment_method está presente em:

Reverse Logistic - Eventos de reembolso e troca