Retrieve retirement request details

View retirement details using the retirement batch identifier

SecurityJWT

Request

path Parameters

ledgerIdentifier

required

string <uuid>

Ledger identifier, can be found using /api/ledger endpoint

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f

Request Body schema: application/json
required

Populated RetirementBatchRetrieveByIdentifierRequest

onBehalfOfSrcAcctId	string If permitted, allows the caller to retrieve retirement batches on behalf of another account holder, identifying that account holder by their system-assigned srcAcctId.
retirementBatchIdentifiers	Array of strings unique Identifiers associated with the retirement batch initiated by the system

Responses

200

success

404

Not Found

post/api/ledger/{ledgerIdentifier}/retirementBatch/byIdentifier

Request samples

Payload

application/json

{"onBehalfOfSrcAcctId": "string",
"retirementBatchIdentifiers": "3574500f-6df3-400e-abc9-e6aeb64f03c7"
}

Response samples

application/json

{"retirementBatches": [{"identifier": "string",
"originalQuantity": 0,
"liabilityIssuanceIdentifier": "string",
"liabilityHoldingIdentifier": "476022",
"subaccount": {"identifier": "6192c733-bbd2-11ef-acad-b63fd176813a",
"number": "string",
"account": {"srcAcctId": "4edse581-b97a-11ef-ea69-b61606fd520c",
"identifier": "15184192",
"name": "APXOPCAR Project Manager"
},
"name": "Allocated",
"description": "Holdings to retired & retired",
"status": "GOC",
"viableStatusTransitions": ["edit"
],
"managingExternalPlatform": {"externalPlatformIdentifier": "a5f8c9fa-001b-4444-b966-17b1a7871bbf",
"code": "string",
"name": "Xpansiv Connect",
"account": {"srcAcctId": "4edse581-b97a-11ef-ea69-b61606fd520c",
"identifier": "15184192",
"name": "APXOPCAR Project Manager"
},
"metadataConfig": "string"
},
"managingExternalPlatformAccountId": "string",
"managingExternalPlatformSubaccountMetadata": "string",
"default": true
},
"shadowedLedgerRetirementBatchIdentifier": "string",
"positions": [{"identifier": "string",
"resourceProgramAssignedIdentifier": "GHG1021",
"holdingStatus": "GOC",
"programPeriodBeginInclusive": "2022-01-01T00:00:00-05:00",
"programPeriodEndExclusive": "2023-01-01T00:00:00-05:00",
"timeOfProductionBeginInclusive": "2022-01-01T00:00:00-05:00",
"timeOfProductionEndExclusive": "2023-01-01T00:00:00-05:00",
"serialNumber": "APXOPCAR-GOC-GHG1021-US-2022--46-5701-6700",
"quantity": 1000,
"programVersions": [{"code": "GHG_MEASUREMENT_PROGRAM",
"version": "5.0.0",
"shortName": "Carbon Measurement",
"protocolVersions": [null
]
}
],
"protocolVersions": [{"code": "AMS-I.D.",
"version": "1.0.0"
}
],
"resourceInputTypeCodes": ["string"
],
"resourceOutputTypeCodes": "CARBON_REDUCTION",
"subaccountIdentifier": "5FF7ABAA-095D-11EF-B304-AA080FC10FFA",
"subaccountName": "My Linked Holdings",
"subaccountNumber": "10033",
"programCertificationGroupCode": "NONAFOLU_GHG_MEASUREMENT_PROGRAM",
"upn": "0999F5B4",
"ein": "1246AFA3E2",
"einDescription": "VCU-20120101-20121231-EDEM-3267-ZMB",
"shadowedLedgerName": "Verra",
"managingExternalPlatformName": "Xpansiv Connect",
"certificateType": "GOC"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"retirementParameters": { }
}
]
}

Retrieve retirement request details

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required