Saltar al contenido principal
POST
/
v1
/
transactions
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "12345678-1234-1234-1234-123456789012",
  "amount": 150.5,
  "description": "Pago urgente",
  "priority": 1,
  "key": "recipient@example.com",
  "txId": "TXN-HIGH-001",
  "payee": {
    "bankId": "12345678",
    "document": "98765432100",
    "name": "Maria Santos",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7"
  }
}'
{
  "id": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "jdpiRequestId": "JD-REQ-20250926120001",
  "endToEndId": "E12345678202501011200000001",
  "status": "EXECUTED",
  "amount": 10,
  "description": "Internal transfer between accounts",
  "payer": {
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "key": "+5511987654321",
    "keyType": 3
  },
  "payee": {
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "key": "+5511987654321",
    "keyType": 3
  },
  "flow": 1,
  "type": 1,
  "priority": 1,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
accountId
string<uuid>
required

Identificador de la cuenta desde la cual se realizará la transacción.

Example:

"12345678-1234-1234-1234-123456789012"

​
amount
number
required

Monto de la transacción.

Example:

10

​
description
string
required

Descripción de la transacción.

Example:

"Internal transfer between accounts"

​
payee
object
required

Información de la cuenta bancaria.

​
priority
enum<integer>
required

Nivel de prioridad de la transacción. Código numérico que indica la prioridad de procesamiento para la transacción.

Valores válidos:

  • 1 = PRIMARY (Alta prioridad: se procesa primero)
  • 2 = SECONDARY (Prioridad normal: cola de procesamiento estándar)
Opciones disponibles:
1,
2
Example:

1

​
key
string
required

Clave Pix del destinatario (beneficiario).

Example:

"recipient@example.com"

​
txId
string
required

Identificador único de la transacción (endToEndId).

Example:

"TXN-ABC-123"

Response

Transacción creada

​
id
string<uuid>
required

Identificador único de la transacción.

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

​
jdpiRequestId
string
required

Identificador de la solicitud JDPI.

Example:

"JD-REQ-20250926120001"

​
endToEndId
string
required

Identificador end-to-end de la transacción.

Example:

"E12345678202501011200000001"

​
status
enum<string>
required

Estado del procesamiento de la transacción. Valores en texto que indican el estado actual de una transacción Pix.

Valores válidos:

  • PENDING = La transacción fue iniciada y está a la espera de procesamiento por el sistema de pagos
  • PENDING_CONFIRM = La transacción está esperando la confirmación final
  • EXECUTED = La transacción se completó con éxito y los fondos fueron transferidos
  • REVERSAL = La transacción fue revertida (reembolsada)
  • REPROVED = La transacción fue rechazada o no pasó la validación
  • SCHEDULE = La transacción está programada para una ejecución futura
  • CANCELLED = La transacción fue cancelada por el usuario antes de ejecutarse
  • ERROR = Ocurrió un error de procesamiento durante la ejecución de la transacción
Opciones disponibles:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Example:

"EXECUTED"

​
amount
number
required

Monto de la transacción.

Example:

10

​
description
string
required

Descripción de la transacción.

Example:

"Internal transfer between accounts"

​
payer
object
required

Información de la cuenta bancaria.

​
payee
object
required

Información de la cuenta bancaria.

​
flow
enum<integer>
required

Dirección del flujo de la transacción. Código numérico que indica si el dinero ingresa, sale o se transfiere internamente.

Valores válidos:

  • 1 = CASH_IN (Recepción de pago: dinero que entra a la cuenta)
  • 2 = CASH_OUT (Envío de pago: dinero que sale de la cuenta)
  • 3 = INTRA_PSP (Transferencia interna dentro del mismo proveedor de servicios de pago)
Opciones disponibles:
1,
2,
3
Example:

1

​
type
enum<integer>
required

Identificador del tipo de transacción. Código numérico que especifica el tipo de transacción de pago.

Valores válidos:

  • 1 = PIX (Pago instantáneo a través del sistema Pix brasileño)
Opciones disponibles:
1
Example:

1

​
priority
enum<integer>
required

Nivel de prioridad de la transacción. Código numérico que indica la prioridad de procesamiento para la transacción.

Valores válidos:

  • 1 = PRIMARY (Alta prioridad: se procesa primero)
  • 2 = SECONDARY (Prioridad normal: cola de procesamiento estándar)
Opciones disponibles:
1,
2
Example:

1

​
createdAt
string<date-time>
required

Marca de tiempo de creación de la transacción.

Example:

"2025-01-15T10:30:00.000Z"

​
updatedAt
string<date-time>
required

Marca de tiempo de la última actualización de la transacción.

Example:

"2025-01-15T10:30:00.000Z"