Pular para o conteúdo 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": "Urgent payment", "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": { "bankId": "12345678", "document": "12345678901", "name": "João da Silva", "branch": "0001", "accountType": 0, "accountNumber": "123456", "accountDigit": "7", "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d", "bankAccountType": 0, "key": "+5511987654321", "keyType": 3 }, "payee": { "bankId": "12345678", "document": "12345678901", "name": "João da Silva", "branch": "0001", "accountType": 0, "accountNumber": "123456", "accountDigit": "7", "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d", "bankAccountType": 0, "key": "+5511987654321", "keyType": 3 }, "flow": 1, "type": 1, "priority": 1, "createdAt": "2025-01-15T10:30:00.000Z", "updatedAt": "2025-01-15T10:30:00.000Z" }

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
​
accountId
string<uuid>
obrigatório

Identificador da conta a partir da qual a transacao sera realizada.

Exemplo:

"12345678-1234-1234-1234-123456789012"

​
amount
number<double>
obrigatório

Valor da transacao.

Exemplo:

10

​
description
string
obrigatório

Descricao da transacao.

Exemplo:

"Internal transfer between accounts"

​
payee
object
obrigatório

Informacoes da conta bancaria.

​
priority
enum<integer>
obrigatório

Nivel de prioridade da transacao. Codigo numerico indicando a prioridade de processamento da transacao.

Valores validos:

  • 1 = PRIMARY (Alta prioridade - processado primeiro)
  • 2 = SECONDARY (Prioridade normal - fila de processamento padrao)
Opções disponíveis:
1,
2
Exemplo:

1

​
key
string
obrigatório

Chave PIX do destinatario (beneficiario).

Exemplo:

"recipient@example.com"

​
txId
string
obrigatório

Identificador unico da transacao (endToEndId).

Exemplo:

"TXN-ABC-123"

Resposta

Transacao criada

​
id
string<uuid>
obrigatório

Identificador unico da transacao.

Exemplo:

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

​
jdpiRequestId
string
obrigatório

Identificador da requisicao JDPI.

Exemplo:

"JD-REQ-20250926120001"

​
endToEndId
string
obrigatório

Identificador de transacao ponta a ponta.

Exemplo:

"E12345678202501011200000001"

​
status
enum<string>
obrigatório

Status de processamento da transacao. Valores string indicando o estado atual de uma transacao PIX.

Valores validos:

  • PENDING = Transacao foi iniciada e aguarda processamento pelo sistema de pagamentos
  • PENDING_CONFIRM = Transacao aguarda confirmacao final
  • EXECUTED = Transacao concluida com sucesso e fundos transferidos
  • REVERSAL = Transacao foi revertida (estornada)
  • REPROVED = Transacao foi rejeitada ou falhou na validacao
  • SCHEDULE = Transacao agendada para execucao futura
  • CANCELLED = Transacao foi cancelada pelo usuario antes da execucao
  • ERROR = Ocorreu um erro de processamento durante a execucao da transacao
Opções disponíveis:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Exemplo:

"EXECUTED"

​
amount
number<double>
obrigatório

Valor da transacao.

Exemplo:

10

​
description
string
obrigatório

Descricao da transacao.

Exemplo:

"Internal transfer between accounts"

​
payer
object
obrigatório

Informacoes da conta bancaria.

​
payee
object
obrigatório

Informacoes da conta bancaria.

​
flow
enum<integer>
obrigatório

Direcao do fluxo da transacao. Codigo numerico indicando se o dinheiro esta entrando, saindo ou sendo transferido internamente.

Valores validos:

  • 1 = CASH_IN (Recebimento de pagamento - dinheiro entrando na conta)
  • 2 = CASH_OUT (Envio de pagamento - dinheiro saindo da conta)
  • 3 = INTRA_PSP (Transferencia interna dentro do mesmo Prestador de Servicos de Pagamento)
Opções disponíveis:
1,
2,
3
Exemplo:

1

​
type
enum<integer>
obrigatório

Identificador do tipo de transacao. Codigo numerico especificando o tipo de transacao de pagamento.

Valores validos:

  • 1 = PIX (Pagamento instantaneo via sistema PIX brasileiro)
Opções disponíveis:
1
Exemplo:

1

​
priority
enum<integer>
obrigatório

Nivel de prioridade da transacao. Codigo numerico indicando a prioridade de processamento da transacao.

Valores validos:

  • 1 = PRIMARY (Alta prioridade - processado primeiro)
  • 2 = SECONDARY (Prioridade normal - fila de processamento padrao)
Opções disponíveis:
1,
2
Exemplo:

1

​
createdAt
string<date-time>
obrigatório

Data e hora de criacao da transacao.

Exemplo:

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

​
updatedAt
string<date-time>
obrigatório

Data e hora da ultima atualizacao da transacao.

Exemplo:

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