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 '
{
"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
}
'import requests
url = "https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget"
payload := strings.NewReader("{\n \"sessionData\": {\n \"countryCode\": \"<string>\",\n \"serviceProvider\": \"<string>\",\n \"sourceCurrencyCode\": \"<string>\",\n \"sourceAmount\": \"<string>\",\n \"destinationCurrencyCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"walletTag\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"lockFields\": [\n \"<string>\"\n ]\n },\n \"externalSessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"bypassKyc\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sessionData\": {\n \"countryCode\": \"<string>\",\n \"serviceProvider\": \"<string>\",\n \"sourceCurrencyCode\": \"<string>\",\n \"sourceAmount\": \"<string>\",\n \"destinationCurrencyCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"walletTag\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"lockFields\": [\n \"<string>\"\n ]\n },\n \"externalSessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"bypassKyc\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sessionData\": {\n \"countryCode\": \"<string>\",\n \"serviceProvider\": \"<string>\",\n \"sourceCurrencyCode\": \"<string>\",\n \"sourceAmount\": \"<string>\",\n \"destinationCurrencyCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"walletTag\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"lockFields\": [\n \"<string>\"\n ]\n },\n \"externalSessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"bypassKyc\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"token": "<string>",
"widgetUrl": "<string>",
"customerId": "<string>",
"externalCustomerId": "<string>",
"externalSessionId": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Meld
Create widget session
Creates a Meld widget session for the chosen service provider and returns
the embeddable widgetUrl plus a single-use session token.
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 '
{
"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
}
'import requests
url = "https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget"
payload := strings.NewReader("{\n \"sessionData\": {\n \"countryCode\": \"<string>\",\n \"serviceProvider\": \"<string>\",\n \"sourceCurrencyCode\": \"<string>\",\n \"sourceAmount\": \"<string>\",\n \"destinationCurrencyCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"walletTag\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"lockFields\": [\n \"<string>\"\n ]\n },\n \"externalSessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"bypassKyc\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sessionData\": {\n \"countryCode\": \"<string>\",\n \"serviceProvider\": \"<string>\",\n \"sourceCurrencyCode\": \"<string>\",\n \"sourceAmount\": \"<string>\",\n \"destinationCurrencyCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"walletTag\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"lockFields\": [\n \"<string>\"\n ]\n },\n \"externalSessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"bypassKyc\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/meld/retail/widget")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sessionData\": {\n \"countryCode\": \"<string>\",\n \"serviceProvider\": \"<string>\",\n \"sourceCurrencyCode\": \"<string>\",\n \"sourceAmount\": \"<string>\",\n \"destinationCurrencyCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"walletTag\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"lockFields\": [\n \"<string>\"\n ]\n },\n \"externalSessionId\": \"<string>\",\n \"customerId\": \"<string>\",\n \"bypassKyc\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"token": "<string>",
"widgetUrl": "<string>",
"customerId": "<string>",
"externalCustomerId": "<string>",
"externalSessionId": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.
Body
application/json
Response
Widget session created successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I