API Reference

Criar pagamento PIX IN

post
https://api.voidxpay.com/v1/pix-in

Cria uma cobrança PIX (QR Code) para recebimento. O pagador escaneia o QR Code e realiza o pagamento. Ao confirmar, o saldo da sua conta é creditado automaticamente (valor líquido após taxas).

O status inicial é waiting_payment. Quando o pagamento é confirmado, uma notificação pix-in.paid é enviada para a URL de webhook configurada na sua conta.

Body Params
string
enum
required

Método de pagamento. Atualmente apenas PIX é suportado.

Allowed:
integer
required
≥ 100

Valor do pagamento em centavos. Mínimo R$1,00 (100 centavos).

customer
object
required

Dados do cliente para quem a cobrança foi emitida. O customer é informado na criação do PIX IN e identifica o destinatário da cobrança. Para identificar quem efetivamente realizou o pagamento, consulte o campo payer.

items
array of objects
required
length ≥ 1

Lista de itens da cobrança (mínimo 1 item).

items*
string
required
length between 1 and 100

Título/nome do item (1-100 caracteres).

integer
required
≥ 1

Preço unitário em centavos (valor positivo).

integer
required
≥ 1

Quantidade (valor positivo).

string
length ≤ 50

Referência externa do item (máximo 50 caracteres, opcional).

string

Referência externa do integrador (ex: ID do pedido no seu sistema). Pode ser usada para consultar a transação via GET /v1/pix-in?externalRef=xxx.

string
length ≤ 500

Descrição do pagamento (máximo 500 caracteres).

metadata
object

Objeto com dados extras (chave-valor livre). Não aceita arrays ou null.

pix
object

Configurações adicionais do PIX.

Responses

Updated about 2 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago