Initiate a retirement request

Retire, or claim, instruments against an obligation

SecurityJWT
Request
path Parameters
ledgerIdentifier
required
string <uuid>

Ledger identifier, can be found using /api/ledger endpoint

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
Request Body schema: application/json
required

Populated BulkRetirementRequest

onBehalfOfSrcAcctId
string

If permitted, allows the caller to retire on behalf of another account holder, identifying that account holder by their system-assigned srcAcctId.

Array of objects (RetirementRequest)

retirement request

object (ExtShadowedLedgerRetirementOptionsDTO)
Responses
200

success

404

Not Found

post/api/ledger/{ledgerIdentifier}/retire
Request samples
application/json
{
  • "onBehalfOfSrcAcctId": "string",
  • "requests": [
    ],
  • "shadowedLedgerRetirementOptions": {
    }
}
Response samples
application/json
{
  • "responses": [
    ]
}