Common parameters

el required

  • Type: string

  • Example: #switchere

  • Details:
    Query selector for mount widget. Required element with this selector in the html document.
    Not required if mode == modal.

partnerKey required

  • Type: string

  • Example: XXXXXXXXXXX

  • Details:
    Unique partner API key, you should create it in the partner settings.

httpReturnSuccess required

  • Type: string

  • Example: https://domain.tld/success

  • Details:
    While order can be finished, this url will be used to redirect back to your site.

    TIP

    Not required if provide closeButton

httpReturnFailed required

  • Type: string

  • Example: https://domain.tld/failed

  • Details:
    If order was canceled or moved to error state, this url will be used to redirect back to your site.

    TIP

    Not required if provide closeButton

partnerOrderId

  • Type: string

  • Default: null

  • Example: ABCDEFG-1234567

  • Details:
    Unique partner id for the order, 64 characters [A-Za-z0-9-_] - you should make it up yourself - it should be UNIQ.

closeButton

closeButtonCallback

  • Type: (data: 'success' | 'failed') => void

  • Default: null

  • Details:
    Javascript callback. Calling when Close button is clicked. closeButton is required. Argument can be 'success' or 'failed'.
    Also see: Introduction -> Show close button.

lang

  • Type: string

  • Default: null

  • Value:
    en - English
    de - Deutsch
    kr - Korean
    es - EspaƱol

  • Details
    Language for the widget. If not provide, language will set automatically by IP address.

mode

theme

  • Type: string

  • Default: null

  • Details:
    Unique theme id

TIP

Also see field parameters.

payToPartner

  • Type: boolean

  • Default false

  • Details:
    If payToPartner == true then money will be sent to partner account after exchange. Parameter payoutCurrency is required. Compatible only with crypto currencies.

Last Updated: