Crear reembolso

Solicita un reembolso para una transacción Pix completada. Debes proporcionar un código válido de motivo de reembolso del BACEN (FR01=Fraude, AC03=Cuenta inválida, AG01=Prohibido, MD06=Solicitado por el receptor, BE01=Datos inconsistentes, AC07=Cuenta cerrada). La transacción original debe estar en estado EXECUTED para ser elegible para reembolso.

POST /v1/refunds

cURL

fraud_refund

curl --request POST \ --url https://plugin-pix-direct.api.lerian.net/v1/refunds \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "endToEndId": "E12345678202501011200000001", "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081", "transactionId": "019c96a0-10ce-75fc-a273-dc799079a99c", "code": "FR01", "amount": 100.5, "description": "Transacción fraudulenta detectada" } '

201

Example

{ "id": "refund_123456789", "accountId": "acc_123456789", "code": "MD06", "endToEndId": "E1234567820230615123456789012345", "endToEndRefundId": "D1234567820230615987654321098765", "amount": 100.5, "description": "Solicitado por el receptor", "status": "PENDING", "createdAt": "2023-06-15T11:00:00Z" }

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).

Encabezados

Idempotency-Key · string

Clave de idempotencia opcional para reintentos seguros (estándar IETF). Use un UUID v4 o identificador de negocio único. Si la misma clave se envía nuevamente y la solicitud original ya fue procesada, se devuelve la respuesta en caché.

Consulte Idempotencia en los productos Lerian para más detalles sobre el comportamiento específico de Pix Directo.

Cuerpo

application/json

endToEndId · string · requerido

Identificador end-to-end de la transacción original que será reembolsada.

Ejemplo:

"E12345678202501011200000001"

accountId · string<uuid> · requerido

Identificador de la cuenta que solicita el reembolso.

Ejemplo:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

transactionId · string<uuid> · requerido

Identificador de la transacción original que será reembolsada.

Ejemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

code · enum<string> · requerido

Códigos de motivo de reembolso definidos por el Banco Central de Brasil (BACEN). Códigos estandarizados que se utilizan al solicitar reembolsos de transacciones.

Valores válidos:

• FR01 = Fraude (Transacción identificada como fraudulenta)
• AC03 = Cuenta del beneficiario inválida (La cuenta del destinatario es inválida o no existe)
• AG01 = Transacción prohibida (El tipo de transacción no está permitido para esta cuenta)
• MD06 = Reembolso solicitado por el receptor (El beneficiario solicitó el reembolso)
• BE01 = Datos inconsistentes (La transacción contiene datos inconsistentes)
• AC07 = Cuenta cerrada (La cuenta del destinatario fue cerrada)

Opciones disponibles: FR01, AC03, AG01, MD06, BE01, AC07

Ejemplo:

"MD06"

amount · number<double> · requerido

Monto del reembolso (no debe exceder el monto de la transacción original).

Ejemplo:

100.5

description · string · requerido

Descripción del motivo del reembolso.

Ejemplo:

"Refund requested by receiver"

Respuesta

201

application/json

Reembolso creado correctamente

id · string · requerido

Identificador único del reembolso.

Ejemplo:

"refund_123456789"

accountId · string · requerido

Identificador de la cuenta asociada con el reembolso.

Ejemplo:

"acc_123456789"

code · enum<string> · requerido

Códigos de motivo de reembolso definidos por el Banco Central de Brasil (BACEN). Códigos estandarizados que se utilizan al solicitar reembolsos de transacciones.

Valores válidos:

• FR01 = Fraude (Transacción identificada como fraudulenta)
• AC03 = Cuenta del beneficiario inválida (La cuenta del destinatario es inválida o no existe)
• AG01 = Transacción prohibida (El tipo de transacción no está permitido para esta cuenta)
• MD06 = Reembolso solicitado por el receptor (El beneficiario solicitó el reembolso)
• BE01 = Datos inconsistentes (La transacción contiene datos inconsistentes)
• AC07 = Cuenta cerrada (La cuenta del destinatario fue cerrada)

Opciones disponibles: FR01, AC03, AG01, MD06, BE01, AC07

Ejemplo:

"MD06"

endToEndId · string · requerido

Identificador end-to-end de la transacción original que fue reembolsada.

Ejemplo:

"E1234567820230615123456789012345"

endToEndRefundId · string · requerido

Identificador end-to-end del reembolso.

Ejemplo:

"D1234567820230615987654321098765"

amount · number<double> · requerido

Monto del reembolso.

Ejemplo:

100.5

description · string · requerido

Descripción del motivo del reembolso.

Ejemplo:

"Solicitado por el receptor"

status · string · requerido

Estado del reembolso.

Ejemplo:

"PENDING"

createdAt · string<date-time> · requerido

Marca de tiempo de creación del reembolso.

Ejemplo:

"2023-06-15T11:00:00Z"