Skip to main content
POST

Descrição

Cria uma nova cobrança PIX e retorna QR Code e PIX Copia e Cola para o cliente efetuar o pagamento. A plataforma cobra 6% de taxa sobre o valor, com taxa mínima de R$ 0,20.
Taxa mínima: Se o cálculo de 6% resultar em menos de R0,20,ataxamıˊnimadeR 0,20, a taxa mínima de R 0,20 será aplicada. Para valores menores que R$ 1,00, a taxa deve ser repassada ao cliente.

Headers

string
required
Bearer token com sua API Key
string
required
Deve ser application/json

Body

number
required
Valor do pagamento em reais (ex: 10.50)
string
required
Descrição da cobrança que aparecerá para o cliente
string
URL para redirecionar o cliente após o pagamento ser confirmado
boolean
default:false
Se true, a taxa de 6% será adicionada ao valor cobrado do cliente, e você receberá 100% do valor original. Se false ou omitido, usa a configuração padrão da conta.
array
Array definindo a divisão do pagamento. Apenas 1 destinatário é suportado. Note que é necessário aprovação do nosso staff para que sua conta tenha essa funcionalidade ativada.

Response

boolean
Indica se a operação foi bem-sucedida
object
Informações da transação criada
string
Código PIX Copia e Cola para pagamento
object
QR Code em Base64 para exibição
Link para página de pagamento (somente se callbackUrl configurada)
object
Informações do split, caso configurado na requisição.
string
Mensagem de aviso retornada caso a taxa seja repassada ao cliente e informando o valor cobrado.

Observações Importantes

Payment Link: O campo paymentLink só é retornado se você tiver configurado uma callbackUrl através do painel de administração. Este link oferece uma página pronta para o cliente pagar com sua marca personalizada.
Taxa de 6%: A taxa é fixa (6% + taxa operacional). Por padrão é deduzida do seu valor:
  • Pagamento de R$ 100,00
  • Taxa: R$ 6,00
  • Você recebe: R$ 94,00
Com passFeeToCustomer: true: A taxa é adicionada ao valor cobrado do cliente:
  • Valor original: R$ 100,00
  • Cliente paga: R$ 106,00
  • Você recebe: R$ 100,00
Todos os pagamentos são reais: Não há ambiente de testes. Certifique-se de testar com valores pequenos se necessário.

Fluxo Recomendado

1

Cliente solicita pagamento

Usuário clica em “Pagar” no seu site/app
2

Crie a cobrança

Chame este endpoint com amount e description
3

Exiba o pagamento

Opção A: Redirecione para o paymentLink (página pronta)Opção B: Exiba o QR Code (qrcodeBase64) no seu site
4

Aguarde confirmação

Opção A: Configure webhook e receba notificação automáticaOpção B: Faça polling com GET /v1/payment/status/:txid
5

Libere o acesso

Após confirmar status approved, libere produto/serviço

Erros Comuns