VoPay Batch Request Endpoints API
The Batch Request Endpoints API from VoPay — 17 operation(s) for batch request endpoints.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/vopay-batch-request-endpoints-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
version: '2.0'
title: Payment Rails Batch Request Endpoints API
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
servers:
- url: https://earthnode-dev.vopay.com/api/v2
tags:
- name: Batch Request Endpoints
paths:
/batch/contacts/add:
post:
description: 'This endpoint is used to submit multiple contact creation requests to VoPay. Each object in the batch is processed against the /contacts/add endpoint: EmailAddress and PhoneNumber are always required, and either BusinessName or both FirstName and LastName must be provided.'
summary: batch/contacts/add
tags:
- Batch Request Endpoints
operationId: BatchContactsAddPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /contacts/add endpoint. This endpoint accepts a maximum of 5000 contacts per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of contacts submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected contacts.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected contacts
example: '{''1'': ''Required parameter(s) missing: EmailAddress'', ''3'': ''Required parameter(s) missing: FirstName, LastName''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/eft/fund:
post:
description: This endpoint is used to submit multiple EFT fund transaction requests to VoPay.
summary: batch/eft/fund
tags:
- Batch Request Endpoints
operationId: BatchEFTFundPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /eft/fund endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: FirstName, LastName'', ''3'': ''Required parameter(s) missing: PostalCode''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/eft/withdraw:
post:
description: This endpoint is used to submit multiple EFT withdraw transaction requests to VoPay.
summary: batch/eft/withdraw
tags:
- Batch Request Endpoints
operationId: BatchEFTWithdrawPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /eft/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: FirstName, LastName'', ''3'': ''Required parameter(s) missing: PostalCode''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/interac/money-request:
post:
description: This endpoint is used to submit multiple Interac money request transaction requests to VoPay.
summary: batch/interac/money-request
tags:
- Batch Request Endpoints
operationId: BatchInteracMoneyRequestPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /interac/money-request endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: SenderName'', ''3'': ''Required parameter(s) missing: EmailAddress''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/interac/bulk-payout:
post:
description: This endpoint is used to submit multiple Interac bulk-payout transaction requests to VoPay.
summary: batch/interac/bulk-payout
tags:
- Batch Request Endpoints
operationId: BatchInteracBulkPayoutPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /interac/bulk-payout endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: SenderName'', ''3'': ''Required parameter(s) missing: EmailAddress''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/rtr/withdraw:
post:
description: This endpoint is used to submit multiple VoPay Instant transaction requests to VoPay.
summary: batch/rtr/withdraw
tags:
- Batch Request Endpoints
operationId: BatchVopayInstantPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /rtr/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: FinancialInstitutionNumber'', ''3'': ''Required parameter(s) missing: AccountNumber''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/elinx:
post:
description: This endpoint is used to submit multiple eLinx beneficiary requests to VoPay.
summary: batch/elinx
tags:
- Batch Request Endpoints
operationId: BatchELinxPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /elinx endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: SenderName'', ''3'': ''Required parameter(s) missing: EmailAddress''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/debit-card/push-funds:
post:
description: This endpoint is used to submit multiple debit card oct push funds requests to VoPay.
summary: batch/debit-card/push-funds
tags:
- Batch Request Endpoints
operationId: BatchDebitCardPushFundsPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /debit-card/oct/push-funds endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: SenderName'', ''3'': ''Required parameter(s) missing: EmailAddress''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/ach/fund:
post:
description: This endpoint is used to submit multiple ACH Fund requests to VoPay.
summary: batch/ach/fund
tags:
- Batch Request Endpoints
operationId: BatchACHFundPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /ach/fund endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: SenderName'', ''3'': ''Required parameter(s) missing: EmailAddress''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/ach/withdraw:
post:
description: This endpoint is used to submit multiple ACH Withdraw requests to VoPay.
summary: batch/ach/withdraw
tags:
- Batch Request Endpoints
operationId: BatchACHWithdrawPost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /ach/withdraw endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the request failed
example: ''
BatchTransactionRequestID:
type: integer
description: Unique ID of your batch transaction request.
example: '123456'
TotalSubmittedTransactions:
type: integer
description: Total number of transactions submitted.
example: '1000'
NumberOfRejectedTransactions:
type: integer
description: Total number of rejected transactions.
example: '5'
RejectedTransactions:
type: string
description: JSON object containing the rejected transactions
example: '{''1'': ''Required parameter(s) missing: SenderName'', ''3'': ''Required parameter(s) missing: EmailAddress''}'
x-absent-when: no rejected transactions
required:
- Success
- ErrorMessage
- BatchTransactionRequestID
- TotalSubmittedTransactions
- NumberOfRejectedTransactions
/batch/credit-card/charge:
post:
description: This endpoint is used to submit multiple Credit Card Charge requests to VoPay.
summary: batch/credit-card/charge
tags:
- Batch Request Endpoints
operationId: BatchCreditCardChargePost
deprecated: false
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
AccountID:
description: Your account ID
type: string
Key:
description: API key for the account
type: string
Signature:
description: Hashed signature for the request
type: string
BatchName:
description: Name of the batch
type: string
BatchData:
description: An array of objects. Each object contains the input params for the /credit-card/charge endpoint. This endpoint accepts a maximum of 5000 transactions per batch submission.
type: string
required:
- AccountID
- Key
- Signature
- BatchName
- BatchData
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
description: True if the request was successful, false if it failed
example: true
ErrorMessage:
type: string
description: Contains a description of the error if the req
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vopay/refs/heads/main/openapi/vopay-batch-request-endpoints-api-openapi.yml