How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Xpansiv

Xpansiv Retirementbatch V1 API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Xpansiv Retirementbatch V1 API is one of 43 APIs that Xpansiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include retirementbatch-v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, a quickstart, and an API reference.

This API exposes 2 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://optimalapi-ext.apx.com/transfer/v1, https://optimalapi-uat-ext.apx.com/transfer/v1.

2 operations 2 paths 23 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://connect.xpansiv.com/app/api/v1
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

retirementbatch-v1 2

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

POST
/api/ledger/{ledgerIdentifier}/retirementBatch/byIdentifier
Retrieve retirement request details
getRetirementBatchesByIdentifier 1 param body → 200400401403404406422500
POST
/api/ledger/{ledgerIdentifier}/retire
Initiate a retirement request
initiateRetirements 1 param body → 200400401403404406422500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Holding (24 properties), Subaccount (12 properties), RetirementBatch (10 properties), RetirementRequest (6 properties). Each schema is shown below with its type and property counts.

RetirementBatch
object
10 properties
RetirementBatchRetrieveByIdentifierResponse
object
1 property
JsonNode
object
BulkRetirementRequest
object
3 properties
ErrorItem
object
6 properties
Subaccount
object
This class contains caller-visible set of sub-accounts for either the calling account or the account identified by onBehalfOfSrcAcctId
12 properties 1 required
ReferenceDatum
object
A reference datum data object
2 properties 1 required
BulkRetirementResponse
object
1 property
NamedProtocolVersion
object
6 properties
ProgramVersion
object
4 properties
RetirementRequest
object
6 properties
ProtocolVersion
object
5 properties
AbstractRestError
object
3 properties
ExtShadowedLedgerEntityIdentifierMappingDTO
object
2 properties
GeneralError
object
3 properties
ErrorContainer
object
2 properties
ExternalPlatform
object
5 properties
ExtShadowedLedgerRetirementOptionsDTO
object
2 properties
Account
object
Account record
3 properties
RetirementBatchRetrieveByIdentifierRequest
object
2 properties
RetirementResponse
object
Response for the balk retirement request
2 properties
QuantifiedHolding
object
Quantified Holding
2 properties
Holding
object
24 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xpansiv-retirementbatch-v1-api-openapi.yml Raw ↑

Other APIs Xpansiv publishes across the network.

Xpansiv Data API
AE Profile APIs.io
Xpansiv Marketplace FIX API
AE Profile APIs.io
Xpansiv Account API
AE Profile APIs.io
Xpansiv Building types API
AE Profile APIs.io
Xpansiv Clean Transportation API
AE Profile APIs.io
Xpansiv Corporate Entity API
AE Profile APIs.io
Xpansiv Exchange API
AE Profile APIs.io
Xpansiv Facilities API
AE Profile APIs.io
Xpansiv Facility import error handling API
AE Profile APIs.io
Xpansiv File Type V1 API
AE Profile APIs.io
Xpansiv /file Registry API
AE Profile APIs.io
Xpansiv Forward Deals API
AE Profile APIs.io
#retirementbatch-v1
← Back to X APIs
API Details
ID
xpansiv:xpansiv-retirementbatch-v1-api
Base URL
https://connect.xpansiv.com/app/api/v1
Docs
https://developer.xpansiv.com/developer-portal/xpansiv-connect
Provider
Xpansiv
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=xpansiv-retirementbatch-v1-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/xpansiv-retirementbatch-v1-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Xpansiv Retirementbatch V1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.