v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Embedded Experience Endpoints

gcm/recipient-contacts/generate-embed-url

Generate a link to the cross-border iframe for onboarding recipient contacts.

post/gcm/recipient-contacts/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"
}