Deliver securities to, or receive securities from, an account at another DTC participant.
A request has 1 to 1000 movements. Each movement creates one transfer. All transfers of one request go into one new group. account_id, dtc_participant_number, external_account_id and metadata apply to every movement.
data[i] in the response comes from movements[i]. This order is the only link from a movement to its transfer_id.
Each movement moves one bucket of account_id. quantity is the position as the bucket holds it: positive for long, negative for short, either sign for net. receive adds quantity to the bucket, and deliver subtracts it. The sign does not depend on direction, because Clear Street can receive or deliver a short.
A malformed request returns 4xx, and the service records nothing. An instrument that does not resolve also returns 400. Any other problem that needs a lookup, such as a balance, does not refuse the request. That one transfer ends rejected, and the other transfers continue.
A 201 means that the service recorded every transfer. It does not mean that a movement happened. Poll each transfer, or list the group with group_id, to read the outcome.
reference_id applies to the whole request. A replay with the same payload returns 201 with the original group, each transfer in its current status. A replay with a different payload returns 409 with type reference-id-conflict. Otherwise the key rules of POST /transfers apply.
After a 5xx, the transfers may or may not exist. Retry with the same reference_id.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||