v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Partner Endpoints

partner/account

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.

post/partner/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

Messagestring required

Contains a description of the successful message

AccountIDstring required

Account Name of the new user created in the endpoint

APISharedSecretstring required

API Shared Secret

APIKeystring required

The API key for the sub account

ApplicationIDstring required

The onboarding application ID. Only applicable if the account is created in 'Application Pending' status

Linkstring required

The onboarding application link. Only applicable if the account is created in 'Application Pending' status

Example response

{
  "Success": true,
  "AccountID": "AccountTest1",
  "APISharedSecret": "AbcDefGi+KlmnopQRSTu183==",
  "APIKey": "eddc0f5e37d20f98b486daf842447ec1f225f859",
  "ApplicationID": "213086325897",
  "Link": "https://onboarding-app-dev.vopay.com"
}