Embedded Experience Endpoints

gcm/generate-embed-url

Generate link to the crossborder iframe.

post/gcm/generate-embed-url

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/gcm/generate-embed-url
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

The client account ID

ClientNamestring

The client name

ClientReferenceNumberstring

The client reference number

DarkModeboolean

Whether to enable dark mode

Languagestring

The language

StylesheetUrlstring

The stylesheet URL

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Error message if any

Linkstring required

The generated embed URL

Example response

{
  "Success": true,
  "Link": "http://localhost:4174/?Token=1vubj40xc5vdvq0nxocy0ndpk14sstdwovchce2k"
}

Changes

No recorded changes to this operation across all 1 revision of this API.