Skip to main content
POST
Procesar un cash-in entrante del upstream

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Cuerpo

application/json
dtHrOp
string
requerido

Marca de tiempo de la operación (ISO-8601).

endToEndId
string
requerido

End-to-end id del SPI (clave de idempotencia + deduplicación).

idReqJdPi
string
requerido

Id de solicitud del upstream (se convierte en el id de la fila local cuando es un UUID).

pagador
object
requerido
recebedor
object
requerido
tpIniciacao
integer<int64>
requerido

Tipo de iniciación (eStartupType: Chave -> ruta in, QR -> ruta inQrCode).

valor
number<double>
requerido

Monto en reales (un número JSON).

bankIdPss
string

ISPB del participante PSS de Saque/troco (una cadena v5.5.0).

chave
string

La clave Pix (presente en los cash-ins iniciados por clave).

cnpjIniciadorPagamento
string

CNPJ del iniciador del pago (una cadena v5.5.0).

dtContabil
string

Fecha contable (opcional).

dtHrLiquidacao
string

Marca de tiempo de liquidación (opcional).

finalidade
integer<int64>

Finalidad (eFinality).

idConciliacaoRecebedor
string

Id de conciliación del beneficiario (estampado en el registro + el marcador de 24 h).

infEntreClientes
string

Información entre clientes de texto libre.

modalidadeAgente
integer<int64>

Modalidad del agente (eModalityAgent).

prioridadePagamento
integer<int64>

Prioridad del pago (ePaymentPriority).

tpPrioridadePagamento
integer<int64>

Tipo de prioridad del pago.

vlrDetalhe
object[] | null

Entradas de detalle de valores opcionales.

Respuesta

OK

dtHrCreditoSgct
string

Marca de tiempo del crédito del settlement-gateway (ISO-8601), en un resultado acreditado.

dtHrReqJdPi
string

Marca de tiempo de la solicitud (ISO-8601).

endToEndIdDevolucao
string

End-to-end id de retorno, reflejado.

endToEndIdOriginal
string

End-to-end id original, reflejado.

idCreditoSgct
string

Id de lançamento de crédito del settlement-gateway (GUID), en un resultado acreditado.

idReqJdPi
string

Id de solicitud del upstream, reflejado.

idReqSistemaCliente
string

Id de solicitud del sistema cliente, reflejado.