Retrieve error information for an uploaded batch file.
Note If the batch file has not been processed, you can correct the errors and update the batch file.
GET /v1/batches/{id}/errors
Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding
id REQUIRED
string (UUID)
Unique ID assigned to the batch.
verbose
boolean, default: false
Whether to return detailed error information. If set to true, the error line number and a detailed message will be returned.
page
integer (int32), default: 0
Page number to return.
pageSize
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of error messages. The following fields are returned.
fileErrors
integer
Number of errors found in the batch file.
content
array
Detailed error information. Returned when verbose is set to true.
line
integer
Line number where the error occurred.
detailMessage
string
Detailed error message.
SAMPLE RESPONSE
{
"status": "0000",
"result": {
"fileErrors": 3,
"content": [
{
"line": 20,
"detailMessage": "string"
},
{...},
{...}
],
"page": 0,
"total": 3,
"pageSize": 10
}
}
© 2023 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.