Reports the current status of an allocation.
Sent to the requester whenever the allocation status changes.
Note:
This message is used only to track the status of the "allocation action."
For details about the Operation generated by the allocation, consume the TradeOperationsSnapshot, which will also be sent.
The following flow shows the messages involved in the allocation process:
R1: This field will only be populated when AllocationStatus is 21 or 22.
R2: This field will only be populated when AllocationStatus is 22.
R3: This field will only be populated when AllocationStatus is 41.
R4: This field will only be populated when AllocationStatus is 42.
| Index | Field | Type | Required | Description | Rules |
|---|---|---|---|---|---|
| 1 | ParticipantRequestInfo | object | YES | Information about the original request whose status is being updated | |
| 1.1 | RequestId | string | YES | Unique request identifier assigned by the participant | |
| 1.2 | RequesterParticipantCode | string | YES | Requesting participant code | |
| 1.3 | OriginalMessageTypeCode | string | NO | Original message type in the base-m-cad-???-##-### pattern |
|
| 2 | IndividualAllocationId | string | YES | Individual allocation identifier assigned in the request | |
| 3 | AllocationStatus | integer | YES | Allocation status Possible values: AllocationStatus |
|
| 4 | ResultingOperationInformation | object | NO | Operation created as a result of the allocation, when successful | R1 |
| 4.1 | AssignedOperationCode | string | YES | Code assigned by the Clearinghouse to the operation resulting from the allocation. It is the unique identifier and must be used for future actions | |
| 5 | RemainingOperationInformation | object | NO | Operation remaining after the allocation, when successful | R1 |
| 5.1 | Quantity | integer | YES | Quantity remaining in the previous operation after the allocation | |
| 6 | GiveUpInformation | object | NO | When applicable, information about the give-up indicated as a result of the allocation | R2 |
| 6.1 | GiveUpCode | string | YES | Unique code assigned by the Clearinghouse to the indicated give-up. The origin participant can use this code to track its status, and the target participant can use it to accept or reject the give-up | |
| 6.2 | TargetParticipantCode | string | YES | Target participant code | |
| 6.3 | TargetAccountCode | string | YES | Code of the account to which the give-up was indicated under the target participant | |
| 7 | Errors | array | NO | If errors occur, identifies them | R3 |
| 7.1 | ErrorCode | string | YES | Error code | |
| 7.2 | ErrorMessage | string | NO | Brief error description | |
| 7.3 | ElementPath | string | NO | Path of the field related to the error, when applicable | |
| 7.4 | ElementContent | string | NO | Content received in the field related to the error, when applicable | |
| 8 | RejectionReason | object | NO | When applicable, information about the reason for rejecting the allocation | R4 |
| 8.1 | Message | string | YES | Reason for rejecting the allocation |
{
"ParticipantRequestInfo": {
"RequestId": "3F1127A12A9B47E7B6D638CBFE0C0824",
"RequesterParticipantCode": "22"
},
"IndividualAllocationId": "083A570A125D4402AF065D6B834DCB0F",
"AllocationStatus": 21,
"ResultingOperationInformation": {
"AssignedOperationCode": "EF314E885A6845128174FBC99D3C2CF5"
},
"RemainingOperationInformation": {
"Quantity": 70
}
}
{
"ParticipantRequestInfo": {
"RequestId": "3F1127A12A9B47E7B6D638CBFE0C0824",
"RequesterParticipantCode": "22"
},
"IndividualAllocationId": "083A570A125D4402AF065D6B834DCB0F",
"AllocationStatus": 41,
"Errors": [
{
"ErrorCode": "ALO0123"
}
]
}