Cobranças (cash-in) - OriPay API

A OriPay liga o PIX recebido à cobrança pelo txid do QR, que a Brasil Cash devolve no pagamento. Um PIX mandado direto para a chave da conta, sem QR, não marca nenhuma cobrança como paga: ele aparece só como PIX recebido. Antes de entregar algo de alto valor, confira payer em charge.paid contra o cliente esperado.

Criar

curl -X POST https://api.oripaysolutions.com.br/v1/pix/charges \
  -H "Authorization: Bearer $ORIPAY_API_KEY" \
  -H "Idempotency-Key: charge-pedido-8812" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 15000,
    "expires_in": 3600,
    "external_id": "pedido-8812",
    "description": "Pedido 8812",
    "metadata": { "customer_id": "cli_4471" }
  }'

Campo	Obrigatório	Regra
`amount`	Sim	Centavos, de 1 a 100000000 (R$ 1.000.000,00)
`expires_in`	Sim	Segundos, de 900 (15 min) a 86400 (24 h)
`external_id`	Sim	Seu ID, 1 a 64 caracteres `A-Z a-z 0-9 _ -`, único por conta
`description`	Não	Até 140 caracteres, aparece para o pagador
`metadata`	Não	Ver Mapeamento

Campos fora desta lista são recusados com 400 validation_error. Resposta 201:

{
  "id": "6a0e1f8c-0b7c-4f0e-9a51-2c3d4e5f6a7b",
  "external_id": "pedido-8812",
  "status": "active",
  "amount": 15000,
  "description": "Pedido 8812",
  "qr_code": "00020101021226...6304ABCD",
  "qr_code_image": "data:image/png;base64,iVBORw0...",
  "expires_at": "2026-10-28T14:00:00Z",
  "paid_at": null,
  "received_id": null,
  "end_to_end_id": null,
  "payer": null,
  "metadata": { "customer_id": "cli_4471" },
  "created_at": "2026-10-28T13:00:00Z"
}

Quem pagou

Quando a cobrança vira paid, o campo payer passa a trazer quem pagou: nome, documento mascarado (***.456.789-**) e nome do banco. received_id aponta para o PIX recebido que pagou a cobrança. Junto com o seu metadata, isso mostra qual cliente seu pagou e de qual conta o dinheiro saiu (ex. um parente pagando por ele).

Cancelar

Não há cancelamento. Use um expires_in curto; a cobrança vira expired sozinha e o evento charge.expired é enviado.

Pagamento diferente do valor

A cobrança dinâmica tem valor fixo: o banco do pagador não deixa pagar outro valor.