Pular para o conteúdo
Referência

Cartão

Pagamentos com cartão tokenizado. O número do cartão e o CVV nunca chegam à BOSS Pay — só o token do adquirente.

Exige o produto CARD ativo para a empresa em Produção. No Sandbox basta não estar desativado.
POST/v1/card-payments

Autoriza (e captura) pagamento com cartão

Escopo charges.createAceita Idempotency-Key
Corpo (JSON)
amountobrigatório
string | inteiroValor em centavos (unidade mínima), como string ou inteiro. Ex.: "15990" = R$ 159,90.
installments
inteiro 1–12Parcelas. Padrão 1.
capture
booleanotrue = captura na hora (padrão). false = só autoriza.
cardobrigatório
objetotoken (do SDK do adquirente), brand, last4, bin (opcional), holderName (opcional).
customer
objetoPagador: name (obrigatório), document (CPF/CNPJ), email, phone.
description
string ≤ 140Descrição.
externalId
string ≤ 80Seu identificador do pedido. Aparece em listagens, filtros e webhooks.
metadata
objetoPares chave/valor (string, número ou booleano). Chaves até 40 caracteres.
POST/v1/card-payments/:id/capture

Captura autorização (total ou parcial)

Escopo charges.createAceita Idempotency-Key
Corpo (JSON)
amount
centavosVazio = valor autorizado.
POST/v1/card-payments/:id/cancel

Cancela autorização ou estorna captura

Escopo charges.createAceita Idempotency-Key
GET/v1/card-payments/:id

Consulta pagamento (NSU, TID, autorização)

Escopo charges.read
GET/v1/cards/transactions

Lista transações de cartão

Escopo charges.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/cards/chargebacks

Lista chargebacks

Escopo charges.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
POST/v1/cards/chargebacks/:id/dispute

Envia defesa de chargeback

Escopo charges.create
Corpo (JSON)
textobrigatório
string 20–5000Argumentação da contestação.
GET/v1/cards/fees

Tabela de taxas de cartão da empresa

Escopo charges.read