Create retirements

Allows creation retirements in bulk

SecuritybearerToken
Request
path Parameters
AccountIdentifier
required
string

Account identifier

Example: 098B0A25
RetirementProgramCode
required
string (RetirementProgramCode)

Program code allowed for retirements

Enum: "ACR" "CAR" "VCS" "NEPOOL" "NAR" "NYGATS" "M_RETS" "MIRECS" "NCRETS"
Request Body schema: application/json
required
dryRun
boolean

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

Array of objects
object
Responses
200

Retirements

400

Bad request

401

Not authorized error

500

Internal server error

post/retirements/account/{AccountIdentifier}/program/{RetirementProgramCode}/action/create
Request samples
application/json
{
  • "dryRun": true,
  • "retirements": [
    ],
  • "attributes": { }
}
Response samples
application/json
{
  • "retirementIdentifiers": [
    ],
  • "batchIdentifier": "string"
}