Skip to main content

SessionDataRequestV2

partnerNamestringrequired

Partner's display name

Example: YourName
sourceDetails object

Source details - amount, currency, and payment method

amountnumber

Source amount used for buying crypto

Example: 100
currencystring

Source currency used for buying crypto

Example: USD
preferredPaymentMethodPaymentMethod (string)

The payment method used by the customer

Possible values: [CARD, BALANCE]

Example: CARD
allowWalletAddressChangeboolean

Allow the customer to enter a wallet address, different from the provided one/s

Example: true
destinationDetails object[]

A list of destination asset details - crypto currency, network, wallet address, wallet address tag

  • Array [
    • currencystringrequired

    The cryptocurrency the customers wants to purchase

    Example: BTC
    networkstringrequired

    The network of the cryptocurrency

    Example: Mainnet
    walletAddressstring

    A crypto wallet address to receive the crypto funds

    Example: 3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy
    walletAddressTagstring

    Tag, memo, or any additional identifier of the destination wallet address

    Example: abc123
  • ]
    • externalReferenceIdstring

    Partner's unique reference id for the purchase (transaction ID)

    Example: 480b3d52-8a7b-42f6-845a-1dd0fb3ed7c3
    webhookUrlstring

    Partner's URL address on which webhooks will be received

    Example: http://example.com/webhook/url
    returnUrl object

    Return URLs provided by the partner

    successstring

    Success URL, used to return the customer back to the partner after a successful transaction

    Example: http://example.com/success
    failurestring

    Failure URL, used to return the customer back to the partner after a failed transaction

    Example: http://example.com/failure
    defaultstring

    Default URL, used if success and/or failure URLs are not provided

    Example: http://example.com/default
    countryIdstring

    The customer's country (ISO3166-1 alpha-3)

    Example: EST
    languagestring

    Pre-select language for the customer. If not provided, the default language is English. Accepted values:

    • en - English
    • cs - Czech
    • es - Spanish
    • fr - French
    • it - Italian
    • el - Greek
    • pl - Polish
    • pt - Portuguese
    • de - German
    Example: es
    SessionDataRequestV2
    {
      "partnerName": "YourName",
      "sourceDetails": {
        "currency": "EUR",
        "amount": 100,
        "preferredPaymentMethod": "CARD"
      },
      "allowWalletAddressChange": false,
      "destinationDetails": [
        {
          "currency": "BTC",
          "network": "Mainnet",
          "walletAddress": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy"
        }
      ],
      "webhookUrl": "http://example.com/webhook/url",
      "returnUrl": {
        "success": "http://example.com/return?paymentStatus=success",
        "default": "http://example.com/return?paymentStatus=default",
        "failure": "http://example.com/return?paymentStatus=failure"
      },
      "countryId": "EST",
      "language": "es"
    }