Skip to main content
GET
/
api
/
v2
/
backoffice
/
batch
Get batch files with pagination and filtering
curl --request GET \
  --url https://sandbox.killb.app/api/v2/backoffice/batch \
  --header 'Authorization: Bearer <token>'
{
  "totalPages": 123,
  "currentPage": 123,
  "totalItems": 123,
  "limit": 123,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "batchFiles": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "bank": "OCCIDENT",
      "status": "CREATED",
      "filename": "<string>",
      "gcpUrl": "<string>",
      "totalFromAmount": 123,
      "totalToAmount": 123,
      "successCount": 123,
      "failedCount": 123,
      "transferIds": [
        "<string>"
      ],
      "transactionIds": [
        "<string>"
      ],
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "processedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
status
enum<string>

Filter by batch file status. Can be a single status or an array of statuses. Example: CREATED or CREATED,PROCESSING,COMPLETED

Available options:
CREATED,
PROCESSING,
COMPLETED,
FAILED
​
bank
enum<string>

Filter by bank. Can be a single bank or an array of banks. Example: OCCIDENT or OCCIDENT,COOPCENTRAL

Available options:
OCCIDENT,
COOPCENTRAL,
MANUAL,
MANUAL_USD,
COBRE,
MONO
​
externalId
string

Filter by external ID

Example:

"ext_123456789"

​
filename
string

Filter by filename (partial match)

Example:

"OCCIDENT_batch"

​
limit
number
default:50

Number of items per page

Required range: 1 <= x <= 100
​
page
number
default:1

Page number

Required range: x >= 1
​
sortBy
enum<string>
default:createdAt

Sort field

Available options:
createdAt,
updatedAt,
completedAt,
processedAt,
status,
bank
​
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

​
totalPages
number
required

Total number of pages

​
currentPage
number
required

Current page number

​
totalItems
number
required

Total number of items

​
limit
number
required

Number of items per page

​
hasNextPage
boolean
required

Whether there is a next page

​
hasPreviousPage
boolean
required

Whether there is a previous page

​
batchFiles
object[]
required

Array of batch files