Dispute Management Endpoints

dispute-management/generate-embed-url

This endpoint generates a unique URL to embed into your application using an iFrame.

post/dispute-management/generate-embed-url

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/dispute-management/generate-embed-url
  • 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

StylesheetUrlstring

Stylesheet URL for the iframe

Languagestring

The language for the iframe. 'en' for English, 'fr' for French. Defaults to 'en'.

DarkModeboolean

Whether to use dark mode for the iframe. Defaults to false.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Linkstring

The URL to embed into your application using an iFrame.

IframeKeystring

A unique key for the iFrame.

Example response

{
  "Link": "https://dispute-management.vopay.com/?Token=3s77vg2nwta8c3qc2rwpmmk8w03elfa7rmrsug3l",
  "IframeKey": "3s77vg2nwta8c3qc2rwpmmk8w03elfa7rmrsug3l"
}

Changes

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