POST
Devolver PIX recebido

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}$

Path Parameters

id
string<uuid>
required

Body

application/json
amount
integer
required

Centavos

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

15000

external_id
string
required

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

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

"pedido-8812"

reason
string
Maximum string length: 140

Response

Devolução aceita

id
string<uuid>
external_id
string | null
received_id
string<uuid> | null
status
enum<string>
Available options:
pending,
completed,
failed
amount
integer
end_to_end_id
string | null
failure_reason
string | null
created_at
string<date-time>
updated_at
string<date-time>