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-Tenant-Id: <x-tenant-id>' \
  --data '
{
  "initiationId": "019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b"
}
'
{
  "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
  "confirmationNumber": "20260201001",
  "status": "PROCESSING",
  "feeAmount": 1.5,
  "totalAmount": 1002
}

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-Tenant-Id.

Cabeçalhos

​
X-Tenant-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"

Resposta

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

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a transação acabou de ser processada. Se o valor for true, a resposta é uma repetição de uma solicitação processada anteriormente.

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"