Pular para o conteúdo principal
POST
/
v1
/
transfers
/
process
Processar uma Transferência
curl --request POST \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "initiationId": "019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b"
}
'
{
  "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
  "confirmationNumber": "20260201001",
  "status": "PROCESSING",
  "feeAmount": 1.5,
  "totalAmount": 1002
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por token JWT Bearer. O token deve incluir uma claim tenantId que corresponda ao cabeçalho X-Organization-Id.

Cabeçalhos

​
X-Organization-Id
string<uuid>
obrigatório

ID da organização usado como identificador do tenant. Todos os dados são limitados a esta organização. Deve corresponder à claim tenantId do JWT quando a autenticação está habilitada.

​
X-Idempotency
string
obrigatório

Chave de idempotência obrigatória para tentativas seguras. Use um UUID v4 ou identificador de negócio único. Se a mesma chave for enviada novamente e a solicitação original já tiver sido processada, a resposta em cache será retornada.

Consulte Tentativas e idempotência para detalhes.

Maximum string length: 255

Corpo

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

O ID de iniciação retornado pelo endpoint Iniciar Transferência. Expira após 24 horas.

Exemplo:

"019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b"

​
signingArtifactId
string<uuid>

Identificador do artefato de assinatura congelado retornado por Prepare Transfer Signature.

Exemplo:

"019c96a0-bb10-7def-a1b2-3c4d5e6f7a8b"

​
payloadHash
string

Hash SHA-256 do payload canônico que foi assinado.

Exemplo:

"8f0c7f5c1c7b4d9f2f5c7d1a0d4c9a2b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f"

​
signature
string

Assinatura codificada em Base64 para tenants que assinam fora do plugin.

Exemplo:

"base64-signature-here"

Resposta

Indica que a transferência foi confirmada e o processamento foi iniciado.

Chamadas repetidas com a mesma chave X-Idempotency reproduzem a resposta em cache.

Consulte Tentativas e idempotência para mais detalhes.

​
transferId
string<uuid>
obrigatório

O ID único da transferência. Use este valor para acompanhar o status da transferência.

Exemplo:

"019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d"

​
confirmationNumber
string
obrigatório

Um número de confirmação legível no formato AAAAMMDD+sequência.

Maximum string length: 20
Exemplo:

"20260201001"

​
status
enum<string>
obrigatório

O status atual da transferência. Para transferências TED_OUT, o status imediatamente após o processamento é sempre PROCESSING.

Opções disponíveis:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
REJECTED,
FAILED,
CANCELLED,
RECEIVED
Exemplo:

"COMPLETED"

​
feeAmount
number<decimal>
obrigatório

O valor da tarifa calculado durante a iniciação.

Exemplo:

1.5

​
totalAmount
number<decimal>
obrigatório

O valor total retido ou transferido, incluindo a tarifa.

Exemplo:

1002

​
packageAppliedId
string<uuid> | null

ID do pacote de tarifas aplicado a esta transferência, se houver.

Exemplo:

"019c96a0-ad10-7fab-c1d2-3b4c5d6e7f8a"