POST
Enviar PIX

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

pix_key
string
required
Required string length: 1 - 77
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

Transferência aceita (status pending)

Sem campo de tarifa. Tarifas são linhas pix_fee/monthly_fee no extrato.

id
string<uuid>
required
external_id
string | null
required
status
enum<string>
required
Available options:
pending,
completed,
failed,
returned
amount
integer
required
pix_key_masked
string | null
required

Chave de destino mascarada

created_at
string<date-time>
required
updated_at
string<date-time>
required
recipient
object | null
end_to_end_id
string | null
failure_reason
string | null
metadata
object | null