VoPay Vopay Instant Endpoints API
The Vopay Instant Endpoints API from VoPay — 3 operation(s) for vopay instant 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-vopay-instant-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 Vopay Instant 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: Vopay Instant Endpoints
paths:
/rtr/withdraw:
post:
description: "This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. \n\n Either an iq11 Token or FinancialInstitutionNumber/BranchTransitNumber/AccountNumber is required. \n\n If a ClientAccountID is provided, the client account's first/last name and default bank account will be used for the transaction."
summary: rtr/withdraw
tags:
- Vopay Instant Endpoints
operationId: RtrWithdrawPost
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
ClientAccountID:
description: Client Account ID
type: string
ContactID:
description: The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.
type: string
FirstName:
description: Recipient's first name
type: string
LastName:
description: Recipient's last name
type: string
CompanyName:
description: Company's name
type: string
AccountNumber:
description: Recipient's bank account number. This is the account that funds will be deposited into.
type: string
FinancialInstitutionNumber:
description: Canadian banks. Three digit institution number.
type: string
BranchTransitNumber:
description: Canadian banks. Transit number for the Recipient's account.
type: string
Token:
description: Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.
type: string
Amount:
description: The amount in the specified currency to deposit into the recipient's bank account.
type: number
ClientReferenceNumber:
description: An optional reference number to associate with the transaction.
type: string
Notes:
description: An optional note to associate with the transaction.
type: string
IdempotencyKey:
description: A unique key which the server can use to recognize and reject subsequent retries of the same request.
type: string
ParentTransactionID:
description: The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.
type: string
GLCode:
description: An optional unique identification general ledger code.
type: string
TransactionTypeCode:
description: CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).
type: string
required:
- AccountID
- Key
- Signature
- FirstName
- LastName
- AccountNumber
- FinancialInstitutionNumber
- BranchTransitNumber
- Amount
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: ''
TransactionID:
type: integer
description: The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.
example: '1122'
TransactionStatus:
type: string
description: 'The current transaction status. Statuses are: pending, in progress, successful, failed, cancelled'
example: pending
Flagged:
type: string
description: Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.
example: The transaction has been flagged as a potential duplicate.
x-absent-when: transaction not flagged
required:
- Success
- ErrorMessage
- TransactionID
- TransactionStatus
/rtr/withdraw/transaction/request-cancellation:
post:
description: This endpoint allows you to attempt to cancel an in progress Vopay Instant transaction. Note that the cancellation request will fail if the recipient has already deposited the funds.
summary: rtr/withdraw/transaction/request-cancellation
tags:
- Vopay Instant Endpoints
operationId: RTRTransactionsCancelPost
deprecated: false
requestBody:
$ref: '#/components/requestBodies/InteracMoneyRequestTransactionsCancelPost'
responses:
'200':
description: ''
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: ''
TransactionID:
type: integer
description: The unique ID for the transaction
example: '1124'
TransactionStatus:
type: string
description: A message indicating the current transaction status - cancellation requested
example: cancellation requested
Timestamp:
type: string
format: date-time
description: The timestamp when the transaction status was last modified
example: '2022-11-26 12:00:00'
required:
- Success
- ErrorMessage
- TransactionID
- TransactionStatus
- Timestamp
/rtr/withdraw/transaction:
get:
description: This endpoint is used to look up details on a single VoPay Instant withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account.
summary: rtr/withdraw/transaction
tags:
- Vopay Instant Endpoints
operationId: RtrWithdrawTransactionGet
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: TransactionID
in: query
required: false
description: Unique ID of the withdraw transaction. Must provide either a TransactionID or ClientReferenceNumber.
schema:
type: integer
format: int32
- name: ClientReferenceNumber
in: query
required: false
description: A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.
schema:
type: string
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: ''
TransactionID:
type: integer
description: The unique ID of the transaction
example: '1122'
TransactionStatus:
type: string
description: 'A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled'
example: pending
TransactionDateTime:
type: string
format: date-time
description: The timestamp when the transaction was created
example: '2019-11-01 12:00:00'
Amount:
type: number
description: The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.
example: '2000'
Currency:
type: string
description: The currency for the transaction.
example: CAD
RecipientName:
type: string
description: Recipient's name
example: VoPay
FinancialInstitutionNumber:
type: string
description: Three digit institution number for a Canadian bank.
example: '112'
BranchTransitNumber:
type: string
description: Transit number for the customer's account.
example: '11809'
AccountNumber:
type: string
description: Recipient's bank account number that funds were deposited to.
example: '227654387'
ClientReferenceNumber:
type: string
description: An optional reference number which was associated with the transaction.
example: ''
ProcessingDate:
type: string
format: date-time
description: This timestamp indicates when the transaction record was processed..
example: '2019-11-03 01:00:00'
GLCode:
type: string
description: General ledger code.
example: '4300'
LastModified:
type: string
format: date-time
description: This timestamp indicates when the transaction record was last modified.
example: '2019-11-03 01:00:00'
TransactionTypeCode:
type: string
description: CPA transaction code.
example: '999'
required:
- Success
- ErrorMessage
- TransactionID
- TransactionStatus
- TransactionDateTime
- Amount
- Currency
- RecipientName
- FinancialInstitutionNumber
- BranchTransitNumber
- AccountNumber
- ClientReferenceNumber
- ProcessingDate
- GLCode
- LastModified
- TransactionTypeCode
components:
requestBodies:
InteracMoneyRequestTransactionsCancelPost:
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
TransactionID:
description: The unique ID for the transaction
type: string
required:
- AccountID
- Key
- Signature
- TransactionID
required: true