POST
Criar cobrança (QR dinâmico)

Authorizations

Authorization
string
header
required

Chave oripay_live_.... Só funciona dos IPs cadastrados para ela.

Headers

Idempotency-Key
string
required

Uma chave por intenção. Repita a mesma chave em retry. Fica presa ao external_id do recurso. Replay responde com o header Idempotency-Replayed igual a true.

Required string length: 8 - 128
Pattern: ^[\x21-\x7e]{8,128}$

Body

application/json
amount
integer
required

Centavos

Required range: 1 <= x <= 100000000
Example:

15000

expires_in
integer
required
Required range: 900 <= x <= 86400
external_id
string
required

Seu ID. Único por conta e tipo de recurso.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Example:

"pedido-8812"

description
string
Maximum string length: 140
metadata
object

Sem dados pessoais.

Example:

Response

Cobrança criada

id
string<uuid>
required
external_id
string | null
required
status
enum<string>
required
Available options:
active,
paid,
expired
amount
integer
required
qr_code
string
required

PIX copia e cola

expires_at
string<date-time> | null
required
created_at
string<date-time>
required
description
string | null
qr_code_image
string | null

Imagem do QR Code

paid_at
string<date-time> | null
received_id
string<uuid> | null
end_to_end_id
string | null
payer
object | null

Quem pagou. Preenchido quando a cobrança é paga

metadata
object | null