Skip to main content
POST
/
clients
/
me
/
integrations
/
meld
/
retail
/
widget
Create widget session
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionType": "BUY",
  "sessionData": {
    "countryCode": "<string>",
    "serviceProvider": "<string>",
    "sourceCurrencyCode": "<string>",
    "sourceAmount": "<string>",
    "destinationCurrencyCode": "<string>",
    "walletAddress": "<string>",
    "walletTag": "<string>",
    "paymentMethodType": "<string>",
    "redirectUrl": "<string>",
    "lockFields": [
      "<string>"
    ]
  },
  "externalSessionId": "<string>",
  "customerId": "<string>",
  "bypassKyc": true
}
'
{
  "data": {
    "id": "<string>",
    "token": "<string>",
    "widgetUrl": "<string>",
    "customerId": "<string>",
    "externalCustomerId": "<string>",
    "externalSessionId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
​
sessionType
enum<string>
required
Available options:
BUY,
SELL,
TRANSFER
​
sessionData
object
required
​
externalSessionId
string
​
customerId
string
​
bypassKyc
boolean

Response

Widget session created successfully

​
data
object