v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Management Endpoints

account/client-accounts/generate-embed-url

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 name of the recipient.

post/account/client-accounts/generate-embed-url

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

OnboardingLinkstring

The url of the onboarding link.

Example response

{
  "OnboardingLink": "https://request.vopay.com?Token=3s77vg2nwta8c3qc2rwpmmk8w03elfa7rmrsug3l"
}