Changelog

Updated 4 API specifications — 10 endpoints added, 7 endpoints updated.

• Added new Virtual Account endpoints

  Method	Endpoint	Description
  GET	/virtual-account	Retrieve information about virtual accounts associated with your account.
  POST	/virtual-account	Create a new virtual account.
  GET	/virtual-account/balance	Retrieve the balance for a specific virtual account.
  GET	/virtual-account/transactions	Retrieve the transaction history for a specific virtual account.
  POST	/virtual-account/simulate-credit	Simulate a credit to a virtual account for testing purposes.

• Added new file conversion endpoints

  Method	Endpoint	Description
  POSTS	/file-conversion/upload	Upload a file for conversion or submission to a banking partner.
  POSTS	/file-conversion/submit	Submit an uploaded file for processing and transmission to a banking partner.
  GET	/file-conversion/download	Download the converted target file for a specific file conversion.
  GET	/file-conversion/download-source	Download the original source file that was uploaded for conversion.
  GET	/file-conversion/configurations	Get available file conversion configurations and supported payment rails for your account.
  GET	/file-conversion/history	Get file conversion history for your account with optional filtering and pagination.
  GET	/file-conversion/transactions	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.

• Added new Bill Pay endpoints

  Method	Endpoint	Description
  POST	/bill-pay/create	This endpoint is used to create a bill pay transaction.
  POST	/bill-pay/cancel	This endpoint is used to cancel a bill pay transaction.
  GET	/bill-pay/transaction	This endpoint is used to fetch a bill pay transaction.
  GET	/bill-pay/merchants	This endpoint is used to fetch bill pay merchants.
  POST	/bill-pay/account/merchants/add	This endpoint is used to add a merchant to an account.
  POST	/bill-pay/account/merchants/edit	This endpoint is used to edit an account-level merchant.
  GET	/bill-pay/account/merchants	This endpoint is used to fetch bill pay merchants for an account.
  POST	/bill-pay/generate-embed-url	This endpoint is used to generate a URL to create a bill pay iframe.

• Added new contact verification endpoints

  Method	Endpoint	Description
  GET	/contact-verification	This endpoint is used to fetch results of the contact verification requests.
  POST	/contact-verification/requests	This endpoint is used to fetch results of the contact verification requests.

• Added new contact verification endpoints

  Method	Endpoint	Description
  GET	/contact-verification/document-types	This endpoint returns a list of available document types for contact verification.
  POSTS	/contact-verification/upload-document	This endpoint is used to upload documents for verification.
  POSTS	/contact-verification/address	This endpoint is used to verify contacts address, with an optional to upload supporting documents.
  POSTS	/contact-verification/name-screen	This endpoint is used to verify contacts name.

• Added new parameter to verification endpoints

  Method	Endpoint	Description
  POST	/contact-verification/phone	Added VerificationTier to contact phone verification
  POST	/contact-verification/email	Added VerificationTier to contact email verification

• Added new parameter to transactions endpoint

  Method	Endpoint	Description
  POST	/account/transactions	Added IncludeSubaccountTransactions to transactions endpoint

• Added new dispute verification endpoint

  Method	Endpoint	Description
  GET	/dispute-management/report/dispute-stages	This endpoint returns a summary of all current dispute stages.

• Added new parameter to verification endpoint

  Method	Endpoint	Description
  POST	/ach/fund	Added SeCode to ACH fund endpoint
  POST	/ach/withdraw	Added SeCode to ACH withdraw endpoint

• Added new parameter to elinx endpoint

  Method	Endpoint	Description
  POST	/elinx	Added Trigger3DS to added 3DS verifcation to an credit card connection through elinx

• Added a new field to the transaction endpoint

  Method	Endpoint	Description
  GET	/account/transactions	Added TransactionStatus to the returned fields for account transactions

• Added new dispute verification endpoints

  Method	Endpoint	Description
  POST	/dispute-management/generate-embed-url	This endpoint generates a unique URL to embed into your application using an iFrame.
  GET	/dispute-management/list	This endpoint allows you to fetch a list of your disputes and chargebacks.
  GET	/dispute-management/detail	This endpoint allows you to fetch details for a dispute.
  GET	/dispute-management/document	This endpoint allows you to fetch the document for a dispute.
  POST	/dispute-management/accept	This endpoint allows you to accept a dispute.
  POST	/dispute-management/challenge	This endpoint allows you to challenge a dispute.
  POST	/dispute-management/respond	This endpoint allows you to respond to a retrieval request.
  POST	/dispute-management/add-note	This endpoint allows you to add a note to a dispute.
  GET	/dispute-management/report/dispute-overview	This endpoint returns a summary overview of all disputes and chargebacks.
  GET	/dispute-management/report/dispute-reasons	This endpoint returns a summary of all current dispute reasons.
  GET	/dispute-management/report/dispute-stages	This endpoint returns a summary of all current dispute stages.

• Added new verification endpoint

  Method	Endpoint	Description
  GET	/account-verification/card	This endpoint is used to verify a credit or debit card.

• Added new verification endpoints

  Method	Endpoint	Description
  POST	/account-verification/interac	This endpoint is used to verify an Interac email address.
  POST	/contact-verification/email	This endpoint is used to intiate an email verification.
  POST	/contact-verification/phone	This endpoint is used to intiate an phone SMS verification.
  POST	/contact-verification/id/dual-process	This endpoint is used to perform Dual Process ID verification on an individual. Currently only Canada is supported.

• New auto deposit endpoint

  Method	Endpoint	Description
  GET	/interac/auto-deposit	This endpoint is used to fetch Interac auto-deposit status.

• New FedNow endpoints

  Method	Endpoint	Description
  POST	/fednow/withdraw	This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account.
  GET	/fednow/withdraw/transaction	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.

• New PayPal endpoints

  Method	Endpoint	Description
  POST	/paypal/add	This endpoint allows you to add a PayPal account to your VoPay account
  POST	/paypal/delete	This endpoint allows you to delete a PayPal account from your VoPay account
  GET	/paypal/recipients	This endpoint allows you fetch a list all of your PayPal recipients
  POST	/paypal/set-my-recipient	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 holder's default PayPal recipient. Note, a VoPay account can only have one default PayPal recipient.
  GET	/paypal/default-recipient	This endpoint retrieves the default PayPal recipient associated with your VoPay account
  POST	/paypal/generate-embed-url	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 /paypal/withdraw endpoint.

• New Venmo endpoints

  Method	Endpoint	Description
  POST	/venmo/add	This endpoint allows you to add a Venmo account to your VoPay account
  POST	/venmo/delete	This endpoint allows you to delete a Venmo account from your VoPay account
  GET	/venmo/recipients	This endpoint allows you fetch a list all of your Venmo recipients
  POST	/venmo/set-my-recipient	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 holder's default Venmo recipient. Note, a VoPay account can only have one default Venmo recipient.
  GET	/venmo/default-recipient	This endpoint retrieves the default Venmo recipient associated with your VoPay account
  POST	/venmo/generate-embed-url	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 /venmo/withdraw endpoint.