Retirements

Initiate retirements of monthly certificates within an account.

SecurityJWT

Request

query Parameters

onBehalfOfAccountId

string

Account id for which the request is being made: defaults to the primary account id of the requester unless specified

Request Body schema: application/json

Array of objects (RetireRequest)

List of requests

Responses

200

400

Invalid parameter(s)

401

Unauthorized access

403

Permission denied

413

Request payload is too large

429

Server too busy or acceptable use policy violation

500

An unexpected error has occurred

post/api/ledger/retire

Request samples

Payload

application/json

{"requests": [{"correlationId": "1",
"certificateSerialNumberRange": "NAR-REC-1234-CA-06-2024-555555-1 to 66",
"quantity": "55",
"subaccountId": "77",
"isPublic": true,
"retirementTypeCode": "GRN",
"retirementReasonCode": "22",
"countrySubdivisionCode": "CA",
"retirementYear": 2024,
"notificationName": "John Doe",
"notificationEmail": "jdoe@acmecorp.com",
"additionalDetails": "Voluntary Retirement for Acme Corp.",
"retirementCertificateType": "SINGLE"
}
]
}

Response samples

application/json

{"submissionId": "1",
"responses": [{"correlationId": "1",
"certificateSerialNumberRange": "NAR-REC-1234-CA-06-2024-555555-1 to 66",
"quantity": "55",
"subaccountId": "77",
"isPublic": true,
"retirementTypeCode": "GRN",
"retirementReasonCode": "22",
"countrySubdivisionCode": "CA",
"retirementYear": 2024,
"notificationName": "John Doe",
"notificationEmail": "jdoe@acmecorp.com",
"additionalDetails": "Voluntary Green-e retirement",
"retirementCertificateType": "SINGLE",
"transferId": "5678",
"remainingCertificateSerialNumberRange": "NAR-REC-1234-CA-06-2024-555555-56 to 66"
}
]
}