Retirements

Create retirements

Allows creation retirements in bulk

post/retirements/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/create

Request

Base URL
https://sandbox.preprod.connect.xpansiv.com/app/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/retirements/account/:AccountIdentifier/program/:RetirementProgramCode/action/create/post.ts
A function with typed inputs. Its response is checked against the schema.

AccountIdentifierstring required

Account identifier

RetirementProgramCodestring required

Retirement program code. Ref.Data.RETIREMENT_PROGRAM

Program code allowed for retirements. Ref.Data.RETIREMENT_PROGRAM

dryRunboolean

If true it will only do the validation of the request but not to create the retirements

attributesobject

Retirements

retirementIdentifiersstring[]

batchIdentifierstring

EMA retirement batch identifier

No recorded changes to this operation across all 1 revision of this API.