Skip to main content
GET
Get a settlement instruction with its rounds and STR proof

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

instructionId
string
required

Settlement instruction id (UUID).

Example:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

Response

OK

currency
string
required

Amount currency.

cycle
string
required

CodPerOperac of the deposit cycle.

depositSender
enum<string>
required

Who sends the card deposits in this installation: LERIAN_SPB (Lerian SPB) or CLIENT_SPB (the client's own SPB).

Available options:
LERIAN_SPB,
CLIENT_SPB
id
string
required

Settlement instruction id.

netAmountCents
integer<int64>
required

Value of the current round as the LDL0021 carried it, in cents (negative = the IF deposits).

referenceDate
string
required

Settlement business day (YYYY-MM-DD).

round
integer<int64>
required

Current round.

rounds
object[]
required

Every round, oldest first.

state
string
required

PENDING, NOTIFIED, DEPOSITED or SETTLED.

updatedAt
string
required

Last change (RFC3339).

depositDeadline
string

LDL0021 DtDep + HrioLimDep (RFC3339).

depositRequest
object

The LDL0022 fields for the current round; omitted when the round asks for no deposit.

notifiedAt
string

When the client was notified of the current round (RFC3339).

participantIspb
string

ISPB of the IF the deposit value was informed to.

productCode
string

CodProdt of the LDL0021.