---
title: "batch"
method: GET
path: "/batch"
tags: ["Batch Request Endpoints"]
---

# batch

`GET /batch`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/batch`
- Auth: none declared

This endpoint is used to fetch a listing of all your batch transaction requests

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `TransactionType` string
- `PaymentType` string
- `FromDate` string
- `ToDate` string

## Response `200`

- object
  - `Success` boolean, required: True if the sending was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `Batches` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Array of objects. Each object contains the details of each batch transaction request
    - `0` object
      - `BatchTransactionRequestID` integer, required: The unique ID of the batch transaction request
      - `BatchName` string, required: Name of the submitted batch.
      - `TransactionType` string, required: EFT, Interac, or Paylink
      - `PaymentType` string, required: Credit or Debit
      - `NumRecords` integer, required: Number of transaction requests in the batch
      - `TotalAmount` number, required: Total amount of all transactions in the submitted batch
      - `DateAdded` string, required: Date the batch transaction request was submitted
      - `TotalSubmitted` integer, required: Total number of transactions that are still in submitted status
      - `TotalCreated` integer, required: Total number of transactions that have been created
      - `TotalFailed` integer, required: Total number of transactions that failed to create

---

[API](https://skmtc.dev/vopay/apis/payment-rails.md) - [All operations](https://skmtc.dev/vopay/apis/payment-rails/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-rails/revisions/d6fe8969ddcf?raw)