Cancel a batch order for a given orderId.
Cancel a batch order for a given orderId.
Path Parameters
- orderId uuid required
Possible values:
>= 36 characters
and<= 36 characters
Id of the order.
Example: 6c311d29-5753-46d4-b32c-19b918ea93b0
- 200
- 400
- 401
- 403
- 404
Cancel a batch order for a given orderId.
- application/json
- Schema
- Example (from schema)
- Complete
Schema
- batchChecksum int32
Expected number of batches in order.
batches object[]
Possible values:
<= 2147483647
Array of batches.
batchId uuidPossible values:
>= 36 characters
and<= 36 characters
, Value must match regular expression/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i
Id of the batch.
batchNumber int32Sequential number begins with first (1.) batch.
batchProcessingState stringPossible values: [
INITIALIZED
,COMPLETED
,PROCESSING
,PARTIAL
,ERROR
]The state of the batch.
batchTotal int32The total number of batches.
completedOn date-timejobs object[]
Possible values:
<= 2147483647
Array of jobs.
completedOn date-timeid uuidstartedOn date-timestate stringPossible values: [
UNSAVED
,INITIAL
,RUNNING
,TRANSFERS_FINISHED
,COMPLETED
,CANCELED
,ERROR
]jobsInBatchChecksum int32Expected number of jobs in batch.
orderId uuidPossible values:
>= 36 characters
and<= 36 characters
, Value must match regular expression/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i
Id of the order.
startedOn date-timetotalJobs int32Total amount of jobs inside the order.
- orderId uuid
Possible values:
>= 36 characters
and<= 36 characters
, Value must match regular expression/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i
Id of the order.
- state string
Possible values: [
INITIALIZED
,COMPLETED
,PROCESSING
,PARTIAL
,ERROR
]The state of the order.
{
"batchChecksum": 0,
"batches": [
{
"batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"batchNumber": 0,
"batchProcessingState": "INITIALIZED",
"batchTotal": 0,
"completedOn": "2023-12-08",
"jobs": [
{
"completedOn": "2023-12-08",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"startedOn": "2023-12-08",
"state": "UNSAVED"
}
],
"jobsInBatchChecksum": 0,
"orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"startedOn": "2023-12-08",
"totalJobs": 0
}
],
"orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "INITIALIZED"
}
{
"batchChecksum": 1,
"batches": [
{
"batchId": "f253718e-a270-4367-901b-9d50d9bd8462",
"batchNumber": 1,
"batchProcessingState": "PARTIAL",
"batchUrl": "https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462",
"jobsInBatchChecksum": 1
}
],
"orderId": "f253718e-a270-4367-901b-9d50d9bd8462",
"state": "COMPLETED"
}
Return Batch Order failed.
- application/json
- Schema
- Example (from schema)
- Error
Schema
- error string
Error.
- messages string[]
Possible values:
<= 2147483647
List of error messages.
- statusCode string
Possible values: [
100 CONTINUE
,101 SWITCHING_PROTOCOLS
,102 PROCESSING
,103 EARLY_HINTS
,103 CHECKPOINT
,200 OK
,201 CREATED
,202 ACCEPTED
,203 NON_AUTHORITATIVE_INFORMATION
,204 NO_CONTENT
,205 RESET_CONTENT
,206 PARTIAL_CONTENT
,207 MULTI_STATUS
,208 ALREADY_REPORTED
,226 IM_USED
,300 MULTIPLE_CHOICES
,301 MOVED_PERMANENTLY
,302 FOUND
,302 MOVED_TEMPORARILY
,303 SEE_OTHER
,304 NOT_MODIFIED
,305 USE_PROXY
,307 TEMPORARY_REDIRECT
,308 PERMANENT_REDIRECT
,400 BAD_REQUEST
,401 UNAUTHORIZED
,402 PAYMENT_REQUIRED
,403 FORBIDDEN
,404 NOT_FOUND
,405 METHOD_NOT_ALLOWED
,406 NOT_ACCEPTABLE
,407 PROXY_AUTHENTICATION_REQUIRED
,408 REQUEST_TIMEOUT
,409 CONFLICT
,410 GONE
,411 LENGTH_REQUIRED
,412 PRECONDITION_FAILED
,413 PAYLOAD_TOO_LARGE
,413 REQUEST_ENTITY_TOO_LARGE
,414 URI_TOO_LONG
,414 REQUEST_URI_TOO_LONG
,415 UNSUPPORTED_MEDIA_TYPE
,416 REQUESTED_RANGE_NOT_SATISFIABLE
,417 EXPECTATION_FAILED
,418 I_AM_A_TEAPOT
,419 INSUFFICIENT_SPACE_ON_RESOURCE
,420 METHOD_FAILURE
,421 DESTINATION_LOCKED
,422 UNPROCESSABLE_ENTITY
,423 LOCKED
,424 FAILED_DEPENDENCY
,425 TOO_EARLY
,426 UPGRADE_REQUIRED
,428 PRECONDITION_REQUIRED
,429 TOO_MANY_REQUESTS
,431 REQUEST_HEADER_FIELDS_TOO_LARGE
,451 UNAVAILABLE_FOR_LEGAL_REASONS
,500 INTERNAL_SERVER_ERROR
,501 NOT_IMPLEMENTED
,502 BAD_GATEWAY
,503 SERVICE_UNAVAILABLE
,504 GATEWAY_TIMEOUT
,505 HTTP_VERSION_NOT_SUPPORTED
,506 VARIANT_ALSO_NEGOTIATES
,507 INSUFFICIENT_STORAGE
,508 LOOP_DETECTED
,509 BANDWIDTH_LIMIT_EXCEEDED
,510 NOT_EXTENDED
,511 NETWORK_AUTHENTICATION_REQUIRED
]Error code.
{
"error": "string",
"messages": [
"string"
],
"statusCode": "100 CONTINUE"
}
{
"error": "Bad request",
"messages": [
"BadRequestException"
],
"statusCode": "400 BAD_REQUEST"
}
No valid authentication credentials.
- application/json
- Schema
- Example (from schema)
- Error
Schema
- error string
Error.
- messages string[]
Possible values:
<= 2147483647
List of error messages.
- statusCode string
Possible values: [
100 CONTINUE
,101 SWITCHING_PROTOCOLS
,102 PROCESSING
,103 EARLY_HINTS
,103 CHECKPOINT
,200 OK
,201 CREATED
,202 ACCEPTED
,203 NON_AUTHORITATIVE_INFORMATION
,204 NO_CONTENT
,205 RESET_CONTENT
,206 PARTIAL_CONTENT
,207 MULTI_STATUS
,208 ALREADY_REPORTED
,226 IM_USED
,300 MULTIPLE_CHOICES
,301 MOVED_PERMANENTLY
,302 FOUND
,302 MOVED_TEMPORARILY
,303 SEE_OTHER
,304 NOT_MODIFIED
,305 USE_PROXY
,307 TEMPORARY_REDIRECT
,308 PERMANENT_REDIRECT
,400 BAD_REQUEST
,401 UNAUTHORIZED
,402 PAYMENT_REQUIRED
,403 FORBIDDEN
,404 NOT_FOUND
,405 METHOD_NOT_ALLOWED
,406 NOT_ACCEPTABLE
,407 PROXY_AUTHENTICATION_REQUIRED
,408 REQUEST_TIMEOUT
,409 CONFLICT
,410 GONE
,411 LENGTH_REQUIRED
,412 PRECONDITION_FAILED
,413 PAYLOAD_TOO_LARGE
,413 REQUEST_ENTITY_TOO_LARGE
,414 URI_TOO_LONG
,414 REQUEST_URI_TOO_LONG
,415 UNSUPPORTED_MEDIA_TYPE
,416 REQUESTED_RANGE_NOT_SATISFIABLE
,417 EXPECTATION_FAILED
,418 I_AM_A_TEAPOT
,419 INSUFFICIENT_SPACE_ON_RESOURCE
,420 METHOD_FAILURE
,421 DESTINATION_LOCKED
,422 UNPROCESSABLE_ENTITY
,423 LOCKED
,424 FAILED_DEPENDENCY
,425 TOO_EARLY
,426 UPGRADE_REQUIRED
,428 PRECONDITION_REQUIRED
,429 TOO_MANY_REQUESTS
,431 REQUEST_HEADER_FIELDS_TOO_LARGE
,451 UNAVAILABLE_FOR_LEGAL_REASONS
,500 INTERNAL_SERVER_ERROR
,501 NOT_IMPLEMENTED
,502 BAD_GATEWAY
,503 SERVICE_UNAVAILABLE
,504 GATEWAY_TIMEOUT
,505 HTTP_VERSION_NOT_SUPPORTED
,506 VARIANT_ALSO_NEGOTIATES
,507 INSUFFICIENT_STORAGE
,508 LOOP_DETECTED
,509 BANDWIDTH_LIMIT_EXCEEDED
,510 NOT_EXTENDED
,511 NETWORK_AUTHENTICATION_REQUIRED
]Error code.
{
"error": "string",
"messages": [
"string"
],
"statusCode": "100 CONTINUE"
}
{
"error": "Unauthorized",
"messages": [
"UnauthorizedException"
],
"statusCode": "401 UNAUTHORIZED"
}
Authorization refused by server.
- application/json
- Schema
- Example (from schema)
- Error
Schema
- error string
Error.
- messages string[]
Possible values:
<= 2147483647
List of error messages.
- statusCode string
Possible values: [
100 CONTINUE
,101 SWITCHING_PROTOCOLS
,102 PROCESSING
,103 EARLY_HINTS
,103 CHECKPOINT
,200 OK
,201 CREATED
,202 ACCEPTED
,203 NON_AUTHORITATIVE_INFORMATION
,204 NO_CONTENT
,205 RESET_CONTENT
,206 PARTIAL_CONTENT
,207 MULTI_STATUS
,208 ALREADY_REPORTED
,226 IM_USED
,300 MULTIPLE_CHOICES
,301 MOVED_PERMANENTLY
,302 FOUND
,302 MOVED_TEMPORARILY
,303 SEE_OTHER
,304 NOT_MODIFIED
,305 USE_PROXY
,307 TEMPORARY_REDIRECT
,308 PERMANENT_REDIRECT
,400 BAD_REQUEST
,401 UNAUTHORIZED
,402 PAYMENT_REQUIRED
,403 FORBIDDEN
,404 NOT_FOUND
,405 METHOD_NOT_ALLOWED
,406 NOT_ACCEPTABLE
,407 PROXY_AUTHENTICATION_REQUIRED
,408 REQUEST_TIMEOUT
,409 CONFLICT
,410 GONE
,411 LENGTH_REQUIRED
,412 PRECONDITION_FAILED
,413 PAYLOAD_TOO_LARGE
,413 REQUEST_ENTITY_TOO_LARGE
,414 URI_TOO_LONG
,414 REQUEST_URI_TOO_LONG
,415 UNSUPPORTED_MEDIA_TYPE
,416 REQUESTED_RANGE_NOT_SATISFIABLE
,417 EXPECTATION_FAILED
,418 I_AM_A_TEAPOT
,419 INSUFFICIENT_SPACE_ON_RESOURCE
,420 METHOD_FAILURE
,421 DESTINATION_LOCKED
,422 UNPROCESSABLE_ENTITY
,423 LOCKED
,424 FAILED_DEPENDENCY
,425 TOO_EARLY
,426 UPGRADE_REQUIRED
,428 PRECONDITION_REQUIRED
,429 TOO_MANY_REQUESTS
,431 REQUEST_HEADER_FIELDS_TOO_LARGE
,451 UNAVAILABLE_FOR_LEGAL_REASONS
,500 INTERNAL_SERVER_ERROR
,501 NOT_IMPLEMENTED
,502 BAD_GATEWAY
,503 SERVICE_UNAVAILABLE
,504 GATEWAY_TIMEOUT
,505 HTTP_VERSION_NOT_SUPPORTED
,506 VARIANT_ALSO_NEGOTIATES
,507 INSUFFICIENT_STORAGE
,508 LOOP_DETECTED
,509 BANDWIDTH_LIMIT_EXCEEDED
,510 NOT_EXTENDED
,511 NETWORK_AUTHENTICATION_REQUIRED
]Error code.
{
"error": "string",
"messages": [
"string"
],
"statusCode": "100 CONTINUE"
}
{
"error": "Forbidden",
"messages": [
"ForbiddenException"
],
"statusCode": "403 FORBIDDEN"
}
Batch Order with the requested orderId not found.
- application/json
- Schema
- Example (from schema)
- Error
Schema
- error string
Error.
- messages string[]
Possible values:
<= 2147483647
List of error messages.
- statusCode string
Possible values: [
100 CONTINUE
,101 SWITCHING_PROTOCOLS
,102 PROCESSING
,103 EARLY_HINTS
,103 CHECKPOINT
,200 OK
,201 CREATED
,202 ACCEPTED
,203 NON_AUTHORITATIVE_INFORMATION
,204 NO_CONTENT
,205 RESET_CONTENT
,206 PARTIAL_CONTENT
,207 MULTI_STATUS
,208 ALREADY_REPORTED
,226 IM_USED
,300 MULTIPLE_CHOICES
,301 MOVED_PERMANENTLY
,302 FOUND
,302 MOVED_TEMPORARILY
,303 SEE_OTHER
,304 NOT_MODIFIED
,305 USE_PROXY
,307 TEMPORARY_REDIRECT
,308 PERMANENT_REDIRECT
,400 BAD_REQUEST
,401 UNAUTHORIZED
,402 PAYMENT_REQUIRED
,403 FORBIDDEN
,404 NOT_FOUND
,405 METHOD_NOT_ALLOWED
,406 NOT_ACCEPTABLE
,407 PROXY_AUTHENTICATION_REQUIRED
,408 REQUEST_TIMEOUT
,409 CONFLICT
,410 GONE
,411 LENGTH_REQUIRED
,412 PRECONDITION_FAILED
,413 PAYLOAD_TOO_LARGE
,413 REQUEST_ENTITY_TOO_LARGE
,414 URI_TOO_LONG
,414 REQUEST_URI_TOO_LONG
,415 UNSUPPORTED_MEDIA_TYPE
,416 REQUESTED_RANGE_NOT_SATISFIABLE
,417 EXPECTATION_FAILED
,418 I_AM_A_TEAPOT
,419 INSUFFICIENT_SPACE_ON_RESOURCE
,420 METHOD_FAILURE
,421 DESTINATION_LOCKED
,422 UNPROCESSABLE_ENTITY
,423 LOCKED
,424 FAILED_DEPENDENCY
,425 TOO_EARLY
,426 UPGRADE_REQUIRED
,428 PRECONDITION_REQUIRED
,429 TOO_MANY_REQUESTS
,431 REQUEST_HEADER_FIELDS_TOO_LARGE
,451 UNAVAILABLE_FOR_LEGAL_REASONS
,500 INTERNAL_SERVER_ERROR
,501 NOT_IMPLEMENTED
,502 BAD_GATEWAY
,503 SERVICE_UNAVAILABLE
,504 GATEWAY_TIMEOUT
,505 HTTP_VERSION_NOT_SUPPORTED
,506 VARIANT_ALSO_NEGOTIATES
,507 INSUFFICIENT_STORAGE
,508 LOOP_DETECTED
,509 BANDWIDTH_LIMIT_EXCEEDED
,510 NOT_EXTENDED
,511 NETWORK_AUTHENTICATION_REQUIRED
]Error code.
{
"error": "string",
"messages": [
"string"
],
"statusCode": "100 CONTINUE"
}
{
"error": "Not found",
"messages": [
"NotFoundException"
],
"statusCode": "404 NOT_FOUND"
}