Skip to main content
POST
Prepare Transfer Signing Payload

Autorizaciones

Authorization
string
header
requerido

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Encabezados

X-Organization-Id
string<uuid>
requerido

Midaz organization scope for the request, used for downstream CRM, Fees, and Midaz calls. Required on org-scoped transfer routes in every deployment mode; a missing or non-UUID value returns 400. This is not the tenant identifier — tenantId is derived from the bearer JWT or authenticated context, never from this header. Background workers (TED IN poller, reconciliation) have no request header and, in single-tenant mode, fall back to the deployment's ORGANIZATION_ID env.

X-Idempotency
string
requerido

Required idempotency key for safe retries. Use a UUID v4 or unique business identifier. If the same key is sent again and the original request was already processed, the cached response is returned.

See Retries and idempotency for details.

Maximum string length: 255

Cuerpo

application/json
initiationId
string<uuid>
requerido

The initiation ID returned by the Initiate Transfer endpoint.

Ejemplo:

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

Respuesta

Indicates that the canonical payload was generated and is ready to be signed.

signingArtifactId
string<uuid>
requerido

Identifier of the frozen signing artifact. Pass this value to Process Transfer along with the signature.

Ejemplo:

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

transferId
string<uuid>
requerido

The transfer ID reserved for the eventual TED OUT. Not queryable until Process Transfer succeeds.

Ejemplo:

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

controlNumber
string
requerido

The JD SPB control number reserved for this transfer.

Maximum string length: 20
Ejemplo:

"202602010001"

algorithm
enum<string>
requerido

The signing algorithm. Pinned per JD SPB contract; any other value is rejected at Process Transfer.

Opciones disponibles:
RSA_PKCS1_V15_SHA256
Ejemplo:

"RSA_PKCS1_V15_SHA256"

payload
string
requerido

The canonical STR0008 payload, exactly as it will be submitted to JD SPB.

Ejemplo:

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

payloadHash
string
requerido

Hex-encoded SHA-256 digest of the payload. Echo this value at Process Transfer for integrity validation.

Ejemplo:

"8f0c7f5c1c7b4d9f2f5c7d1a0d4c9a2b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f"

expiresAt
string<date-time>
requerido

The time when the signing artifact expires. Process Transfer must be called before this timestamp.

Ejemplo:

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

signableContent
string

The ConteudoAssinado extraction for external signers. Present only when an external signing builder is configured.

Ejemplo:

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