Creates Multiple Cancel Instructions

POST

/gw/api/v1/instructions/cancel:bulk

POST

/gw/api/v1/instructions/cancel:bulk

curl -X POST https://localhost:5000/gw/api/v1/instructions/cancel:bulk \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructionType": "CANCEL_INSTRUCTION",
  "instructions": [
    "string",
    "string",
    "string"
  ]
}'

{
  "status": 202,
  "instructionSetId": 3855,
  "instructionResults": [
    {
      "status": 202,
      "instructionSetId": 3855,
      "instructionResult": {
        "clientInstructionId": 12001861,
        "instructionType": "CANCEL_INSTRUCTION",
        "instructionStatus": "PROCESSED",
        "instructionId": 43094281
      }
    },
    {
      "status": 202,
      "instructionSetId": 3855,
      "instructionResult": {
        "clientInstructionId": 12001862,
        "instructionType": "CANCEL_INSTRUCTION",
        "instructionStatus": "PROCESSED",
        "instructionId": 43094282
      }
    },
    {
      "status": 202,
      "instructionSetId": 3855,
      "instructionResult": {
        "clientInstructionId": 12001863,
        "instructionType": "CANCEL_INSTRUCTION",
        "instructionStatus": "PROCESSED",
        "instructionId": 43094283
      }
    }
  ]
}

Scope: instructions.write
Security Policy: Signed JWT

Authentication

AuthorizationBearer

RS256-signed JWT access token signed with your registered private key.

Path parameters

client-idstringRequired

The client's clientId

Request

Create Bulk Cancel Instructions request body

instructionTypeenumRequired

Allowed values:

instructionslist of anyRequired

Response

Accepts all instructions in Bulk request to create them asynchronously

statuslong

HTTP status code for the request.

instructionSetIddouble

Identifier of the instruction set grouping the submitted instructions.

instructionResultslist of objectsOptional

Per-instruction results for the bulk request.

Errors

400

Bad Request Error

500

Internal Server Error