Gerar QR Code

Permite que você crie um código copia-e-cola e um QR Code Pix para seu cliente fazer o pagamento.

POST
https://api.bspay.co/v2/pix/qrcode

Body

amountrequiredfloat
Valor da transação
external_idstring
ID externo da transação gerado por você
postbackUrlrequiredstring
URL de webhook para receber as informações sobre o pagamento
payerQuestionstring
Descrição referente a transação
payerobject
Este objeto representa o pagador.
namestring
Nome completo do cliente ou nome comercial.
documentstring
O número de identificação fiscal do cliente (CPF para clientes individuais ou CNPJ para clientes empresariais)
emailstring
E-mail pessoal do cliente ou e-mail comercial
splitarray of objects
Porcentagem para distribuição de valor entre contas internas
usernamestring
Usuário que irá receber porcentagem referente a transação
percentageSplitstring
Porcentagem que o usuário acima receberá

Response

transactionIdstring
external_idstring
statusstring
amountstring
calendarobject
expirationinteger
dueDatestring
debtorobject
namestring
dueDatedocument
qrcodestring

Split

Para redirecionar parte da transação para outras contas de forma automática e instantânea você precisa informar o parâmetro "split". Veja um exemplo abaixo:

{
  "split": [
    {
      "username": "usertest",
      "percentageSplit": "10"
    },
    {
      "username": "usertest2",
      "percentageSplit": "5"
    }
  ]
}

Webhook

Seu sistema será notificado via webhook quando o pagamento for confirmado através da URL informada no parâmetro postbackUrl.

Veja quais informações são enviadas no corpo da solicitação no link abaixo.

Curl
JavaScript
PHP
Python
Ruby
curl --request POST \
  --url https://api.bspay.co/v2/pix/qrcode \
  --header 'Authorization: Bearer [SUA_CHAVE_API]' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data-raw '{
    "amount": 100.00,
    "postbackUrl": "https://example.com/webhook/callback"
  }'
200
401
{
  "transactionId": "4392d1d7e408d3cec04fm1zf3gv7vkq1",
  "external_id": "",
  "status": "PENDING",
  "amount": 15,
  "calendar": {
    "expiration": 3000,
    "dueDate": "2024-10-07 04:41:05"
  },
  "debtor": {
    "name": "Monkey D. Luffy",
    "document": "12924586666"
  },
  "qrcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/..."
}