# VoPay API Documentation > VoPay is a leading provider of developer-friendly, alternative payment rails API. One set of endpoints enables developers to access Canada's real-time and bank account payment rails. ## Guides: Getting Started - [Get Started](https://docs.vopay.com/docs/getting-started.md): Get your Sandbox API keys and learn how to use VoPay's technology to build payment workflows into any platform. - [Sandbox Overview](https://docs.vopay.com/docs/sandbox.md): The VoPay sandbox is a full working copy of VoPay where nothing is real and nothing can break. Send payouts, collect funds, onboard accounts and receive webhooks using the same API and Portal you'll… - [VoPay Sandbox FAQs](https://docs.vopay.com/docs/vopay-sandbox-faqs.md): Answers to common questions about sandbox access, payments, and testing through the VoPay API or Portal. - [API Overview](https://docs.vopay.com/docs/api-overview.md) - [Integration Timeline](https://docs.vopay.com/docs/integration-timeline.md): Here you will find a high-level integration timeline covering major milestones of the VoPay integration process. - [Commonly Used Terms](https://docs.vopay.com/docs/commonly-used-terms.md): To help you get started, we've compiled a list of terms used throughout the API docs - [Commonly Used Endpoints](https://docs.vopay.com/docs/frequently-used-features.md): To help you get started, we've compiled a list of common actions and their associated API calls - [API Error Codes](https://docs.vopay.com/docs/api-error-codes.md) ## Guides: Payments - [Payments Overview](https://docs.vopay.com/docs/payments-overview.md): Learn about VoPay's payment capabilities and functions. - [U.S. and Canadian Bank Payments](https://docs.vopay.com/docs/us-and-canadian-bank-payments.md): Similarities and differences between common payment schemes in Canada and the US - [Payment Rails](https://docs.vopay.com/docs/payment-rails.md): Explore our collection of payment methods. - [EFT (Electronic Funds Transfer)](https://docs.vopay.com/docs/eft.md) - [Return Codes](https://docs.vopay.com/docs/return-codes.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses.md) - [API Reference](https://docs.vopay.com/docs/eft-debit.md) - [Interac e-Transfer](https://docs.vopay.com/docs/interac-etransfer-payments.md): Get up to speed with Canada's favorite payment rail. - [Interac e-Transfer: Send ](https://docs.vopay.com/docs/bulk-e-transfer.md): Send single or bulk digital payments to Canadian individuals or businesses with near real-time payouts - [Interac e-Transfer: Request Money](https://docs.vopay.com/docs/interac-money-request.md): Sending instant money requests to Canadian individuals or businesses allowing for real-time collections - [Interac e-Transfer: Inbound](https://docs.vopay.com/docs/inbound-e-transfers.md) - [Return Codes](https://docs.vopay.com/docs/return-codes-3.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows-3.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-1.md) - [API Reference](https://docs.vopay.com/docs/api-reference-1.md) - [ACH (Automated Clearing House)](https://docs.vopay.com/docs/ach.md) - [Return Codes](https://docs.vopay.com/docs/return-codes-1.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows-1.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-2.md) - [API Reference](https://docs.vopay.com/docs/api-reference-2.md) - [VoPay Instant™](https://docs.vopay.com/docs/vopay-instant.md) - [Return Codes](https://docs.vopay.com/docs/return-codes-2.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows-4.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-3.md) - [API Reference](https://docs.vopay.com/docs/api-reference-3.md) - [RTP (Real-Time Payments)](https://docs.vopay.com/docs/rtp-real-time-payments.md) - [Return Codes](https://docs.vopay.com/docs/return-codes-4.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows-5.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-4.md) - [API Reference](https://docs.vopay.com/docs/api-reference-4.md) - [Return Codes](https://docs.vopay.com/docs/error-codes.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows-6.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-5.md) - [API Reference](https://docs.vopay.com/docs/api-reference-5.md) - [Return Codes](https://docs.vopay.com/docs/return-codes-5.md) - [Submission Windows](https://docs.vopay.com/docs/submission-windows-2.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-6.md) - [API References](https://docs.vopay.com/docs/api-references.md) - [Debit Card Payments](https://docs.vopay.com/docs/visa-direct.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-7.md) - [API Reference](https://docs.vopay.com/docs/api-reference-6.md) - [Credit Card Payments](https://docs.vopay.com/docs/credit-card-payments.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-8.md) - [API Reference](https://docs.vopay.com/docs/api-reference-7.md) - [Test Card Numbers & 3D Secure Testing](https://docs.vopay.com/docs/test-card-numbers-3d-secure-testing.md) - [Digital Wallets (Google Pay & Apple Pay)](https://docs.vopay.com/docs/digital-wallets-google-pay-apple-pay.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-9.md) - [API Reference](https://docs.vopay.com/docs/api-reference-8.md) - [PayPal & Venmo](https://docs.vopay.com/docs/paypal-venmo.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-10.md) - [API Reference](https://docs.vopay.com/docs/api-reference-9.md) - [Bill Pay](https://docs.vopay.com/docs/bill-pay.md) - [Transaction Statuses](https://docs.vopay.com/docs/transaction-statuses-11.md) - [API Reference](https://docs.vopay.com/docs/api-reference-10.md) - [Flagged Transactions](https://docs.vopay.com/docs/flagged-transactions.md) - [eLinx™ Payment Link Technology](https://docs.vopay.com/docs/elinx.md): Versatile payment link technology. - [eLinx Pay](https://docs.vopay.com/docs/elinx-pay.md): Pay and get paid using payment links. - [eLinx Connect](https://docs.vopay.com/docs/elinx-connect.md): Connect customer accounts using secure links. - [eLinx Flexible Payments](https://docs.vopay.com/docs/elinx-flexible-payments.md): Offer financial flexibility to payors. - [Micro Deposit Verification for Bank Accounts](https://docs.vopay.com/docs/vopay-verify-bank-account-verification-in-real-time.md): Real-time Bank Account Validation Expected To Deliver Faster Onboarding For Enterprises - [Digital Debit Agreement](https://docs.vopay.com/docs/digital-debit-agreement.md): VoPay provides a digital debit agreement that seamlessly integrates with US and Canadian bank payments ## Guides: Orchestration - [API Reference](https://docs.vopay.com/docs/api-reference.md) ## Guides: Accounts - [Ledger Management](https://docs.vopay.com/docs/ledger-management.md): An out-of-the-box ledger and wallet offering - [Master Account](https://docs.vopay.com/docs/master-account.md) - [Account Transfers](https://docs.vopay.com/docs/transfers-between-vopay-accounts.md) - [Virtual Accounts](https://docs.vopay.com/docs/virtual-accounts.md) - [Canadian Virtual Accounts](https://docs.vopay.com/docs/canadian-virtual-accounts.md) ## Guides: Webhooks - [Overview](https://docs.vopay.com/docs/overview.md) - [Events](https://docs.vopay.com/docs/events.md) - [Re-triggering a Webhook Notification](https://docs.vopay.com/docs/re-triggering-a-webhook-notification.md) - [Signature Verification](https://docs.vopay.com/docs/signature-verification.md) ## Guides: Open Banking Integrations - [Plaid Integration](https://docs.vopay.com/docs/plaid-integration.md) - [MX Integration](https://docs.vopay.com/docs/mx-integration.md): Open banking integration between MX and VoPay - [Flinks Integration](https://docs.vopay.com/docs/flinks-integration.md) ## Guides: PARTNERS - [Introduction to Partners](https://docs.vopay.com/docs/introduction-to-partner-api.md): VoPay provides a dedicated set of capabilities for partner entities ## Guides: Tax Remittance - [Tax Remittance](https://docs.vopay.com/docs/tax-remittance.md): Pay Canadian federal and provincial business taxes programmatically — payroll source deductions, GST/HST, corporate tax, and more — with a single API call. ## Guides: Cross-Border - [Cross-Border Payments Integration Guide](https://docs.vopay.com/docs/cross-border-payments-integration-guide.md): Embed VoPay's cross-border payment experience in your application, and connect the optional balance-check and transaction-review hooks that give you control over every payout. - [Global Send Admin Dashboard](https://docs.vopay.com/docs/global-send-admin-dashboard.md): A white-label operations console for your cross-border payment program — embed it in your own web application, brand it as your own, and manage everything from FX markups to compliance settings in… - [Cross-Border Funds Flow](https://docs.vopay.com/docs/cross-border-funds-flow.md): How money actually moves — from the sender to the recipient — under the two engagement models for VoPay's cross-border solution. ## API Reference: API Overview - [Getting Started With Your API](https://docs.vopay.com/reference/getting-started-with-your-api.md): This page will help you get started with the VoPay API. ## API Reference: Accounts - [partner/account](https://docs.vopay.com/reference/accountpost.md): This endpoint is used to create a VoPay account. You will need to sign-up as a partner account in order to use this endpoint and start creating VoPay accounts for your users. - [partner/account](https://docs.vopay.com/reference/accountget.md): This endpoint is used to get a list of accounts created using a partner account. It will return the accounts data including shareholder, signing authority and balance information - [partner/account/business-case](https://docs.vopay.com/reference/accountbusinesscasepost.md): This endpoint is used to provide the use cases for the VoPay account you are onboarding. - [partner/account/set-permissions](https://docs.vopay.com/reference/accountsetpermissionspost.md): This endpoint will allow a partner to modify the permissions and the maximum amounts for their accounts. - [partner/billing-packages](https://docs.vopay.com/reference/partnerbillingpackagesget.md): This endpoint is used to retrieve the list of billing packages that you can assign to an account. - [partner/invoice-details](https://docs.vopay.com/reference/partnerinvoicedetailsget.md): This endpoint is used to retrieve the invoice-details (number of transactions, rates, etc) for a given billing cycle. If no month/year is provided, the current month/year is used. - [partner/account/transactions](https://docs.vopay.com/reference/partneraccounttransactionsurlget.md): This endpoint is used to fetch all the transactions belonging to your accounts - [partner/account/transfer](https://docs.vopay.com/reference/partneraccounttransferpost.md): This endpoint allows you to transfer funds between VoPay accounts. - [partner/account/fund-transfer](https://docs.vopay.com/reference/partneraccountfundtransferpost.md): This endpoint will fund the Debitor account using their default bank account, and then trigger an account transfer to the recipient account once the funds have been cleared. To set a default bank… - [partner/account/transfer-withdraw](https://docs.vopay.com/reference/partneraccounttransferwithdrawpost.md): This endpoint will transfer money from the debitor account to the recipient account, and then immediately withdraw the money from the recipient account into their default bank account. To set a… - [partner/account/fund-transfer-withdraw](https://docs.vopay.com/reference/partneraccountfundtransferwithdrawpost.md): This endpoint will fund the debitor account using their default bank account, and then transfer the money to the recipient account once the funds have been cleared. Once the funds are transferred, a… - [partner/account/onboarding-url](https://docs.vopay.com/reference/partneraccountonboardingurlget.md): This endpoint is used to fetch the onboarding URL for an account in the Application Pending stage - [partner/create-partner](https://docs.vopay.com/reference/partnercreatepartnerpost.md): This endpoint allows Technology partner accounts to create new partner accounts. Only partner accounts with PartnerCreationEnabled and a Technology account type can use this endpoint. - [partner/account/edit](https://docs.vopay.com/reference/partneraccounteditpost.md): This endpoint is used to edit a VoPay account that belongs to your partner account. - [partner/account/deactivate](https://docs.vopay.com/reference/partneraccountdeactivatepost.md): This endpoint is used to deactivate a VoPay account that belongs to your partner account. - [partner/profile/update-contact](https://docs.vopay.com/reference/partnerprofileupdatecontactpost.md): This endpoint is used to update the contact information on your own partner account profile. It performs a partial update: only the fields you provide are changed, and any field left out or sent… - [partner/account/status-summary](https://docs.vopay.com/reference/accountstatussummaryget.md): This endpoint returns per-status account counts across the partner's book of accounts. - [partner/default-payment-method](https://docs.vopay.com/reference/partnerdefaultpaymentmethodget.md): This endpoint returns your partner account's default payment method. This payment method is used when collecting money for your monthly invoice. - [partner/set-default-payment-method](https://docs.vopay.com/reference/partnersetdefaultpaymentmethodpost.md): This endpoint allows you to set your partner account's default payment method. This payment method will be used when collecting money for your monthly invoice. The default payment method is your… - [partner/invoices](https://docs.vopay.com/reference/partnerinvoicesget.md): This endpoint is used to retrieve the list of invoices issued to your partner account. Results can be narrowed by invoice period, currency and a free-text search. - [account/balance](https://docs.vopay.com/reference/accountbalanceget.md): This endpoint returns details on your current account balance and available funds. - [account/balances](https://docs.vopay.com/reference/accountbalancesget.md): This endpoint returns details on your current account balances and available funds for all currencies associated with your account. Unlike /account/balance which returns a single currency, this… - [account/fund-my-account](https://docs.vopay.com/reference/accountfundmyaccountpost.md): This endpoint will fund your VoPay account by debiting your default bank account or charging your default operational credit card. To set a default bank account, please use the… - [account/fund-my-account/schedule](https://docs.vopay.com/reference/accountfundmyaccountschedulepost.md): This endpoint will create a scheduled transaction to fund your VoPay account by debiting your default bank account or charging your default operational credit card. To set a default bank account,… - [account/withdraw-my-account](https://docs.vopay.com/reference/accountwithdrawmyaccountpost.md): This endpoint will credit your default bank account by withdarwing funds from your VoPay account. To set a default bank account, please use the /bank-account/set-my-bank-account endpoint. - [account/withdraw-my-account/schedule](https://docs.vopay.com/reference/accountwithdrawmyaccountschedulepost.md): This endpoint will create a scheduled transaction to credit your default bank account by withdarwing funds from your VoPay account. To set a default bank account, please use the… - [account/transactions](https://docs.vopay.com/reference/accounttransactionsget.md): This endpoint returns a list all of the transactions which affect the account balance. This endpoint only returns basic information on the transactions. More detailed information on individual… - [account/transactions/codes](https://docs.vopay.com/reference/accounttransactionscodesget.md): This endpoint returns a list all of transaction codes that can be assigned to transactions. - [account/transactions/gl-codes](https://docs.vopay.com/reference/accounttransactionsglcodesget.md): This endpoint returns a list all of your GL codes that can be assigned to transactions. Note, you must connect your accounting software to your account in order to use this endpoint. - [account/remaining-limit](https://docs.vopay.com/reference/accountremaininglimitget.md): This endpoint returns the remaining daily, weekly and monthly transaction limits for your VoPay account. If not limits are currently set for your VoPay account, N/A will be returned for each. - [account/transfer-to](https://docs.vopay.com/reference/accounttransfertopost.md): This endpoint allows you to transfer funds between VoPay accounts and/or Client accounts. - [account/auto-balance-transfer](https://docs.vopay.com/reference/accountautobalancetransferpost.md): This endpoint allows you to set up an auto-balance transfer from your VoPay account to your default operational bank account. The frequency available to set the auto-transfer can be daily, weekly,… - [account/auto-balance-transfer](https://docs.vopay.com/reference/accountautobalancetransferget.md): This endpoint is used to retrieve the information of your auto balance transfer. This option requires special permissions. - [account/transactions/recent](https://docs.vopay.com/reference/accounttransactionsrecentget.md): This endpoint returns a list of recent transactions for a specific contact or client account. - [account/auto-balance-transfer-list](https://docs.vopay.com/reference/accountautobalancetransferlistget.md): This endpoint is used to retrieve a list of all your auto balance transfers. This option requires special permissions. - [account/auto-balance-transfer/cancel](https://docs.vopay.com/reference/accountautobalancetransfercancelpost.md): This endpoint allows you to cancel an auto balance transfer. This option requires special permissions. - [account/auto-balance-transfer/report](https://docs.vopay.com/reference/accountautobalancetransferreportget.md): This endpoint returns the list of transactions associated with an auto balance transfer. The sum of all debits/credits should match the amount on the auto-balance transfer. - [account/authorized-ips](https://docs.vopay.com/reference/accountauthorizedipspost.md): This endpoint allows an account's authorized IP addresses to be updated. As updating the authorized IP addresses will overwrite the existing list, GET the list prior to issuing a POST if you wish to… - [account/authorized-ips](https://docs.vopay.com/reference/accountauthorizedipsget.md): This endpoint retrieves an account's authorized IP addresses. - [account/set-default-payment-method](https://docs.vopay.com/reference/accountsetdefaultpaymentmethodpost.md): This endpoint allows you to set your account's default payment method. This payment method will be used when collecting money for you monthly invoice. The default payment method is your VoPay account. - [account/transaction/history](https://docs.vopay.com/reference/accounttransactionhistorypost.md): Retrieves the history for a specific transaction. - [account/pre-funding-settings](https://docs.vopay.com/reference/accountprefundingsettingspost.md): This endpoint is used to configure your account's pre-funding settings. When pre-funding is enabled, outbound transactions are automatically backed by a funding transaction pulled from your default… - [account/pre-funding-settings](https://docs.vopay.com/reference/accountprefundingsettingsget.md): This endpoint is used to retrieve your account's pre-funding settings. - [account/operational-accounts](https://docs.vopay.com/reference/accountoperationalaccountsget.md): This endpoint returns the account's default operational payment methods in one call: the default operational bank account(s) (the same data as the operational portion of… - [account/funding-options](https://docs.vopay.com/reference/accountfundingoptionsget.md): This endpoint returns the ways this account can fund transactions: the VoPay balance, the default operational bank account (when FundMyAccountEnabled) with its settlement time, and credit card (when… - [account/subaccount](https://docs.vopay.com/reference/subaccountpost.md): This endpoint is used to create a new sub-account. - [account/subaccount](https://docs.vopay.com/reference/subaccountget.md): This endpoint will return a list of all of the sub-accounts managed by the main account. - [account/subaccount/transactions](https://docs.vopay.com/reference/subaccounttransactionget.md): This endpoint will return a list of all of the transactions for sub-accounts, and its sub-accounts transaction. - [account/subaccount/set-permissions](https://docs.vopay.com/reference/subaccountsetpermissionspost.md): This endpoint will allow the user to modify the permissions and the maximum amounts to their sub-accounts in the API. The main account will be able to only modify the permission that he has, For… - [account/subaccount/send-onboarding-application](https://docs.vopay.com/reference/subaccountsendonboardingapplicationpost.md): This endpoint will allow the user to resend an application to the sub-account. The sub-account must be in Application Pending status for the applicattion to be sent. - [account/subaccount/edit](https://docs.vopay.com/reference/subaccounteditpost.md): This endpoint is used to edit a sub-account. - [account/subaccount/deactivate](https://docs.vopay.com/reference/subaccountdeactivatepost.md): This endpoint is used to deactivate a sub-account. ## API Reference: Account Onboarding - [account/submit-extended-info/shareholder-info](https://docs.vopay.com/reference/accountshareholderinfoget.md): This endpoint will return a full list of all shareholder information. - [account/submit-extended-info/shareholder-info/add](https://docs.vopay.com/reference/accountshareholderpost.md): This endpoint is used to insert the shareholder information for a newly created VoPay account. - [account/submit-extended-info/shareholder-info/edit](https://docs.vopay.com/reference/accountshareholdereditpost.md): This endpoint is used to edit an existing shareholder linked to your VoPay account. You will need to provide the Shareholder ID, which you can get from the GET /account/shareholder-info endpoint - [account/submit-extended-info/signing-authority-info](https://docs.vopay.com/reference/accountsigningauthorityinfoget.md): This endpoint will return a full list of all signing-authority information. - [account/submit-extended-info/signing-authority-info/add](https://docs.vopay.com/reference/accountsigningauthorityaddpost.md): This endpoint is used to insert the signing authority information for a newly created VoPay account. - [account/submit-extended-info/signing-authority-info/edit](https://docs.vopay.com/reference/accountsigningauthorityeditpost.md): This endpoint is used to edit an existing signing authority linked to your VoPay account. You will need to provide the Signing Authority ID, which you can get from the GET… - [account/business-types](https://docs.vopay.com/reference/accountbusinesstypesget.md): This endpoint can be used to return a list of industries and categories under which a company can be classified. The response will be an array of industry types nested within an array of sub… - [document](https://docs.vopay.com/reference/documentpost.md): This endpoint is used to upload account documents.Only one document can be uploaded by request. You must provide the document name and its content. Here are some rules regarding the document… - [document/[DocumentID]](https://docs.vopay.com/reference/documenturlget.md): To retrieve a document once it is uploaded, send a request to this endpoint. It will return the document URL so you can have direct access to it. Replace the {DocumentID} in the endpoint with the… ## API Reference: Client Accounts - [account/client-accounts/individual](https://docs.vopay.com/reference/clientaccountindividualpost.md): Use this endpoint to create a new individual client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers. - [account/client-accounts/business](https://docs.vopay.com/reference/clientaccountbusinesspost.md): Use this endpoint to create a new business client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all business and bank account details from those providers. - [account/client-accounts/receive-only](https://docs.vopay.com/reference/clientaccountreceiveonlypost.md): Use this endpoint to create a new receive-only client account (a client account that can receive funds but cannot send or transfer them - CanReceive=1, CanSend=0). The account keeps a real ClientType… - [account/client-accounts/standard](https://docs.vopay.com/reference/clientaccountstandardpost.md): Use this endpoint to create a new standard client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers. Otherwise, must… - [account/client-accounts/send-only](https://docs.vopay.com/reference/clientaccountsendonlypost.md): Use this endpoint to create a new send-only client account (a client account that can send and transfer funds but cannot be credited - CanSend=1, CanReceive=0). The account keeps a real ClientType… - [account/client-accounts](https://docs.vopay.com/reference/clientaccountget.md): This endpoint returns a list of the available client accounts and some of its details. It is also possible to filter the list of client accounts by ClientAccountID, its status (active or inactive),… - [account/client-accounts/balance](https://docs.vopay.com/reference/clientaccountbalanceget.md): This endpoint returns details on the current account balance and available funds for the given Client account. - [account/client-accounts/edit](https://docs.vopay.com/reference/clientaccounteditpost.md): This endpoint allows you to edit the KYC info of the given Client account. - [account/client-accounts/delete](https://docs.vopay.com/reference/clientaccountdeletepost.md): This endpoint will delete an active client account. - [account/client-accounts/deactivate](https://docs.vopay.com/reference/clientaccountdeactivatepost.md): This endpoint will deactivate an active client account. - [account/client-accounts/activate](https://docs.vopay.com/reference/clientaccountactivatepost.md): This endpoint will activate an inactive client account. - [account/client-accounts/generate-embed-url](https://docs.vopay.com/reference/clientaccountgenerateembedurlpost.md): Use this endpoint to generate a unique URL to onboard a new client account. To send an email containing the URL to the recipient, set SendEmail = true, and provide both the email address and full… - [account/client-accounts/payment-methods](https://docs.vopay.com/reference/clientaccountpaymentmethodsget.md): This endpoint is used to look up all the payment smethods for the given client account. - [account/client-accounts/label](https://docs.vopay.com/reference/clientaccountlabelget.md): This endpoint returns all the created Labels for the given Client account. - [account/client-accounts/label/add](https://docs.vopay.com/reference/clientaccountlabeladdpost.md): This endpoint allows you to create a Label. - [account/client-accounts/label/delete](https://docs.vopay.com/reference/clientaccountlabeldeletepost.md): This endpoint allows you to delete a Label. - [account/client-accounts/notes/add](https://docs.vopay.com/reference/clientaccountnotesaddpost.md): This endpoint is used to add a note to your client account. - [account/client-accounts/notes/edit](https://docs.vopay.com/reference/clientaccountnoteseditpost.md): This endpoint is used to edit a note associated with your client account. - [account/client-accounts/notes/delete](https://docs.vopay.com/reference/clientaccountnotesdeletepost.md): This endpoint is used to delete a note record from you client account. - [account/client-accounts/notes](https://docs.vopay.com/reference/clientaccountnotesget.md): This endpoint is used to look up all the notes associated with the given client account. - [account/client-accounts/transfer](https://docs.vopay.com/reference/clientaccounttransferpost.md): This endpoint will transfer money directly from the debitor client account to the recipient client account. Both client accounts must be active. - [account/client-accounts/fund-transfer](https://docs.vopay.com/reference/clientaccountfundtransferpost.md): This endpoint will fund the Debitor client account using their default bank account, and then trigger an account transfer to the recipient client account once the funds have been cleared. To set a… - [account/client-accounts/transfer-withdraw](https://docs.vopay.com/reference/clientaccounttransferwithdrawpost.md): This endpoint will transfer money from the debitor client account to the recipient client account, and then immediately withdraw the money from the recipient client account into their default bank… - [account/client-accounts/fund-transfer-withdraw](https://docs.vopay.com/reference/clientaccountfundtransferwithdrawpost.md): This endpoint will fund the debitor client account using their default bank account, and then transfer the money to the recipient client account once the funds have been cleared. Once the funds are… - [account/client-accounts/transactions](https://docs.vopay.com/reference/accountclientaccounttransactionsget.md): This endpoint returns a list all of the transactions which affect the account balance. This endpoint only returns basic information on the transactions. More detailed information on individual… - [account/client-accounts/fund-transfer/schedule](https://docs.vopay.com/reference/clientaccountfundtransferschedulepost.md): This endpoint is used to schedule a fund-transfer between two client accounts. - [account/client-accounts/transfer-withdraw/schedule](https://docs.vopay.com/reference/clientaccounttransferwithdrawschedulepost.md): This endpoint is used to schedule a transfer-withdraw between two client accounts. - [account/client-accounts/fund-transfer-withdraw/schedule](https://docs.vopay.com/reference/clientaccountfundtransferwithdrawschedulepost.md): This endpoint is used to schedule a fund-transfer-withdraw between two client accounts. - [account/client-accounts/transfer/schedule/cancel](https://docs.vopay.com/reference/clientaccounttransferschedulecancelpost.md): This endpoint is used to cancel a scheduled client account transfer and all remaining payments belonging to that scheduled transfer. Only scheduled transfers with the status in progress can be… - [account/client-accounts/scheduled-transfers](https://docs.vopay.com/reference/clientaccountscheduledtransfers.md): This endpoint is used to look up either the list of all scheduled client account transfers, or to list the details of a single scheduled client account transfer. If the value ScheduledTransferID… - [account/client-accounts/wallets](https://docs.vopay.com/reference/clientaccounwalletsget.md): This endpoint allows you to retrieve a list of wallets belong to a client account. - [account/client-accounts/wallets/create](https://docs.vopay.com/reference/clientaccountwalletscreatepost.md): This endpoint allows you to create a new wallet for your client account. - [account/client-accounts/wallets/transfer](https://docs.vopay.com/reference/clientaccountwalletstransferpost.md): This endpoint allows you to transfer funds between two wallets. Both wallet IDs must belong to the provided client account. - [account/client-accounts/wallets/delete](https://docs.vopay.com/reference/clientaccountwalletsdeletepost.md): This endpoint allows you to delete a wallet if the wallet balance is 0. - [account/client-accounts/wallets/edit](https://docs.vopay.com/reference/clientaccountwalletseditpost.md): This endpoint allows you to edit a wallet for your client account. - [account/client-accounts/wallets/deactivate](https://docs.vopay.com/reference/clientaccountwalletsdeactivatepost.md): This endpoint allows you to deactivate a wallet for your client account. - [account/client-accounts/wallets/activate](https://docs.vopay.com/reference/clientaccountwalletsactivatepost.md): This endpoint allows you to activate a wallet for your client account. - [account/client-accounts/auto-balance-transfer](https://docs.vopay.com/reference/clientaccountautobalancetransferpost.md): This endpoint allows you to set up an auto-balance transfer from your VoPay account to your default operational bank account. The frequency available to set the auto-transfer can be daily, weekly,… - [account/client-accounts/auto-balance-transfer](https://docs.vopay.com/reference/clientaccountautobalancetransferget.md): This endpoint is used to retrieve the information of your auto balance transfer. This option requires special permissions. - [account/client-accounts/auto-balance-transfer/cancel](https://docs.vopay.com/reference/clientaccountautobalancetransfercancelpost.md): This endpoint allows you to cancel an auto balance transfer. This option requires special permissions. - [account/client-accounts/auto-balance-transfer/report](https://docs.vopay.com/reference/clientaccountautobalancetransferreportget.md): This endpoint returns the list of transactions associated with an auto balance transfer. The sum of all debits/credits should match the amount on the auto-balance transfer. - [account/client-accounts/auto-balance-transfer-list](https://docs.vopay.com/reference/clientaccountautobalancetransferlistget.md): This endpoint is used to retrieve a list of all your auto balance transfers. This option requires special permissions. ## API Reference: Contact - [contacts/add](https://docs.vopay.com/reference/contactaddpost.md): This endpoint is used to add a new contact record for the given account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers. - [contacts/edit](https://docs.vopay.com/reference/contacteditpost.md): This endpoint is used to add a new contact record for the given account. - [contacts/deactivate](https://docs.vopay.com/reference/contactdeactivatepost.md): This endpoint is used to deactivate a contact - [contacts/activate](https://docs.vopay.com/reference/contactactivatepost.md): This endpoint is used to activate a contact - [contacts](https://docs.vopay.com/reference/contactget.md): This endpoint is used to get a list of contacts associated with the account. - [contacts/payment-methods](https://docs.vopay.com/reference/contactpaymentmethodsget.md): This endpoint is used to look up all the payment methods for the given contact. - [contacts/transactions](https://docs.vopay.com/reference/contacttransactionsget.md): This endpoint is used to get a list of transactions associated with a contact. - [account/contact/generate-embed-url](https://docs.vopay.com/reference/clientaccountgenerateembedurlpost-1.md): Use this endpoint to generate a unique URL to onboard a new contact. To send an email containing the URL to the recipient, set SendEmail = true, and provide both the email address and full name of… - [contacts/notes/add](https://docs.vopay.com/reference/contactnotesaddpost.md): This endpoint is used to add a note to your contact. - [contacts/notes/edit](https://docs.vopay.com/reference/contactnoteseditpost.md): This endpoint is used to edit a note associated with your contact. - [contacts/notes/delete](https://docs.vopay.com/reference/contactnotesdeletepost.md): This endpoint is used to delete a note record from you contact. - [contacts/notes](https://docs.vopay.com/reference/contactnotesget.md): This endpoint is used to look up all the notes associated with the given contact. - [contacts/label](https://docs.vopay.com/reference/contactlabelget.md): This endpoint returns all the created Labels for the given Contact. - [contacts/label/add](https://docs.vopay.com/reference/contactlabeladdpost.md): This endpoint allows you to create a Label. - [contacts/label/delete](https://docs.vopay.com/reference/contactlabeldeletepost.md): This endpoint allows you to delete a Label. ## API Reference: Payment Methods - [credit-card/generate-embed-url](https://docs.vopay.com/reference/creditcardgenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to provide their credit card information, which can be used in the… - [credit-card/delete](https://docs.vopay.com/reference/creditcarddeletepost.md): This endpoint allows you to delete a credit card associated with your VoPay account - [credit-card](https://docs.vopay.com/reference/creditcardget.md): This endpoint retrieves a list of credit cards associated with your VoPay account - [credit-card/set-my-credit-card](https://docs.vopay.com/reference/creditcardsetmycreditcardpost.md): This endpoint allows you to identify a credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a credit card as being the VoPay account holder's… - [credit-card/default-credit-card](https://docs.vopay.com/reference/creditcarddefaultcreditcardget.md): This endpoint retrieves the default credit card associated with your VoPay account - [debit-card/generate-embed-url](https://docs.vopay.com/reference/debticardgenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to provide their card information, which can be used in the… - [debit-card/delete](https://docs.vopay.com/reference/debitcarddeletepost.md): This endpoint allows you to delete a debit card associated with your VoPay account - [debit-card](https://docs.vopay.com/reference/debitcardget.md): This endpoint retrieves a list of debit cards associated with your VoPay account - [debit-card/set-debit-card](https://docs.vopay.com/reference/debitcardsetdebitcardpost.md): This endpoint allows you to identify a debit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a debit card as being the VoPay account holder's default… - [debit-card/default-debit-card](https://docs.vopay.com/reference/debitcarddefaultdebitcardget.md): This endpoint retrieves the default debit card associated with your VoPay account - [bank-account/generate-embed-url](https://docs.vopay.com/reference/bankaccountgenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to log in to their online banking and select a bank account to make a payment… - [bank-account/add](https://docs.vopay.com/reference/bankaccountaddpost.md): This endpoint allows you to add a bank account to your VoPay account - [bank-account/delete](https://docs.vopay.com/reference/bankaccountdeletepost.md): This endpoint allows you to delete a bank account associated with your VoPay account - [bank-account](https://docs.vopay.com/reference/bankaccountget.md): This endpoint retrieves a list of bank accounts associated with your VoPay account - [bank-account/set-my-bank-account](https://docs.vopay.com/reference/bankaccountsetmybankaccountpost.md): This endpoint allows you to identify a bank account as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a bank account as being the VoPay account holder's… - [bank-account/default-bank-account](https://docs.vopay.com/reference/bankaccountdefaultbankaccountget.md): This endpoint retrieves the default bank account associated with your VoPay account - [interac/email/add](https://docs.vopay.com/reference/emailaddpost.md): This endpoint allows you to add an Interac email to your VoPay account. Optionally, you can use this enpoint to also set the email as default for the VoPay account. - [interac/email/edit](https://docs.vopay.com/reference/emaileditpost.md): This endpoint allows you to update an Interac email associated with your VoPay account. - [interac/email/delete](https://docs.vopay.com/reference/emaildeletepost.md): This endpoint allows you to delete an Interac email associated with your VoPay account. - [interac/email](https://docs.vopay.com/reference/emailget.md): This endpoint retrieves a list of Interac emails associated with your VoPay account. - [interac/email/set-my-email](https://docs.vopay.com/reference/emailsetmyemailpost.md): This endpoint allows you to identify an Interac email as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify an Interac email as being the VoPay account holder's… - [interac/email/default-email](https://docs.vopay.com/reference/emaildefaultemailget.md): This endpoint retrieves the default Interac email associated with your VoPay account. - [interac/auto-deposit](https://docs.vopay.com/reference/interacautodepositget.md): This endpoint is used to fetch Interac auto-deposit status. - [google-pay/generate-embed-url](https://docs.vopay.com/reference/googlepaygenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to login to their Google account and generate a token, which can be used in the… - [google-pay/delete](https://docs.vopay.com/reference/googlepaydeletepost.md): This endpoint allows you to delete a Google Pay token associated with your VoPay account - [google-pay](https://docs.vopay.com/reference/googlepayget.md): This endpoint retrieves a list of Google Pay credit cards associated with your VoPay account - [google-pay/set-my-google-pay](https://docs.vopay.com/reference/googlepaysetmygooglepaypost.md): This endpoint allows you to identify a Google Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Google Pay credit card as being the VoPay… - [google-pay/default-google-pay](https://docs.vopay.com/reference/googlepaydefaultgooglepayget.md): This endpoint retrieves the default Google Pay credit card associated with your VoPay account - [apple-pay/generate-embed-url](https://docs.vopay.com/reference/applepaygenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to login to their Apple account and generate a token, which can be used in the… - [apple-pay/delete](https://docs.vopay.com/reference/applepaydeletepost.md): This endpoint allows you to delete a Apple Pay token associated with your VoPay account - [apple-pay](https://docs.vopay.com/reference/applepayget.md): This endpoint retrieves a list of Apple Pay credit cards associated with your VoPay account - [apple-pay/set-my-apple-pay](https://docs.vopay.com/reference/applepaysetmyapplepaypost.md): This endpoint allows you to identify a Apple Pay credit card as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Apple Pay credit card as being the VoPay… - [apple-pay/default-apple-pay](https://docs.vopay.com/reference/applepaydefaultapplepayget.md): This endpoint retrieves the default Apple Pay credit card associated with your VoPay account - [apple-pay/link-apple-pay](https://docs.vopay.com/reference/applepaylinkapplepaypost.md): This endpoint links an Apple Pay payment token to your VoPay account and returns the VoPay token used to charge it. It is called by the iQ11 iframe once the customer has authorized the payment in the… - [paypal/add](https://docs.vopay.com/reference/paypaladdpost.md): This endpoint allows you to add a PayPal account to your VoPay account - [paypal/delete](https://docs.vopay.com/reference/paypaldeletepost.md): This endpoint allows you to delete a PayPal account from your VoPay account - [paypal/recipients](https://docs.vopay.com/reference/paypalrecipientsget.md): This endpoint allows you fetch a list all of your PayPal recipients - [paypal/set-my-recipient](https://docs.vopay.com/reference/paypalsetmyrecipientpost.md): This endpoint allows you to identify a PayPal recipient as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a PayPal recipient as being the VoPay account… - [paypal/default-recipient](https://docs.vopay.com/reference/paypaldefaultrecipientget.md): This endpoint retrieves the default PayPal recipient associated with your VoPay account - [paypal/withdraw/generate-embed-url](https://docs.vopay.com/reference/paypalgenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to login to their PayPal account and generate a token, which can be used in the… - [venmo/add](https://docs.vopay.com/reference/venmoaddpost.md): This endpoint allows you to add a Venmo account to your VoPay account - [venmo/delete](https://docs.vopay.com/reference/venmodeletepost.md): This endpoint allows you to delete a Venmo account from your VoPay account - [venmo/recipients](https://docs.vopay.com/reference/venmorecipientsget.md): This endpoint allows you fetch a list all of your Venmo recipients - [venmo/set-my-recipient](https://docs.vopay.com/reference/venmosetmyrecipientpost.md): This endpoint allows you to identify a Venmo recipient as belonging to the VoPay account holder. Optionally, you can use this endpoint to identify a Venmo recipient as being the VoPay account… - [venmo/default-recipient](https://docs.vopay.com/reference/venmodefaultrecipientget.md): This endpoint retrieves the default Venmo recipient associated with your VoPay account - [venmo/withdraw/generate-embed-url](https://docs.vopay.com/reference/venmogenerateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to login to their Venmo account and generate a token, which can be used in the… - [zelle/withdraw](https://docs.vopay.com/reference/zellewithdrawpost.md): Initiate a Zelle B2C payment to a recipient identified by email address or mobile phone number. Zelle is available to United States accounts only; a request from an account registered in any other… - [zelle/withdraw/transaction](https://docs.vopay.com/reference/zellewithdrawtransactionget.md): Retrieve details of a specific Zelle withdrawal transaction. - [zelle/withdraw/transactions](https://docs.vopay.com/reference/zellewithdrawtransactionsget.md): List Zelle withdrawal transactions for the account within a specified date range. - [zelle/cancel](https://docs.vopay.com/reference/zellecancelpost.md): Cancel a pending Zelle withdrawal transaction. If the transaction has already been submitted to the processor, a cancellation request will be sent. A transaction that cannot be cancelled responds… - [zelle/recipients](https://docs.vopay.com/reference/zellerecipientsget.md): List saved Zelle recipients for the account. Recipients are automatically saved when a Zelle payment is submitted. - [zelle/link-recipient](https://docs.vopay.com/reference/zellelinkrecipientpost.md): Tokenize a Zelle recipient during an iFrame flow so it can later be referenced by token in zelle/withdraw. - [zelle/delete](https://docs.vopay.com/reference/zelledeletepost.md): Soft-delete a tokenized Zelle recipient so it is no longer returned or usable. - [zelle/set-my-recipient](https://docs.vopay.com/reference/zellesetmyrecipientpost.md): Flag a tokenized Zelle recipient as the default for the account or client-account scope. - [zelle/withdraw/decision](https://docs.vopay.com/reference/zellewithdrawdecisionpost.md): Approve or reject a Zelle payment that is in status 'pending decision'. A Zelle withdrawal enters 'pending decision' when the receiving bank flags that the recipient's registered name does not match… ## API Reference: Payment Rails - [eft/fund](https://docs.vopay.com/reference/eftfundpost.md): This endpoint is used to fund your VoPay account by debiting funds from the specified customer's bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.… - [eft/fund/status](https://docs.vopay.com/reference/eftfundstatusget.md): This endpoint is used to look up the status of a fund transaction. - [eft/fund/transaction](https://docs.vopay.com/reference/eftfundtransactionget.md): This endpoint is used to look up and return the full details on a single fund transaction. Fund transactions take money out of the customer's bank account and deposit them into your account. - [eft/withdraw](https://docs.vopay.com/reference/eftwithdrawpost.md): This endpoint is used to take funds out of your VoPay account, and deposit them to the specified recipient's bank account. In the below endpoint, either CompanyName OR FirstName and LastName must be… - [eft/withdraw/transaction](https://docs.vopay.com/reference/eftwithdrawtransactionget.md): This endpoint is used to look up details on a single withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account. - [eft/withdraw/status](https://docs.vopay.com/reference/eftwithdrawstatusget.md): This endpoint is used to look up the status of a withdraw transaction. - [eft/fund/schedule](https://docs.vopay.com/reference/eftschedulepost.md): This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. Either CompanyName OR FirstName and LastName must be provided. If either Token,… - [eft/withdraw/schedule](https://docs.vopay.com/reference/eftwithdrawschedulepost.md): This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. Either CompanyName OR FirstName and LastName must be provided. If either Token,… - [eft/fund/schedule/cancel](https://docs.vopay.com/reference/eftschedulecancelpost.md): This endpoint is used to cancel a scheduled transaction and all remaining payments belonging to that scheduled tranaction. Only scheduled transactions with the status in progress can be cancelled.… - [eft/withdraw/schedule/cancel](https://docs.vopay.com/reference/eftwithdrawschedulecancelpost.md): This endpoint is used to cancel a scheduled transaction and all remaining payments belonging to that scheduled tranaction. Only scheduled transactions with the status in progress can be cancelled.… - [eft/fund/schedule/edit](https://docs.vopay.com/reference/eftscheduleeditpost.md): This endpoint is used to edit or cancel an upcoming payment (only the amount can be edited). Notes. If the field amount is set as 0 or it is not provided, we consider the upcoming payment as… - [eft/withdraw/schedule/edit](https://docs.vopay.com/reference/eftwithdrawscheduleeditpost.md): This endpoint is used to edit or cancel an upcoming payment (only the amount can be edited). Notes. If the field amount is set as 0 or it is not provided, we consider the upcoming payment as… - [eft/scheduled-transactions](https://docs.vopay.com/reference/eftscheduledtransactionget.md): This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction. If the value ScheduledTransactionID is present, we only list… - [eft/failures](https://docs.vopay.com/reference/eftfailuresget.md): This endpoint is used to retrieve a list of transactions which failed during a specific date range. This endpoint is queried based on the date that a failure occurred on, not on the date when the… - [credit-card/charge](https://docs.vopay.com/reference/creditcardchargepost.md): This endpoint is to create a credit card transaction to fund your VoPay account, charging the amount specified to the credit card linked to the provided CreditCardToken. If a ClientAccountID is… - [credit-card/void](https://docs.vopay.com/reference/creditcardvoidpost.md): This endpoint allows you to void a completed credit card transaction. - [credit-card/charge/transaction](https://docs.vopay.com/reference/creditcardchargetransactionsget.md): This method is used to look up and return the full details on a single credit card transaction. Credit card transactions take money out of the customer's credit card and deposit them into your VoPay… - [debit-card/oct/push-funds](https://docs.vopay.com/reference/octpushfundspost.md): This endpoint is used to instantly send funds from your VoPay account to the debit card linked to the provided CardToken. If a ClientAccountID is provided, the client account's default card will be… - [debit-card/oct/transaction](https://docs.vopay.com/reference/octpushfundstransactionsget.md): This method is used to look up and return the full details on a single OCT transaction. OCT transactions sends money from your VoPay account directly onto the customer's debit card. - [debit-card/aft/pull-funds](https://docs.vopay.com/reference/aftpullfundspost.md): This endpoint is used to instantly pull funds from your debit card linked to the provided CardToken to fund your VoPay account. If a ClientAccountID is provided, the client account's default card… - [debit-card/aft/transaction](https://docs.vopay.com/reference/aftpullfundstransactionsget.md): This method is used to look up and return the full details on a single AFT transaction. AFT transactions pull money from you debit card directly into your VoPay account . - [interac/money-request](https://docs.vopay.com/reference/interacmoneyrequestpost.md): This API endpoint is used to create a new Interac money request transaction. If a ClientAccountID is provided, the client account's first/last name, and email address will be used for the… - [interac/money-request/transaction/request-cancellation](https://docs.vopay.com/reference/interacmoneyrequesttransactionscancelpost.md): This endpoint allows you to attempt to cancel an in progress money request transaction. Note that the cancellation request will fail if the recipient has already fulfilled the request. A successful… - [interac/money-request/transaction](https://docs.vopay.com/reference/interacmoneyrequesttransactionget.md): This endpoint is used to look up details on a single Interac money request transaction. This endpoint can be used to return transactions created with the API, or transactions submitted via SFTP batch… - [interac/bulk-payout](https://docs.vopay.com/reference/interacbulkpayoutpost.md): This endpoint is used to create an Interac e-Transfer bulk payout transaction for sending funds. If a ClientAccountID is provided, the client account's first/last name, and email address will be… - [interac/bulk-payout/transaction/request-cancellation](https://docs.vopay.com/reference/interactransactionscancelpost.md): This endpoint allows you to attempt to cancel an in progress bulk payout transaction. Note that the cancellation request will fail if the recipient has already deposited the funds, and successful… - [interac/bulk-payout/transaction](https://docs.vopay.com/reference/interacbulkpayouttransactionget.md): This endpoint is used to look up details on an Interac e-Transfer bulk payout transaction. - [interac/inbound/transaction](https://docs.vopay.com/reference/interacinboundetransfersget.md): This endpoint is used to look up details of Inbound ETransfer transactions. - [rtr/withdraw](https://docs.vopay.com/reference/rtrwithdrawpost.md): This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. Either an iq11 Token or… - [rtr/withdraw/transaction/request-cancellation](https://docs.vopay.com/reference/rtrtransactionscancelpost.md): 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. - [rtr/withdraw/transaction](https://docs.vopay.com/reference/rtrwithdrawtransactionget.md): 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. - [ach/fund](https://docs.vopay.com/reference/achfundpost.md): This endpoint is used to fund your US VoPay account by debiting funds from the specified customer's bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.… - [ach/withdraw](https://docs.vopay.com/reference/achwithdrawpost.md): This endpoint is used to send funds to a specified customer's US Bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided. If a ClientAccountID is… - [ach/fund/schedule](https://docs.vopay.com/reference/achfundschedulepost.md): This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. Either CompanyName OR FirstName and LastName must be provided. If the Token is… - [ach/withdraw/schedule](https://docs.vopay.com/reference/achwithdrawschedulepost.md): This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment. Either CompanyName OR FirstName and LastName must be provided. If the Token is… - [ach/void](https://docs.vopay.com/reference/achvoidpost.md): This method is used to void a previously created ACH transaction. Note, you can only void a transaction if it has not yet settled. If the transaction has already settled, then you can use the… - [ach/fund/transaction](https://docs.vopay.com/reference/achfundtransactionget.md): This endpoint is used to look up and return the full details on a single ACH fund transaction. - [ach/withdraw/transaction](https://docs.vopay.com/reference/achwithdrawtransactionget.md): This endpoint is used to look up details on a single ACH withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's bank account. - [ach/scheduled-transactions](https://docs.vopay.com/reference/achscheduledtransactionget.md): This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction. If the value ScheduledTransactionID is present, we only list… - [ach/failures](https://docs.vopay.com/reference/achfailuresget.md): This endpoint is used to retrieve a list of transactions which failed during a specific date range. This endpoint is queried based on the date that a failure occurred on, not on the date when the… - [ach/validate-nacha](https://docs.vopay.com/reference/achvalidatenachapost.md): This endpoint is used to trigger a NACHA validation on the provided bank account. In the endpoint below, either Token or ABARoutingNumber/AccountNumber are required. Either a CompanyName OR FirstName… - [rtp/withdraw](https://docs.vopay.com/reference/rtpwithdrawpost.md): This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. Either an iq11 Token or ABARoutingNumber/AccountNumber is… - [rtp/withdraw/transaction](https://docs.vopay.com/reference/rtpwithdrawtransactionget.md): This endpoint is used to look up details on a single RTP withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account. - [fednow/withdraw](https://docs.vopay.com/reference/fednowwithdrawpost.md): This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account. Either an iq11 Token or ABARoutingNumber/AccountNumber is… - [fednow/withdraw/transaction](https://docs.vopay.com/reference/fednowwithdrawtransactionget.md): This endpoint is used to look up details on a single Fednow withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account. - [google-pay/charge](https://docs.vopay.com/reference/googlepaychargepost.md): This endpoint is to create a Google Pay transaction to fund your VoPay account, charging the amount specified to the card linked to the provided Google Pay Token. If a ClientAccountID is provided,… - [google-pay/void](https://docs.vopay.com/reference/googlepayvoidpost.md): This endpoint allows you to void a completed Google Pay transaction. - [google-pay/charge/transaction](https://docs.vopay.com/reference/googlepaychargetransactionsget.md): This method is used to look up and return the full details on a single Google Pay transaction. Google Pay transactions take money out of the customer's card and deposit them into your VoPay account. - [apple-pay/charge](https://docs.vopay.com/reference/applepaychargepost.md): This endpoint is to create a Apple Pay transaction to fund your VoPay account, charging the amount specified to the card linked to the provided Apple Pay Token. If a ClientAccountID is provided,… - [apple-pay/void](https://docs.vopay.com/reference/applepayvoidpost.md): This endpoint allows you to void a completed Apple Pay transaction. - [apple-pay/charge/transaction](https://docs.vopay.com/reference/applepaychargetransactionsget.md): This method is used to look up and return the full details on a single Apple Pay transaction. Apple Pay transactions take money out of the customer's card and deposit them into your VoPay account. - [apple-pay/refund](https://docs.vopay.com/reference/applepayrefundpost.md): This endpoint allows you to refund a settled Apple Pay transaction, in full or in part. A transaction whose funds are still on hold has not settled yet and must be voided instead. - [paypal/withdraw](https://docs.vopay.com/reference/paypalwithdrawpost.md): This endpoint is used to send funds from your VoPay account to a PayPal account. If a ClientAccountID is provided, the client account's default PayPal wallet will be used for the transaction. - [paypal/withdraw/transaction](https://docs.vopay.com/reference/paypalwithdrawtransactionsget.md): This endpoint is used to look up and return the full details on a single PayPal withdraw transaction. PayPal withdraw send funds from your VoPay account to the customer's PayPal account. - [venmo/withdraw](https://docs.vopay.com/reference/venmowithdrawpost.md): This endpoint is used to send funds from your VoPay account to a Venmo account. If a ClientAccountID is provided, the client account's default Venmo wallet will be used for the transaction. - [venmo/withdraw/transaction](https://docs.vopay.com/reference/venmowithdrawtransactionsget.md): This endpoint is used to look up and return the full details on a single Venmo withdraw transaction. Venmo withdraw send funds from your VoPay account to the customer's Venmo account. - [batch/eft/fund](https://docs.vopay.com/reference/batcheftfundpost.md): This endpoint is used to submit multiple EFT fund transaction requests to VoPay. - [batch/eft/withdraw](https://docs.vopay.com/reference/batcheftwithdrawpost.md): This endpoint is used to submit multiple EFT withdraw transaction requests to VoPay. - [batch/interac/money-request](https://docs.vopay.com/reference/batchinteracmoneyrequestpost.md): This endpoint is used to submit multiple Interac money request transaction requests to VoPay. - [batch/interac/bulk-payout](https://docs.vopay.com/reference/batchinteracbulkpayoutpost.md): This endpoint is used to submit multiple Interac bulk-payout transaction requests to VoPay. - [batch/rtr/withdraw](https://docs.vopay.com/reference/batchvopayinstantpost.md): This endpoint is used to submit multiple VoPay Instant transaction requests to VoPay. - [batch/elinx](https://docs.vopay.com/reference/batchelinxpost.md): This endpoint is used to submit multiple eLinx beneficiary requests to VoPay. - [batch/debit-card/push-funds](https://docs.vopay.com/reference/batchdebitcardpushfundspost.md): This endpoint is used to submit multiple debit card oct push funds requests to VoPay. - [batch/ach/fund](https://docs.vopay.com/reference/batchachfundpost.md): This endpoint is used to submit multiple ACH Fund requests to VoPay. - [batch/ach/withdraw](https://docs.vopay.com/reference/batchachwithdrawpost.md): This endpoint is used to submit multiple ACH Withdraw requests to VoPay. - [batch/credit-card/charge](https://docs.vopay.com/reference/batchcreditcardchargepost.md): This endpoint is used to submit multiple Credit Card Charge requests to VoPay. - [batch/rtp/withdraw](https://docs.vopay.com/reference/batchrtpwithdrawpost.md): This endpoint is used to submit multiple RTP Withdraw requests to VoPay. - [batch](https://docs.vopay.com/reference/batchget.md): This endpoint is used to fetch a listing of all your batch transaction requests - [batch/details](https://docs.vopay.com/reference/batchdetailsget.md): This endpoint is used to fetch the details of a specific batch transaction request - [batch/fednow/withdraw](https://docs.vopay.com/reference/batchfednowwithdrawpost.md): This endpoint is used to submit multiple Fednow Withdraw requests to VoPay. - [batch/contacts/add](https://docs.vopay.com/reference/batchcontactsaddpost.md): 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… - [journal-entry/add](https://docs.vopay.com/reference/journalentryaddpost.md): This endpoint allows you to add journal entry into the VoPay platform. Journals do not represent real funds. They are considered offbook funds, and are designed to represent transactions that have… - [journal-entry/edit](https://docs.vopay.com/reference/journalentryeditpost.md): This endpoint allows you to edit journal entry that was previously saved the VoPay platform. - [journal-entry/delete](https://docs.vopay.com/reference/journalentrydeletepost.md): This endpoint allows you to delete journal entry that was previously saved the VoPay platform. - [journal-entry/transfer](https://docs.vopay.com/reference/journalentrydeletetransfer.md): This endpoint allows you to transfer offbook funds between VoPay accounts and/or Client accounts. This endpoint will create two journal entries, one to debit the source account and one to credit the… - [journal-entry](https://docs.vopay.com/reference/journalentryget.md): This endpoint allows you to get the journal entry that was previously saved the VoPay platform. - [sepa/withdraw](https://docs.vopay.com/reference/sepawithdrawpost.md): This endpoint debits your account by sending a SEPA Instant payment to a creditor's IBAN. Only EUR currency is supported. Requires SEPAInstantWithdrawEnabled permission and an active EUR virtual… - [sepa/withdraw/transaction](https://docs.vopay.com/reference/sepawithdrawtransactionget.md): This endpoint retrieves full details for a single SEPA Instant withdrawal transaction. Requires SEPAInstantWithdrawEnabled permission. - [wire/withdraw](https://docs.vopay.com/reference/wirewithdrawpost.md): This endpoint sends a wire. The wire rail is detected from the beneficiary bank identifiers supplied (or stored on the bank account behind a Token / ClientAccountID): an `ABARoutingNumber` sends a… - [wire/cancel](https://docs.vopay.com/reference/wirecancelpost.md): Cancels a previously submitted wire transaction. Requires the account's wire rail to be enabled. - [wire/transaction](https://docs.vopay.com/reference/wiretransactionget.md): Looks up and returns the full details of a single wire transaction, including its `WireType`. - [batch/wire/withdraw](https://docs.vopay.com/reference/batchwirewithdrawpost.md): Submits a batch of wire transactions. Each row's wire rail is detected from its bank identifiers exactly as on /wire/withdraw; a row whose identifiers are missing, ambiguous or name a rail that is… ## API Reference: Transaction Management - [account/transactions/cancel](https://docs.vopay.com/reference/accounttransactionscancelpost.md): This endpoint allows a recently created transaction to be cancelled. Once a transaction has begun being processed it can no longer be canceled through this endpoint. Paylink can also be cancelled… - [account/transactions/refund](https://docs.vopay.com/reference/accounttransactionsrefundpost.md): This endpoint allows you to refund a completed transaction (EFT, ACH, Interac, and credit card). The payment information provided in the original transaction is used in the refund. - [account/transaction/confirm](https://docs.vopay.com/reference/accounttransactionconfirmpost.md): This endpoint allows users to confirm a flagged transaction. Confirming a flagged transaction permits the transaction to be processed. Unconfirmed flagged transactions will not be processed. - [account/transaction/return](https://docs.vopay.com/reference/accounttransactionreturnpost.md): This endpoint allows you to return a transaction. A return can be initiated for EFT and ACH transactions that need to be returned (e.g., insufficient funds, account closed, or invalid account). The… - [account/transaction/hold](https://docs.vopay.com/reference/accounttransactionholdpost.md): This endpoint creates a hold on funds in your account. The held amount is reserved and will not be available for other transactions until the hold is released or the hold transaction is cancelled. - [account/transaction/hold/release](https://docs.vopay.com/reference/accounttransactionholdreleasepost.md): This endpoint releases an existing hold transaction, making the previously held funds available again. The hold must be in a pending status to be released. - [account/transaction/resubmit](https://docs.vopay.com/reference/accounttransactionresubmitpost.md): This endpoint creates a new transaction from an existing one, reusing the original recipient and bank account details. It is useful for retrying a failed or returned transaction without re-entering… ## API Reference: IQ11 - [iq11/generate-embed-url](https://docs.vopay.com/reference/iq11generateembedurlpost.md): This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to log in to their online banking and select a bank account to make a payment… - [iq11/token-info](https://docs.vopay.com/reference/iq11tokeninfoget.md): This endpoint is used to return the payment details associated with an iQ11 Token. - [iq11/tokenize](https://docs.vopay.com/reference/iq11tokenizepost.md): This endpoint allows you to submit payment method details (bank account, email address), and will return a token which can be used to perform transactions. - [iq11/transactions](https://docs.vopay.com/reference/iq11transactionsget.md): This endpoint is used to return the transaction history associated with an iQ11 Token. - [iq11/balance](https://docs.vopay.com/reference/iq11balanceget.md): This endpoint is used to return the bank account balance associated with an iQ11 Token. - [iq11/enrich-data](https://docs.vopay.com/reference/iq11enrichdatapost.md): This endpoint is used to enrich transaction data associated with a iQ11 Token. - [iq11/enrich-data](https://docs.vopay.com/reference/iq11enrichdataget.md): This endpoint is used to fetch transaction reports generated from the enriched data. - [iq11/enrich-data/status](https://docs.vopay.com/reference/iq11enrichdatastatusget.md): This endpoint is used to check the status of a data enrichment request. - [iq11/enrich-data/reclassify](https://docs.vopay.com/reference/iq11enrichdatareclassifypost.md): This endpoint is used to reclassify a single aggregator transaction. The manual correction is stored so future enrichment runs and report fetches reflect it. - [iq11/enrich-data/categories](https://docs.vopay.com/reference/iq11enrichdatacategoriesget.md): This endpoint returns the data-enrichment taxonomy: the categories transactions can be classified into, with their side (credit/debit), kind (income/expense/fee) and the report type slug used with… ## API Reference: eLinx - [elinx](https://docs.vopay.com/reference/elinxpost.md): This endpoint is used to create an eLinx request. Once the eLinx request is created successfully, the request link will be sent through an email to the recipient. Notes: * If you do not wish to… - [elinx](https://docs.vopay.com/reference/elinxget.md): This endpoint is used to retrieve a listing of all eLinx requests. - [elinx/cancel](https://docs.vopay.com/reference/elinxcancelpost.md): This endpoint is used to cancel an incomplete eLinx request - [elinx/settings](https://docs.vopay.com/reference/elinxsettingsupdatepost.md): This endpoint is used to update the eLinx settings for an account. - [elinx/settings](https://docs.vopay.com/reference/elinxsettingsget.md): This endpoint is used to retrieve a list of all eLinx settings. - [elinx/settings/setup-upcoming-payment-notice](https://docs.vopay.com/reference/elinxsettingssetupupcomingpaymentnoticepost.md): This endpoint is used to enable or disable the upcoming recurring-payment (PAD pre-notification) notice, and optionally set its lead time in days. ## API Reference: verification - [account-verification/bank-account/initiate](https://docs.vopay.com/reference/accountverificationinitiate.md): This endpoint is used to intiate the micro deposit transaction. The bank routing information required will vary depending on the country. Currently only US and Canada are supported. - [account-verification/bank-account/confirm](https://docs.vopay.com/reference/accountverificationconfirm.md): This endpoint is used to confirm the micro deposit transaction. - [account-verification/card](https://docs.vopay.com/reference/accountverificationcard.md): This endpoint is used to verify a credit or debit card. - [account-verification/interac](https://docs.vopay.com/reference/accountverificationinterac.md): This endpoint is used to verify an Interac email address. - [account-verification](https://docs.vopay.com/reference/accountverification.md): This endpoint is used to fetch the details of a micro deposit transaction. - [contact-verification/email](https://docs.vopay.com/reference/contactverificationemail.md): This endpoint is used to intiate an email verification. - [contact-verification/phone](https://docs.vopay.com/reference/contactverificationphone.md): This endpoint is used to intiate an phone SMS verification. - [contact-verification/name-screen](https://docs.vopay.com/reference/contactverificationnamescreen.md): This endpoint is used to verify contacts name - [contact-verification/requests](https://docs.vopay.com/reference/contactverificationrequestsget.md): This endpoint is used to fetch results of the contact verification requests. - [contact-verification/email/confirm](https://docs.vopay.com/reference/contactverificationemailconfirm.md): This endpoint is used to confirm an email verification using an OTP sent to the email address. - [contact-verification/phone/confirm](https://docs.vopay.com/reference/contactverificationphoneconfirm.md): This endpoint is used to confirm a phone verification using an OTP sent via SMS. - [contact-verification/id/non-doc](https://docs.vopay.com/reference/contactverificationidnondoc.md): This endpoint is used to perform Non-Document ID verification on an individual. Currently only Canada is supported. - [contact-verification/generate-embed-url](https://docs.vopay.com/reference/contactverificationgenerateembedurl.md): This endpoint generates an embed URL for contact verification. The URL can be used to embed a verification iframe for address, basic ID, or enhanced ID verification. ## API Reference: Integrations and Support - [account/set-plaid-credentials](https://docs.vopay.com/reference/setplaidcredentialspost.md): This endpoint is used to configure the optional integration with a Plaid account. For more information please visit [our integration section](https://docs.vopay.com/docs/plaid-integration). - [account/set-flinks-credentials](https://docs.vopay.com/reference/setflinkscredentialspost.md): This endpoint is used to configure the optional integration with a Flinks account. For more information please visit [our integration section](https://docs.vopay.com/docs/flinks-integration). - [account/set-inverite-credentials](https://docs.vopay.com/reference/setinveritecredentialspost.md): This endpoint is used to configure the optional integration with a Inverite account. For more information please visit [our integration section](https://docs.vopay.com/docs/inverite-integration). - [account/set-global-pay-credentials](https://docs.vopay.com/reference/setglobalpaycredentialspost.md): This endpoint is used to configure the optional integration with a Global Pay account. For more information please visit [our integration section](https://docs.vopay.com/docs/global-pay-integration). - [account/tickets](https://docs.vopay.com/reference/fetchticketsget.md): This endpoint is used to fetch a list of support tickets via our API. If no email address is passed in then it will fetch all tickets for the account. If an email address is passed in, it will fetch… - [account/submit-ticket](https://docs.vopay.com/reference/submitticketpost.md): This endpoint is used to submit support tickets via our API. - [account/submit-ticket-comment](https://docs.vopay.com/reference/submitticketcommentpost.md): This endpoint is used to submit a comment on an existing support tickets via our API. Ticket comments represent the conversation between user and support team. Use the TicketID (obtained from… - [account/ticket-attachment](https://docs.vopay.com/reference/submitticketattachmentpost.md): You can upload a file and attach it to an existing support tickets via our API. Use the TicketID (obtained from /account/submit-ticket endpoint) to identify the ticket you want to attach the file to.… - [partner/tickets](https://docs.vopay.com/reference/partnerfetchticketsget.md): This endpoint is used to fetch a list of support tickets via our API. If no email address is passed in then it will fetch all tickets for the account. If an email address is passed in, it will fetch… - [partner/submit-ticket](https://docs.vopay.com/reference/partnersubmitticketpost.md): This endpoint is used to submit support tickets via our API. - [partner/submit-ticket-comment](https://docs.vopay.com/reference/submitticketcommentpartnerpost.md): This endpoint is used to submit a comment on an existing support tickets via our API. Ticket comments represent the conversation between user and support team. Use the TicketID (obtained from… - [partner/ticket-attachment](https://docs.vopay.com/reference/submitticketattachmentpartnerpost.md): You can upload a file and attach it to an existing support tickets via our API. Use the TicketID (obtained from /partner/submit-ticket endpoint) to identify the ticket you want to attach the file to.… - [account/webhook-url](https://docs.vopay.com/reference/accountwebhookurlpost.md): This endpoint will allow the user to add or modify a webhook URL. The purpose of the webhook URL is to notify users of any changes in transaction status, paylink status, account status, account… - [account/webhook-url/info](https://docs.vopay.com/reference/accountwebhookurlinfoget.md): This endpoint will retrieve your webhook URL. - [account/webhooks](https://docs.vopay.com/reference/accountwebhooksget.md): This endpoint can be used to fetch a list of sent webhook notifications. Maximum date range is 1 month. If no date range is provided, it will default to the past 30 days. - [account/webhook/resend](https://docs.vopay.com/reference/accountwebhookresendpost.md): This endpoint will resend the webhook notification associated with the provided event ID. This is useful if you missed a webhook or if you need to reprocess a webhook. The event ID can be fetched… - [partner/webhook-url](https://docs.vopay.com/reference/partnerwebhookurlpost.md): This endpoint will allow the user to modify the webhook URL. The purpose of the webhook URL is to notify users of any changes in the status of the accounts you create. - [partner/webhook-url/info](https://docs.vopay.com/reference/partnerwebhookurlinfoget.md): This endpoint will retrieve your webhook URL. - [partner/webhook-url/test](https://docs.vopay.com/reference/partnerwebhookurltestget.md): In this endpoint, you will be able to test your webhook URL. We will send you an example of the payload that you will receive. - [partner/webhooks](https://docs.vopay.com/reference/partnerwebhooksget.md): This endpoint can be used to fetch a list of sent webhook notifications. Maximum date range is 1 month. If no date range is provided, it will default to the past 30 days. - [partner/webhook/resend](https://docs.vopay.com/reference/partnerwebhookresendpost.md): This endpoint will resend the webhook notification associated with the provided event ID. This is useful if you missed a webhook or if you need to reprocess a webhook. The event ID can be fetched… - [account/webhook-url/test](https://docs.vopay.com/reference/accountwebhookurltestpost.md): In this endpoint, you will be able to test your webhook URL. We will send you an example of the payload that you will receive. - [account/keys](https://docs.vopay.com/reference/apikeysget.md): This endpoint allows the user to fetch the API key IDs associated with their account. - [account/keys/retrieve](https://docs.vopay.com/reference/apikeysretrievepost.md): This endpoint allows the user to fetch a particular API key associated with their account including sensitive information. - [account/keys/add](https://docs.vopay.com/reference/apikeysaddpost.md): This endpoint allows the user to add an API key associated to their account - [account/keys/edit](https://docs.vopay.com/reference/apikeyseditpost.md): This endpoint allows the user to edit an API key's label associated to their account - [account/keys/delete](https://docs.vopay.com/reference/apikeysdeletepost.md): This endpoint allows the user to delete a particular API key associated with their account - [partner/keys](https://docs.vopay.com/reference/apipartnerkeysget.md): This endpoint allows the user to fetch the API key IDs associated with their partner account. - [partner/keys/retrieve](https://docs.vopay.com/reference/apipartnerkeysretrievepost.md): This endpoint allows the user to fetch a particular API key associated with their partner account including sensitive information. - [partner/keys/add](https://docs.vopay.com/reference/apipartnerkeysaddpost.md): This endpoint allows the user to add an API key associated to their partner account - [partner/keys/edit](https://docs.vopay.com/reference/apipartnerkeyseditpost.md): This endpoint allows the user to edit an API key's label associated to their partner account - [partner/keys/delete](https://docs.vopay.com/reference/apipartnerkeysdeletepost.md): This endpoint allows the user to delete a particular API key associated with their partner account ## API Reference: File Conversion - [file-conversion/upload](https://docs.vopay.com/reference/fileconversionuploadpost.md): Upload a file for conversion or submission to a banking partner. - [file-conversion/submit](https://docs.vopay.com/reference/fileconversionsubmitpost.md): Submit an uploaded file for processing and transmission to a banking partner. - [file-conversion/download](https://docs.vopay.com/reference/fileconversiondownloadget.md): Download the converted target file for a specific file conversion. - [file-conversion/download-source](https://docs.vopay.com/reference/fileconversiondownloadsourceget.md): Download the original source file that was uploaded for conversion. - [file-conversion/configurations](https://docs.vopay.com/reference/fileconversionconfigurationsget.md): Get available file conversion configurations and supported payment rails for your account. - [file-conversion/history](https://docs.vopay.com/reference/fileconversionhistoryget.md): Get file conversion history for your account with optional filtering and pagination. - [file-conversion/transactions](https://docs.vopay.com/reference/fileconversiontransactionsget.md): Get formatted transactions for a specific file conversion. Optionally filter by processor to view transactions in the format they would be sent to that provider. - [file-conversion/preprocessing/configurations](https://docs.vopay.com/reference/fileconversionpreprocessingconfigurationsget.md): Get preprocessing configurations for the authenticated account. ## API Reference: Bill Pay - [bill-pay/create](https://docs.vopay.com/reference/billpaycreatepost.md): This endpoint is used to create a bill pay transaction. - [bill-pay/cancel](https://docs.vopay.com/reference/billpaycancelpost.md): This endpoint is used to cancel a bill pay transaction. - [bill-pay/transaction](https://docs.vopay.com/reference/billpaytransactionget.md): This endpoint is used to fetch a bill pay transaction. - [bill-pay/merchants](https://docs.vopay.com/reference/billpaymerchantsget.md): This endpoint is used to fetch bill pay merchants. - [bill-pay/account/merchants/add](https://docs.vopay.com/reference/billpayaccountmerchantsaddpost.md): This endpoint is used to add a merchant to an account. - [bill-pay/account/merchants/edit](https://docs.vopay.com/reference/billpayaccountmerchantseditpost.md): This endpoint is used to edit an account-level merchant. - [bill-pay/account/merchants](https://docs.vopay.com/reference/billpayaccountmerchantsget.md): This endpoint is used to fetch bill pay merchants for an account. - [bill-pay/generate-embed-url](https://docs.vopay.com/reference/billpaygenerateembedurlpost.md): This endpoint is used to generate a URL to create a bill pay iframe. ## API Reference: Global Cash Management - [gcm/recipient-contacts](https://docs.vopay.com/reference/recipientcontactsget.md): Get a list of recipient contacts for the account. - [gcm/recipient-contacts/add](https://docs.vopay.com/reference/recipientcontactsaddpost.md): Add a recipient contact. All name, address, and phone fields must comply with Mastercard Cross-Border Services Data Quality Standards (effective April 20, 2026). - [gcm/recipient-contacts/edit](https://docs.vopay.com/reference/recipientcontactseditpost.md): Edit a recipient contact. Any fields provided must comply with Mastercard Cross-Border Services Data Quality Standards (effective April 20, 2026). - [gcm/recipient-contacts/favorites/add](https://docs.vopay.com/reference/recipientcontactsfavoritesaddpost.md): Add a recipient to your favorites. - [gcm/recipient-contacts/favorites/delete](https://docs.vopay.com/reference/recipientcontactsfavoritesdeletepost.md): Delete a recipient from your favorites. - [gcm/countries](https://docs.vopay.com/reference/countriesget.md): Get a list of all the available countries for a specific use case that support cross border transactions. - [gcm/delivery-methods](https://docs.vopay.com/reference/deliverymethodsget.md): Get a list of all the stored delivery methods for a certain recipient contact and corridor delivery method (optional). - [gcm/delivery-methods/add](https://docs.vopay.com/reference/adddeliverymethodpost.md): Add a new delivery method for a certain recipient contact and corridor delivery method. - [gcm/delivery-methods/edit](https://docs.vopay.com/reference/editdeliverymethodpost.md): Edit an existing delivery method for a certain recipient contact and corridor delivery method. - [gcm/delivery-methods/delete](https://docs.vopay.com/reference/deletedeliverymethodpost.md): Delete a delivery method for a certain recipient contact. - [gcm/delivery-channels](https://docs.vopay.com/reference/deliverychannelsget.md): Get a list of all the available delivery methods available for a certain corridor and use case. - [gcm/delivery-channels/fields](https://docs.vopay.com/reference/deliverychannelfieldsget.md): Get a list of all the fields required for a certain delivery method. - [gcm/delivery-channels/fields/data](https://docs.vopay.com/reference/deliverychannelfieldsdataget.md): Get a list of all the data currently stored against a client account, contact, or recipient contact. - [gcm/government-identifier](https://docs.vopay.com/reference/governmentidentifierget.md): Get a list of all the stored government identifiers for a certain client account and corridor. - [gcm/government-identifier/schemas](https://docs.vopay.com/reference/governmentidentifierschemasget.md): Get a list of all the available government identifier schemas. - [gcm/government-identifier/add](https://docs.vopay.com/reference/addgovernmentidentifierpost.md): Add a new government identifier for a certain client account and corridor. - [gcm/government-identifier/delete](https://docs.vopay.com/reference/deletegovernmentidentifierpost.md): Delete a government identifier for a certain client account. - [gcm/watchlist](https://docs.vopay.com/reference/getwatchlistget.md): Get a list of all the watchlisted corridors for a certain client account. - [gcm/watchlist/rates](https://docs.vopay.com/reference/getwatchlistratesget.md): Get a list of fx rates for a wacthlisted currency. - [gcm/watchlist/add](https://docs.vopay.com/reference/addwatchlistpost.md): Add a new watchlisted corridor for a certain client account. - [gcm/watchlist/delete](https://docs.vopay.com/reference/deletewatchlistpost.md): Delete a watchlisted corridor for a certain client account. - [gcm/withdraw/quote](https://docs.vopay.com/reference/getquotepost.md): Get a quote for a certain amount to be sold or bought using a certain corridor delivery method. - [gcm/withdraw/quotes](https://docs.vopay.com/reference/getwithdrawquotesget.md): Get a list of withdraw quotes for a certain client account. - [gcm/withdraw](https://docs.vopay.com/reference/createwithdrawpost.md): Create a crossborder withdrawal transaction from a provided quote. - [gcm/withdraw/confirm](https://docs.vopay.com/reference/confirmwithdrawpost.md): Confirm a partially complete crossborder withdrawal transaction. - [gcm/withdraw/cancel](https://docs.vopay.com/reference/cancelwithdrawpost.md): Cancel a partially complete crossborder withdrawal transaction. - [gcm/withdraw/transactions](https://docs.vopay.com/reference/getwithdrawtransactionsget.md): Get a list of crossborder withdraw transactions. - [gcm/withdraw/transaction](https://docs.vopay.com/reference/getwithdrawtransactionget.md): Get the details for a crossborder withdraw transaction. - [gcm/recall/request](https://docs.vopay.com/reference/recallrequestpost.md): Create a recall request for the provided transaction id. - [gcm/generate-embed-url](https://docs.vopay.com/reference/generateembedurlpost.md): Generate link to the crossborder iframe. - [gcm/recipient-contacts/generate-embed-url](https://docs.vopay.com/reference/recipientcontactgenerateembedurlpost.md): Generate a link to the cross-border iframe for onboarding recipient contacts. - [gcm/banks/names](https://docs.vopay.com/reference/banksnamesget.md): Get a list of supported bank names. - [gcm/banks/cities](https://docs.vopay.com/reference/bankscitiesget.md): Get a list of supported bank cities. - [gcm/banks/branches](https://docs.vopay.com/reference/banksbranchesget.md): Get a list of supported bank branches. - [gcm/banks/locations](https://docs.vopay.com/reference/bankslocationsget.md): Get a list of supported bank locations. ## API Reference: Ping - [ping](https://docs.vopay.com/reference/pingpost.md): This endpoint allows you to validate the connectivity between your application and the VoPay platform. - [auth/ping](https://docs.vopay.com/reference/authpingpost.md): This endpoint allows you to ping our server and validate your credentials on VoPay platform. - [partner/auth/ping](https://docs.vopay.com/reference/partnerauthpingpost.md): This endpoint allows you to ping our server and validate your partner credentials on VoPay platform. ## API Reference: Branding - [account/branding](https://docs.vopay.com/reference/brandingpost.md): This endpoint allows you to apply your branding to all VoPay portals, UIs and emails. - [account/branding-details](https://docs.vopay.com/reference/brandingdetailsget.md): This endpoint allows you to fetch your existing branding details. - [account/branding/delete](https://docs.vopay.com/reference/brandingdeletepost.md): This endpoint allows you to delete your branding. - [partner/branding](https://docs.vopay.com/reference/partnerbrandingpost.md): This endpoint allows you to apply your branding to all VoPay portals, UIs and emails. - [partner/branding-details](https://docs.vopay.com/reference/partnerbrandingdetailsget.md): This endpoint allows you to fetch your existing branding details. - [partner/branding/delete](https://docs.vopay.com/reference/partnerbrandingdeletepost.md): This endpoint allows you to delete your branding. ## API Reference: Dispute Management Endpoints - [dispute-management/generate-embed-url](https://docs.vopay.com/reference/disputemanagementgenerateembedurlpost.md): This endpoint generates a unique URL to embed into your application using an iFrame. - [dispute-management/list](https://docs.vopay.com/reference/disputemanagementlistget.md): This endpoint allows you to fetch a list of your disputes and chargebacks. - [dispute-management/detail](https://docs.vopay.com/reference/disputemanagementdetailget.md): This endpoint allows you to fetch details for a dispute. - [dispute-management/document](https://docs.vopay.com/reference/disputemanagementdocumentget.md): This endpoint allows you to fetch the document for a dispute. - [dispute-management/accept](https://docs.vopay.com/reference/disputemanagementacceptpost.md): This endpoint allows you to accept a dispute. - [dispute-management/challenge](https://docs.vopay.com/reference/disputemanagementchallengepost.md): This endpoint allows you to challenge a dispute. - [dispute-management/respond](https://docs.vopay.com/reference/disputemanagementrespondpost.md): This endpoint allows you to respond to a retrieval request. - [dispute-management/add-note](https://docs.vopay.com/reference/disputemanagementaddnotepost.md): This endpoint allows you to add a note to a dispute. - [dispute-management/report/dispute-overview](https://docs.vopay.com/reference/disputemanagementreportdisputeoverviewget.md): This endpoint returns a summary overview of all disputes and chargebacks. - [dispute-management/report/dispute-reasons](https://docs.vopay.com/reference/disputemanagementreportdisputereasonsget.md): This endpoint returns a summary of all current dispute reasons. - [dispute-management/report/dispute-stages](https://docs.vopay.com/reference/disputemanagementreportdisputestagesget.md): This endpoint returns a summary of all current dispute stages. ## API Reference: Virtual Accounts - [virtual-account](https://docs.vopay.com/reference/virtualaccountget.md): Retrieve information about virtual accounts associated with your account. - [virtual-account](https://docs.vopay.com/reference/virtualaccountcreatepost.md): Create a new virtual account. - [virtual-account/balance](https://docs.vopay.com/reference/virtualaccountbalanceget.md): Retrieve the balance for a specific virtual account. - [virtual-account/transactions](https://docs.vopay.com/reference/virtualaccounttransactionsget.md): Retrieve the transaction history for a specific virtual account. - [virtual-account/simulate-credit](https://docs.vopay.com/reference/virtualaccountsimulatecreditpost.md): Simulate a credit to a virtual account. This endpoint is used for testing purposes to add funds to a virtual account. - [virtual-account/close](https://docs.vopay.com/reference/virtualaccountclosepost.md): Close (deactivate) a virtual account. The virtual account balance must be zero (both the available balance and any pending balance) before it can be closed. ## API Reference: Blocked Accounts - [Block account(s)](https://docs.vopay.com/reference/blockedaccountblockpost.md): Blocks one or all sub-accounts under the authenticated secured account. Optionally transfers any available funds out of the blocked account(s). Requires the ManageBlockedAccounts permission. - [Unblock account(s)](https://docs.vopay.com/reference/blockedaccountunblockpost.md): Unblocks one or all previously blocked sub-accounts under the authenticated secured account. Requires the ManageBlockedAccounts permission. - [Set auto-unblock threshold](https://docs.vopay.com/reference/blockedaccountsetautounblockthresholdpost.md): Sets the AutoUnblockThreshold on a sub-account's blocked account settings. When the sub-account's balance reaches this threshold, it will be automatically unblocked. Pass an empty value to clear the… ## API Reference: Scheduled Payments - [Create Scheduled Payment](https://docs.vopay.com/reference/scheduledpaymentpost.md): Create a new scheduled transaction to be processed on a particular time depending on the frequency. - [Get Scheduled Payments](https://docs.vopay.com/reference/scheduledpaymentget.md): Retrieve details of a single scheduled payment or all scheduled payments for the account. - [Cancel Scheduled Payment](https://docs.vopay.com/reference/scheduledpaymentcancelpost.md): Cancel a scheduled payment and all its future occurrences. - [Cancel Upcoming Payment](https://docs.vopay.com/reference/upcomingpaymentcancelpost.md): Cancel a single upcoming scheduled payment without affecting other occurrences. - [Edit Scheduled Payment](https://docs.vopay.com/reference/scheduledpaymenteditpost.md): Modify a scheduled payment by updating the amount. This affects all upcoming occurrences of the scheduled payment. - [Edit Upcoming Payment](https://docs.vopay.com/reference/upcomingpaymenteditpost.md): Modify a single upcoming scheduled payment by updating the amount and/or date. This only affects the specific upcoming occurrence. ## API Reference: Remittance API - [remittance/create](https://docs.vopay.com/reference/remittancecreatepost.md): This endpoint is used to create a tax remittance transaction. - [remittance/transaction](https://docs.vopay.com/reference/remittancetransactionget.md): This endpoint is used to fetch a single tax remittance transaction. To list tax remittance transactions, use the /account/transactions endpoint with TransactionType=Tax Remittance. - [remittance/tax-categories](https://docs.vopay.com/reference/remittancetaxcategoriesget.md): Publishes the tax remittance category matrix: the display name, jurisdiction and exact Details fields required for each TaxRemittanceType accepted by /remittance/create. The response is identical for… - [remittance/account/profiles/add](https://docs.vopay.com/reference/remittanceaccountprofilesaddpost.md): Saves a reusable tax remittance payee profile (tax category, tax account number, payer name) for the calling account, addressed by an opaque token. Supply the returned RemittanceProfileToken on… - [remittance/account/profiles/edit](https://docs.vopay.com/reference/remittanceaccountprofileseditpost.md): Edits a saved tax remittance payee profile. This is a full replacement of Nickname, TaxAccountNumber, PayerName, and DefaultDetails - omitting Nickname or DefaultDetails clears the existing saved… - [remittance/account/profiles/delete](https://docs.vopay.com/reference/remittanceaccountprofilesdeletepost.md): Soft-deletes a saved tax remittance payee profile. After deletion the profile is invisible to POST /remittance/account/profiles/add (duplicate checks), POST /remittance/account/profiles/edit, and GET… - [remittance/account/profiles](https://docs.vopay.com/reference/remittanceaccountprofilesget.md): Lists the calling account's saved tax remittance payee profiles. Only active (non-deleted) profiles are returned. Results can be narrowed by client account, remittance type, or a free-text search… ## API Reference: Convenience Fees - [Get convenience fee settings](https://docs.vopay.com/reference/conveniencefeesettingsget.md): Returns all convenience fee settings configured for the authenticated account. Each setting defines the transaction fee and processing fee applied for a specific payment rail. Requires the… - [Create or update a convenience fee setting](https://docs.vopay.com/reference/conveniencefeesettingspost.md): Creates or updates a convenience fee setting for a specific transaction type. If a setting already exists for the given TransactionTypeID it will be updated; otherwise a new setting is created.… - [Delete a convenience fee setting](https://docs.vopay.com/reference/conveniencefeesettingsdelete.md): Deletes a convenience fee setting by ID. The setting must belong to the authenticated account. Requires the ManageConvenienceFees permission. - [Get convenience fee rules](https://docs.vopay.com/reference/conveniencefeerulesget.md): Returns all jurisdiction rules configured for the authenticated account. Each rule defines a jurisdiction (province/state) where convenience fees will not be collected. Requires the… - [Add a convenience fee rule](https://docs.vopay.com/reference/conveniencefeerulespost.md): Adds a restriction rule for the authenticated account. Convenience fees will not be collected for transactions that match the rule. Requires the ManageConvenienceFees permission. - [Delete a convenience fee rule](https://docs.vopay.com/reference/conveniencefeerulesdelete.md): Deletes a convenience fee rule by ID. The rule must belong to the authenticated account. Requires the ManageConvenienceFees permission. ## API Reference: Accounting Software - [asp/generate-embed-url](https://docs.vopay.com/reference/aspgenerateembedurlpost.md): This endpoint is used to generate a URL to create an accounting software iframe. Accounting software is account level, so the iframe is always tied to the account's primary client account. ## Recipes - [Account Onboarding](https://docs.vopay.com/recipes/account-onboarding.md) - [Accounts Payables](https://docs.vopay.com/recipes/accounts-payables.md) - [Accounts Receivables](https://docs.vopay.com/recipes/accounts-receivables.md) - [Blocked Accounts](https://docs.vopay.com/recipes/blocked-accounts.md) - [Commercial Rent Collection / Property Management](https://docs.vopay.com/recipes/commercial-rent-collection-property-management.md) - [Gig Economy / Earned Wage Access](https://docs.vopay.com/recipes/gig-economy-earned-wage-access.md) - [Healthcare](https://docs.vopay.com/recipes/healthcare.md) - [Investment Platform](https://docs.vopay.com/recipes/investment-platform.md) - [Lending](https://docs.vopay.com/recipes/lending.md) - [Marketplace](https://docs.vopay.com/recipes/marketplace.md) - [Micro-Deposits](https://docs.vopay.com/recipes/micro-deposits-1.md) - [Payroll](https://docs.vopay.com/recipes/payroll.md) - [Residential Rent Collection / Property Management](https://docs.vopay.com/recipes/residential-rent-collection-property-management.md) - [Subscription Service](https://docs.vopay.com/recipes/subscription-service.md) - [US Lending](https://docs.vopay.com/recipes/us-lending.md) ## Changelog - [October 2026](https://docs.vopay.com/changelog/october-2026.md) - [September 2026](https://docs.vopay.com/changelog/september-2026.md) - [August 2026](https://docs.vopay.com/changelog/august-2026.md) - [July 2026](https://docs.vopay.com/changelog/july-2026.md) - [June 2026](https://docs.vopay.com/changelog/june-2026.md) - [May 2026](https://docs.vopay.com/changelog/may-2026.md) - [April 2026](https://docs.vopay.com/changelog/april-2026.md) - [March 2026](https://docs.vopay.com/changelog/march-2026.md) - [January 2026](https://docs.vopay.com/changelog/january-2026.md) - [December 2025](https://docs.vopay.com/changelog/december-2025.md)