PATCH /orders/batch/{batchId}

Update batch details

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
batchId String Yes

Batch id for this request

notes String No

Additional information

Request body fields

Name Type Required Description
processingStatus String No

Status of the batch indicating its stage

Valid values:

  • "PENDING"
  • "DUPLICATE_FILE_NAME"
  • "INPROGRESS"
  • "CORRUPT_FILE"
  • "PARTIAL_SUCCESS"
  • "FORCE_STOPPED"
  • "TX_COMPLETED"
  • "NO_FILES_RECEIVED"
  • "SUCCESS"
responseFileName String No
responseFileSent Boolean No

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.