Skip to main content
POST
Encerrar devolução DICT

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

Refund UUID

Corpo

application/json

closeRefund analysis body

analysisResult
string
obrigatório

Refund analysis outcome: TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, or REJECTED

Exemplo:

"TOTALLY_ACCEPTED"

analysisDetails
string

Optional free-text analysis details

effectiveRefundedAmountCents
integer<int64> | null

Effective refunded amount in cents; mandatory when analysisResult is TOTALLY_ACCEPTED or PARTIALLY_ACCEPTED

rejectionReason
string

BACEN rejection reason; mandatory when analysisResult is REJECTED, omit when accepted

Resposta

OK

Persisted local DICT refund request record

amountCents
integer<int64>
obrigatório

Refund amount in integer minor units (BRL centavos)

Exemplo:

150000

createdAt
string
obrigatório

Record creation timestamp (RFC 3339, UTC)

Exemplo:

"2026-06-14T12:00:00Z"

endToEndId
string
obrigatório

BACEN end-to-end identifier (E2E ID) of the refunded PIX transaction

Exemplo:

"E1234567820260614ABCDEFGHIJKLMNO"

id
string
obrigatório

Server-assigned refund record UUID

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

reason
string
obrigatório

Free-text justification for the refund request

reportStatus
string
obrigatório

BACEN report delivery state: PENDING, SENT, or FAILED (FAILED is retryable; the local record stands)

Exemplo:

"SENT"

requestedByISPB
string
obrigatório

ISPB (8 numeric digits) of the participant that requested the refund

Exemplo:

"12345678"

status
string
obrigatório

Local refund lifecycle state: REQUESTED, ACCEPTED, REJECTED, SETTLED, or CANCELLED

Exemplo:

"REQUESTED"

updatedAt
string
obrigatório

Last update timestamp (RFC 3339, UTC)

Exemplo:

"2026-06-14T12:00:00Z"

effectiveRefundedAmountCents
integer<int64>

MED 2.0: effective refunded amount in cents recorded on an accepting close (verbatim); omitted until close

Exemplo:

75000

fundsRecoveryId
string

Local funds-recovery id this refund is bound to (refund-under-recovery); omitted for a standalone refund

Exemplo:

"550e8400-e29b-41d4-a716-446655440003"

monitorAccount
boolean

MED 2.0: whether the destination account is monitored

Exemplo:

true

refundAccount
object

MED 2.0: destination account of a refund-under-recovery; omitted for a standalone refund