Partner Endpoints

partner/account/business-case

This endpoint is used to provide the use cases for the VoPay account you are onboarding.

post/partner/account/business-case

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/account/business-case
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VopayAccountIDstring required

The account ID for whom you are provding the business case info.

BusinessNamestring required

Name of the company for whom you are providing the business case info

BusinessEmailstring required

Name of the company for whom you are providing the business case info

DoingBusinessAsstring required

A brief description of the business activities of the VoPay account

WebsiteURLstring required

Website URL

BusinessModelstring required

Describe the current product or services you offer

MSBboolean required

Are you a Medium Small Business?

NumberofYearsInBusinessnumber required

Number of Years in Business

InteracETransferCurrentboolean

Do you currently have Interac E-Transfer service

VisaMastercardProcessingCurrentboolean

Do you currently have Visa Mastercard Processing service

VisaDirectMCSendCurrentboolean

Do you currently have Visa Direct Mastercard Send service

EFTCurrentboolean

Do you currently have EFT service

VirtualAccountsCurrentboolean

Do you currently have Virtual Accounts

NoneOfTheAboveCurrentboolean

You don't have any of the services mentioned above

EFTiQ11Requiredboolean

Will the VoPay account require the IQ11 service.

EFTRequiredboolean

Will the VoPay account require the EFT service.

ETransferBulkPayoutRequiredboolean

Will the VoPay account require the Interac payout service.

ETransferMoneyRequestRequiredboolean

Will the VoPay account require the Interac money request service.

VisaDirectMCSendRequiredboolean

Will the VoPay account require the Visa Direct service.

VisaMastercardProcessingRequiredboolean

Will the VoPay account require the Visa Mastercard Processing service.

InboundEtransferRequiredboolean

Will the VoPay account require the Inbound E-transfer service.

VirtualAccountsRequiredboolean

Will the VoPay account require Virtual Account service.

OtherRequiredboolean

Will the VoPay account require other services not listed.

OtherRequiredServiesstring

Please specify the service required.

EFTPushTotalTransactionCountnumber

What is the daily estimated EFT Push Transactions to be executed by this VoPay account

EFTPushTotalTransactionAmountnumber

What is the daily estimated average EFT Push Total Transaction Amount to be executed by this VoPay account

EFTPushTransactionAveragenumber

What is the daily estimated EFT Push Transaction Average Amount to be executed by this VoPay account

EFTPushMinimumTransactionAmountnumber

What is the daily estimated EFT Push Minimum Transaction Amount to be executed by this VoPay account

EFTPushMaximumTransactionAmountnumber

What is the daily estimated EFT Push Maximum Transaction Amount to be executed by this VoPay account

EFTPullTotalTransactionCountnumber

What is the daily estimated EFT Pull Total Transactions to be executed by this VoPay account

EFTPullTotalTransactionAmountnumber

What is the daily estimated EFT Pull Total Transaction Amount to be executed by this VoPay account

EFTPullAverageTransactionAmountnumber

What is the daily estimated EFT Pull Average Transaction Amount to be executed by this VoPay account

EFTPullMinimumTransactionAmountnumber

What is the daily estimated EFT Pull Minimum Transaction Amount to be executed by this VoPay account

EFTPullMaximumTransactionAmountnumber

What is the daily estimated EFT Pull Maximum Transaction Amount to be executed by this VoPay account

ETransferSendTotalTransactionCountnumber

What is the daily estimated E-Transfer (Send) Total Transactions to be executed by this VoPay account

ETransferSendTotalTransactionAmountnumber

What is the daily estimated E-Transfer (Send) Total Transaction Amount to be executed by this VoPay account

ETransferSendAverageTransactionAmountnumber

What is the daily estimated E-Transfer (Send) Average Transaction Amount to be executed by this VoPay account

ETransferSendMinimumTransactionAmountnumber

What is the daily estimated E-Transfer (Send) Minimum Transaction Amount to be executed by this VoPay account

ETransferSendMaximumTransactionAmountnumber

What is the daily estimated E-Transfer (Send) Maximum Transaction Amount to be executed by this VoPay account

ETransferRequestDailyTransactionCountnumber

What is the daily estimated E-Transfer (Request) Total Transactions to be executed by this VoPay account

ETransferRequestDailyTransactionTotalnumber

What is the daily estimated E-Transfer (Request) Total Transaction Amount to be executed by this VoPay account

ETransferRequestAverageTransactionAmountnumber

What is the daily estimated E-Transfer (Request) Average Transaction Amount to be executed by this VoPay account

ETransferRequestMinimumTransactionAmountnumber

What is the daily estimated E-Transfer (Request) Minimum Transaction Amount to be executed by this VoPay account

ETransferRequestMaximumTransactionAmountnumber

What is the daily estimated E-Transfer (Request) Maximum Transaction Amount to be executed by this VoPay account

DomesticDebitPayoutAnnualTransactionCountnumber

What is the estimated Domestic Payout Annual Transactions via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayoutAnnualTransactionAmountTotalnumber

What is the estimated Domestic Payout Annual Transaction Amount Total via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayoutAnnualAverageTransactionAmountnumber

What is the estimated Domestic Payout Annual Average Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayoutAnnualMaximumTransactionAmountnumber

What is the estimated Domestic Payout Annual Maximum Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayInsAnnualTransactionCountnumber

What is the estimated Domestic Pay-Ins Annual Transactions via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayInsAnnualTransactionAmountTotalnumber

What is the estimated annual Domestic Pay-Ins Annual Transaction Amount Total via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayInsAnnualAverageTransactionAmountnumber

What is the estimated annual Domestic Pay-Ins Annual Average Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account

DomesticDebitPayInsAnnualMaximumTransactionAmountnumber

What is the estimated annual Domestic Pay-Ins Annual Maximum Transaction Amount via Visa Direct / Mastercard to be executed by this VoPay account

RegisteredISOboolean

Are you a registered ISO?

NumberOfMerchantnumber

If you are a registered ISO, please provide the number of merchants you work with

CardProcessingAnnualTransactionCountnumber

What is the estimated annual Card Processing Annual Transactions to be executed by this VoPay account

CardProcessingAnnualTransactionAmountnumber

What is the estimated annual Card Processing Annual Transaction Amount to be executed by this VoPay account

CardProcessingAverageTransactionAmountnumber

What is the estimated annual Card Processing Average Transaction Amount to be executed by this VoPay account

NumberofVirtualAccountsnumber

Number of Virtual Accounts required

NumberofDebitorCreditTransactionsPerAccountnumber

What is the estimated annual Number of Debit or Credit Transactions per account to be executed by this VoPay account

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.