Saltar al contenido principal
POST
Decide a sent Pix held in fraud analysis

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id
string
requerido

Transfer UUID: the id of the outbound_transfer.fraud_analysis event, which the antifraud partner also holds as the key of its evaluation

Ejemplo:

"01a18811-6b64-7a10-b2c3-d4e5f6071829"

Cuerpo

application/json
analysisId
string
requerido

The partner's identifier of the analysis held: the fraudCheck.analysisId of the outbound_transfer.fraud_analysis event.

Required string length: 1 - 64
Ejemplo:

"an-7f3a"

decision
enum<string>
requerido

ALLOW sends the Pix. DENY reverses the debit and closes the transfer REJECTED. REVIEW is never a decision.

Opciones disponibles:
ALLOW,
DENY
Ejemplo:

"ALLOW"

justification
string

Required from a person of the client (10 to 500 characters after trimming), ignored for the application of the partner. Pix Lerian keeps it for audit, never returns it and never publishes it in an event.

Required string length: 10 - 500
Ejemplo:

"Payee confirmed by phone with the payer."

reasons
object[] | null

The partner's most recent reasons: when present they replace the reasons of the REVIEW. Read from a partner's application only; a person never changes them.

Respuesta

OK

amount
string
requerido
Ejemplo:

"100.00"

createdAt
string<date-time>
requerido
Ejemplo:

"2026-05-06T10:30:00Z"

endToEndId
string
requerido
Ejemplo:

"E12345678202605061030abcdef12345"

id
string
requerido
Ejemplo:

"019606a2-4c5d-7e8f-90a1-345678901bcd"

status
string
requerido
Ejemplo:

"COMPLETED"

type
string
requerido
Ejemplo:

"OUTBOUND"

updatedAt
string<date-time>
requerido
Ejemplo:

"2026-05-06T10:30:05Z"

accountId
string
Ejemplo:

"019606a0-1a2b-7c3d-8e4f-567890123abc"

aliasId
string
alreadyRefundedAmount
string

Cross-mechanism settled and reserved refund amount. Returned only for INBOUND transfers.

Ejemplo:

"60.00"

currency
string
Ejemplo:

"BRL"

deletedAt
string<date-time>
description
string
Ejemplo:

"Pagamento de aluguel"

destination
object
feeCharge
object

Fee the ledger reported on the transfer. Absent when the ledger's fee answer was not recorded for this transfer (an error logged at the time, or a transfer created before fees were read back); {"applied": false} when the ledger reported that no fee was charged; the full object when it charged one.

fraudCheck
object

The antifraud partner's answer for a Pix, as the partner gave it. Present on a transfer that the institution's antifraud partner evaluated: a received Pix that was approved, or a sent Pix, allowed or refused. Absent when the flow is off and on Pix Automático settlements.

initiatedAt
string<date-time>
Ejemplo:

"2026-05-06T10:30:00Z"

initiationType
string
Ejemplo:

"DICT"

ledger
object
metadata
object
paymentType
string
Ejemplo:

"PIX"

purpose
string
Ejemplo:

"IACT"

remainingRefundableAmount
string

Amount minus alreadyRefundedAmount. Returned only for INBOUND transfers and can be negative.

Ejemplo:

"40.00"

source
object
urgency
string
Ejemplo:

"HIGH"