Retirement
Get retirement data by id
After calling the Request Retirement endpoint the response will contain a retirement_request_id
which you can use in this endpoint to get access to the retirement data including status, the retirement certificate etc.
Example cURL Request
Endpoint Specification
Get the retirement request for a specific id
POST
/api/retirement
See the status and other information about a specific retirement request.
Query Parameters
Name | Type | Description |
---|---|---|
id* | string | The id of the retirement request you want information about. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Bearer API_KEY |
total_quantity
is the quantity of the retirement request in grams.
retirement_request_items.quantity
is the quantity requested in an individual call to POST api/caas/request-retirement
in grams.
There are 2 types of retirement request: FRACTIONALISED
and WHOLE
. For any requests made through the api/caas/request-retirement
endpoint where the quantity is not whole tonnes, this type will be FRACTIONALISED
.
The status
can have one of the following values:
OPEN
| CLOSED
| IN_PROGRESS
| COMPLETE
| NOTHING_TO_PROCESS
See below for more information on status
.
If the id
supplied in the request does not match one of your retirement requests, the endpoint will throw a 422
error.
200: status
Values
status
ValuesStatus | Description |
---|---|
| means that more credits can be added to this retirement request (this is only applicable for retirements where the `type` is `FRACTIONALISED`) |
| means that no additional credits can be added to this retirement request and it is pending settlement of one or more invoices before being set to |
| means that the retirement is being processed on the underlying registry and more credits cannot be added to this retirement request. |
| means that the retirement has been processed on the underlying registry and details such as |
| means that the retirement request will not be processed as it has been closed and the |
422: Unprocessable Entity error
types
error
types`error` | Description |
---|---|
| One or more validation rules has failed. e.g. |
| Retirement request not found with id 00mj6hrvi6yaapj6nh |
Last updated