Pular para o conteúdo principal
POST
/
v1
/
transfers
/
signing
/
prepare
Preparar Payload de Assinatura da Transferência
curl --request POST \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/signing/prepare \
  --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"
}
'
{
  "signingArtifactId": "019c96a0-bb10-7def-a1b2-3c4d5e6f7a8b",
  "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
  "controlNumber": "202602010001",
  "algorithm": "RSA_PKCS1_V15_SHA256",
  "payload": "<STR0008>...</STR0008>",
  "payloadHash": "8f0c7f5c1c7b4d9f2f5c7d1a0d4c9a2b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f",
  "expiresAt": "2026-02-02T15:30:00-03:00"
}

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 Initiate Transfer.

Exemplo:

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

Resposta

Indica que o payload canônico foi gerado e está pronto para ser assinado.

​
signingArtifactId
string<uuid>
obrigatório

Identificador do artefato de assinatura congelado. Passe este valor para Process Transfer junto com a assinatura.

Exemplo:

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

​
transferId
string<uuid>
obrigatório

O ID de transferência reservado para o eventual TED OUT. Não consultável até que Process Transfer tenha sucesso.

Exemplo:

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

​
controlNumber
string
obrigatório

O número de controle do JD SPB reservado para esta transferência.

Maximum string length: 20
Exemplo:

"202602010001"

​
algorithm
enum<string>
obrigatório

O algoritmo de assinatura. Fixado por contrato do JD SPB; qualquer outro valor é rejeitado em Process Transfer.

Opções disponíveis:
RSA_PKCS1_V15_SHA256
Exemplo:

"RSA_PKCS1_V15_SHA256"

​
payload
string
obrigatório

O payload canônico STR0008, exatamente como será submetido ao JD SPB.

Exemplo:

"<STR0008>...</STR0008>"

​
payloadHash
string
obrigatório

Digest SHA-256 codificado em hex do payload. Reenvie este valor em Process Transfer para validação de integridade.

Exemplo:

"8f0c7f5c1c7b4d9f2f5c7d1a0d4c9a2b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f"

​
expiresAt
string<date-time>
obrigatório

O momento em que o artefato de assinatura expira. Process Transfer deve ser chamado antes desse timestamp.

Exemplo:

"2026-02-02T15:30:00-03:00"

​
signableContent
string

A extração ConteudoAssinado para assinadores externos. Presente apenas quando um construtor de assinatura externo está configurado.

Exemplo:

"<ConteudoAssinado>...</ConteudoAssinado>"