Skip to content
Optimal Outcomes
/
OpenAPI Specs
/
/retirementbatch-v1

Transfer Position External API (1.0.0)

Use API credentials to view and manage instruments.

Download OpenAPI description
optimal.transferposition.v1.openapi.json
optimal.transferposition.v1.openapi.yaml
Languages
Servers
https://optimalapi-ext.apx.com/transfer/v1/
https://optimalapi-uat-ext.apx.com/transfer/v1/

transferbatch-v1

Initiate a transfer request (between subaccounts or another account holder), view or act upon pending transfers, as well as view historical transfer details.

Operations

retirementbatch-v1

View or submit a retirement request, or redemption claim, on instrument(s).

Operations

Retrieve retirement request details

Request

View retirement details using the retirement batch identifier

Security
JWT
Path
ledgerIdentifierstring(uuid)required

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

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
Bodyapplication/jsonrequired

Populated RetirementBatchRetrieveByIdentifierRequest

onBehalfOfSrcAcctIdstring

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

retirementBatchIdentifiersArray of stringsunique

Identifiers associated with the retirement batch initiated by the system

Example: "3574500f-6df3-400e-abc9-e6aeb64f03c7"
curl -i -X POST \
  https://optimalapi-ext.apx.com/transfer/v1/api/ledger/4b7375e9-79b0-4b8b-a89e-a21607f0239f/retirementBatch/byIdentifier \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "onBehalfOfSrcAcctId": "string",
    "retirementBatchIdentifiers": "3574500f-6df3-400e-abc9-e6aeb64f03c7"
  }'

Responses

success

Bodyapplication/json
retirementBatchesArray of objects(RetirementBatch)

Collection of retrieved retirement batches

Response
application/json
{
  "retirementBatches": [
    { … }
  ]
}

Initiate a retirement request

Request

Retire, or claim, instruments against an obligation

Security
JWT
Path
ledgerIdentifierstring(uuid)required

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

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
Bodyapplication/jsonrequired

Populated BulkRetirementRequest

onBehalfOfSrcAcctIdstring

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

requestsArray of objects(RetirementRequest)

retirement request

shadowedLedgerRetirementOptionsobject(ExtShadowedLedgerRetirementOptionsDTO)
curl -i -X POST \
  https://optimalapi-ext.apx.com/transfer/v1/api/ledger/4b7375e9-79b0-4b8b-a89e-a21607f0239f/retire \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "onBehalfOfSrcAcctId": "string",
    "requests": [
      {
        "liabilityHoldingIdentifier": "476022",
        "retirementReasonCode": "COMPLIANCE_REQUIREMENTS",
        "holdingCriteria": [
          {
            "holdingIdentifier": "476099",
            "quantity": 3
          }
        ],
        "correlationId": "string",
        "subaccountIdentifier": "string",
        "retirementParameters": {}
      }
    ],
    "shadowedLedgerRetirementOptions": {
      "suppressShadowedLedgerInteraction": true,
      "shadowedLedgerRetirementIdentifiersByHoldingIdentifier": {
        "property1": {
          "holdingIdentifier": "string",
          "shadowedLedgerEntityIdentifier": "string"
        },
        "property2": {
          "holdingIdentifier": "string",
          "shadowedLedgerEntityIdentifier": "string"
        }
      }
    }
  }'

Responses

success

Bodyapplication/json
responsesArray of objects(RetirementResponse)

responses for the bulk retirement request

Response
application/json
{
  "responses": [
    { … }
  ]
}

ledger-v1

View an Account's current and historical instrument details

Operations

subaccount-v1

View or create subaccounts. Use subaccounts to organize your account’s instruments. All accounts have a "Default" subaccount, where all new issuances and incoming transfers will be deposited. Subaccounts may also be used to delegate instrument management to an authorized third party.

Operations