Skip to main content

submit

Submit your side of a settlement. If a counterparty has already submitted with the same trade_reference, the pair is confirmed and a settlement is created.

Parameters

InstructionPartyInput

InstructionLegInput

Each DvP instruction should include two legs: asset_delivery and payment. The direction is derived from your role - sellers deliver assets and receive payment, buyers deliver payment and receive assets.

Return type: InstructionRead

The pending_match / matched statuses describe reference correlation of a pre-agreed trade, not order matching - see what “matched” means.
| templateSlug | string | Template used | | role | string | The role you submitted as | | party | object | Your party details | | legs | object[] | Your leg details | | timeoutAt | string | Settlement timeout | | expiresAt | string | When this instruction expires if the counterpart never arrives | | createdAt | string | Creation timestamp |

get

Fetch a single instruction by ID.

list

List instructions with optional status filter.

Parameters


cancel

Cancel a pending instruction. Only works for instructions with pending_match status.

Instruction flow

The first instruction gets pending_match and a trade reference. The second instruction with the same trade reference completes the pair and creates a settlement.