DpaBatchStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DpaBatchStatus",
  "type": "object",
  "description": "The DpaBatchStatus response contains information related to the status of a submitted Digital Payment Application (DPA) batch.",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "This field allows the Integrator to assign an internal reference to a batch request so that it can be used for internal tracking purposes."
    },
    "batchId": {
      "type": "string",
      "description": "A unique identifier associated with the submitted Digital Payment Application (DPA) batch. The Batch ID can be used to retrieve the status of the batch by calling GET DPA status endpoint."
    },
    "batchStatus": {
      "type": "string",
      "description": "Describes the outcome of the submitted Digital Payment Application (DPA) batch. Possible outcomes include:\n\n* COMPLETED_SUCCESSFULLY - Batch was completed successfully and all DPAs included in the batch are ready to transact.\n\n* COMPLETED_WITH_ERRORS - Batch was completed successfully, but some DPAs included in the batch aren't ready to transact.\n\n* FAILED -  Batch failed to load.\n\n* IN_PROGRESS - Batch processing in progress.\n\nFor a full breakdown of all DPA outcomes in a batch, refer to the items.\n"
    },
    "batchStartTime": {
      "type": "string",
      "description": "Start time of batch request"
    },
    "batchEndTime": {
      "type": "string",
      "description": "End time of batch request"
    },
    "errorMessage": {
      "type": "string",
      "description": "Provides additional information when batchStatus yields a FAILED status."
    },
    "items": {
      "type": "array",
      "description": "An array of status objects that describes the outcome of each Digital Payment Application (DPA) item in a batch request.\n\nNote: DPA item order may differ from original submission.\"\n"
    }
  }
}