---
updatedAt: 2026-04-23T04:17:15.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# batch

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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Payment Rails",
    "description": "The Payment Rails API allows you to manage transactions in your account. You can cancel transactions, refund transactions, and confirm flagged transactions.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/batch": {
      "get": {
        "description": "This endpoint is used to fetch a listing of all your batch transaction requests",
        "summary": "batch",
        "tags": [
          "Batch Request Endpoints"
        ],
        "operationId": "BatchGet",
        "deprecated": false,
        "parameters": [
          {
            "name": "AccountID",
            "in": "query",
            "required": true,
            "description": "Your account ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Key",
            "in": "query",
            "required": true,
            "description": "API key for the account",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Signature",
            "in": "query",
            "required": true,
            "description": "Hashed signature for the request",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "TransactionType",
            "in": "query",
            "required": false,
            "description": "Filters results by transaction type: EFT, Interac, or Paylink. Default is '' (i.e., batch transaction requests of all transaction types are returned).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PaymentType",
            "in": "query",
            "required": false,
            "description": "Filters results by payment type: Credit or Debit. Default is '' (i.e., batch transaction requests of all payment types are returned).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "FromDate",
            "in": "query",
            "required": false,
            "description": "Returns all batch transaction requests submitted after this date. Date format is YYYY-MM-DD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ToDate",
            "in": "query",
            "required": false,
            "description": "Returns all batch transaction requests submitted before this date. Date format is YYYY-MM-DD.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the sending was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "Batches": {
                      "type": "object",
                      "description": "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",
                      "properties": {
                        "0": {
                          "type": "object",
                          "properties": {
                            "BatchTransactionRequestID": {
                              "type": "integer",
                              "description": "The unique ID of the batch transaction request",
                              "example": "1234"
                            },
                            "BatchName": {
                              "type": "string",
                              "description": "Name of the submitted batch.",
                              "example": "Funding transactions - Jan 2022"
                            },
                            "TransactionType": {
                              "type": "string",
                              "description": "EFT, Interac, or Paylink",
                              "example": "EFT"
                            },
                            "PaymentType": {
                              "type": "string",
                              "description": "Credit or Debit",
                              "example": "Credit"
                            },
                            "NumRecords": {
                              "type": "integer",
                              "description": "Number of transaction requests in the batch",
                              "example": "950"
                            },
                            "TotalAmount": {
                              "type": "number",
                              "description": "Total amount of all transactions in the submitted batch",
                              "example": "4560.34"
                            },
                            "DateAdded": {
                              "type": "string",
                              "description": "Date the batch transaction request was submitted",
                              "example": "2022-01-12"
                            },
                            "TotalSubmitted": {
                              "type": "integer",
                              "description": "Total number of transactions that are still in submitted status",
                              "example": "45"
                            },
                            "TotalCreated": {
                              "type": "integer",
                              "description": "Total number of transactions that have been created",
                              "example": "900"
                            },
                            "TotalFailed": {
                              "type": "integer",
                              "description": "Total number of transactions that failed to create",
                              "example": "5"
                            }
                          },
                          "required": [
                            "BatchTransactionRequestID",
                            "BatchName",
                            "TransactionType",
                            "PaymentType",
                            "NumRecords",
                            "TotalAmount",
                            "DateAdded",
                            "TotalSubmitted",
                            "TotalCreated",
                            "TotalFailed"
                          ]
                        }
                      },
                      "x-empty-when": "no batches match",
                      "x-list-of": "inline"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "Batches"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```