Initiate connectivity (ECO) test

Prerequisite: an active certificate (see rotateCertificate, activateCertificate) and a READY readiness report (see getReadiness) before the connectivity test; a passing connectivity test is itself the prerequisite for a submit operation (see createBankTransferOperation). Builds a GEN0001 echo request addressed to the given participant, persists it as SUBMITTED before rail dispatch, and lets the outbound relay dispatch it to the RSFN. The counterparty answers with GEN0001R1 echoing the message back; the response correlates by NUOp and confirms the test. Idempotent — replaying the same X-Idempotency key with the same body returns the cached response.

POST /v1/str/connectivity-tests

Initiate connectivity (ECO) test

cURL

curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/connectivity-tests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "recipientIspb": "00038166",
  "message": "connectivity check"
}
'

201

{
  "controlNumber": "20260610000000000001",
  "correlationId": "req-7a3f9c2e",
  "messageType": "GEN0001",
  "nuOp": "12345678202606100000001",
  "status": "SUBMITTED",
  "submittedAt": "2026-06-10T12:00:00Z"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string · required

Idempotency key. Required on every mutation.

X-TTL · string

Idempotency key TTL in seconds (overrides the service default).

Body

application/json

recipientIspb · string · required

ISPB of the counterparty participant the echo is addressed to (8 uppercase alphanumeric characters).

Pattern: ^[0-9A-Z]{8}$

Example:

"00038166"

message · string

Optional free-text MsgECO payload echoed back by the counterparty (max 256 chars).

Example:

"connectivity check"

Response

201

application/json

Created

controlNumber · string · required

IF control number assigned to the GEN0001 submission (official ControleIF, 1-20 characters).

Required string length: 1 - 20

Example:

"20260610000000000001"

correlationId · string · required

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Example:

"req-7a3f9c2e"

messageType · string · required

STR message code of the submission (always GEN0001 for connectivity tests).

Example:

"GEN0001"

nuOp · string · required

BACEN protocol identifier (NUOp) assigned to the GEN0001 connectivity-test submission.

Required string length: 23

Pattern: ^[0-9A-Z]{8}[0-9]{15}$

Example:

"12345678202606100000001"

status · string · required

Submission status; SUBMITTED until the counterparty's GEN0001R1 echo correlates by NUOp and flips it to CONFIRMED.

Example:

"SUBMITTED"

submittedAt · string · required

RFC3339 UTC timestamp when the submission was persisted before send.

Example:

"2026-06-10T12:00:00Z"