Use this search bar to search topics within the CME ClearPort API.

Supported messages by function

Allocation Instruction Submission - Successfully processed

Allocation instruction submission - Pre approved for Credit 

In this scenario, a platform / clearing firm submits a pre-approved allocation instruction for a previously cleared bunched trade into CME ClearPort designating one or more accounts/funds, the the following message flow is triggered. The bunched trade (offset) and the allocations are pre-approved for credit.

The steps are:

• The platform sends an Allocation Instruction message with a TransTyp of New and a Typ of Give-up. The platform specifies the allocations in the Alloc block.

• An Allocation Report is sent to the platform with a TransTyp of New, a RptTyp of Give-up, and a Stat of Claimed. The message will include the cleared UTI. The Cleared Trade ID optionally may be included. The inclusion of the TradeID on platform messages varies by asset class.

Open

Allocation instruction submitted with multiple allocations - Partially processed

When a platform / clearing firm submits a pre-approved allocation instruction for a previously cleared bunched trade into CME ClearPort designating one or more accounts/funds, the following message flow is triggered:

• The Platform sends an Allocation Instruction message with a TransTyp of New and a Typ of Give-up. The allocations will be specified in the Alloc block.

• One of the allocations fails account validation.

• A response is sent to the platform an Allocation Instruction Ack message with TransTyp of New, Typ of Give-up, and Stat of Account level reject for the rejected allocation.

• All the other allocations will be processed normally. 

Allocation instruction submission – allocation rejected by CME ClearPort due to over-allocation

When a platform / clearing firm submits a pre-approved allocation instruction for a previously cleared bunched trade into CME ClearPort designating one or more accounts/funds, the following message flow is triggered:

• The platform sends an Allocation Instruction message with a TransTyp of New and  a Typ of Give-up. The allocations will be specified in the Alloc block.

• The allocation instruction fails quantity validation. The allocated quantity is greater than the bunched order quantity.

• A  response is sent to the platform an Allocation Instruction Ack message with TransTyp of New, Typ of Give-up, and Stat of Block level reject.

Allocation instruction submission (explicit claim) – clearing firm claims

When a platform / clearing firm submits an allocation instruction that has not been previously approved for a previously cleared bunched trade into CME ClearPort designating one or more accounts/funds, the following message flow is triggered:

• The platform sends an Allocation Instruction message with a TransTyp of New and a Typ of Give-up. The allocations will be specified in the Alloc block.

• Upon successful validation, a pending clear notification is sent using an Allocation Report message with a TransTyp of New, a RptTyp of Give-up, and a Stat of Allocation Pending.

• The clearing firm claims the allocation. An Allocation Report is sent to the platform with a TransTyp of New, a RptTyp of Give-up, and a Stat of Claimed. The message will include the cleared UTI. The Cleared Trade ID optionally may be included. The inclusion of the TradeID on platform messages varies by asset class.

Open

Allocation instruction submission (explicit claim) – clearing firm rejects

When a platform / clearing firm submits an allocation instruction that has not been previously approved for a previously cleared bunched trade into CME ClearPort designating one or more accounts/funds, the following message flow is triggered:

The steps are:

• The Platform sends an Allocation Instruction message with a TransTyp of New and  a Typ of Give-up. The allocations will be specified in the Alloc block.

• Upon successful validation, a pending clear notification is sent using an Allocation Report message with a TransTyp of New, a RptTyp of Give-up, and a Stat of Allocation Pending.

• One of the clearing firms rejects the allocation. An Allocation Report is sent to the platform with a TransTyp of New, a RptTyp of Give-up, and a Stat of Refused.

Cancel allocation submission – processed by CME Clearing - (IRS Submission only)

When a platform / clearing firm submits an IRS allocation instruction that has not been previously approved for a previously cleared bunched trade into CME ClearPort designating one or more accounts/funds, the following message flow is triggered:

The steps are:

• The platform sends an Allocation Instruction message with a TransTyp of New and a Typ of Give-up. The allocations will be specified in the Alloc Block.

• Upon successful validation, a pending clear notification is sent using an Allocation Report message with a TransTyp of New, a RptTyp of Give-up, and a Stat of Allocation Pending.

• One of the clearing firms claims the allocation. The allocation is still in pending clear state.

• The platform sends an Allocation Instruction message with a TransTyp of Cancel and  a Typ of Give-up. The cancellation is successful because the allocation is still in pending clear state.

• An Allocation Report is sent to the Platform with a TransTyp of Cancel, a RptTyp of Give-up, and a Stat of Cancelled.