curl --request POST \
--url https://api.prod.finverse.net/mandates/link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"link_customizations": {
"countries": [
"HKG",
"SGP"
],
"institution_id": "hsbc-hk",
"institution_status": "alpha beta supported",
"language": "en",
"link_mode": "real",
"products_supported": [
"ACCOUNTS",
"TRANSACTIONS",
"MANDATE"
],
"redirect_uri": "<string>",
"ui_mode": "redirect",
"user_type": [
"PERSONAL"
]
},
"mandate_id": "<string>"
}
'import requests
url = "https://api.prod.finverse.net/mandates/link"
payload = {
"link_customizations": {
"countries": ["HKG", "SGP"],
"institution_id": "hsbc-hk",
"institution_status": "alpha beta supported",
"language": "en",
"link_mode": "real",
"products_supported": ["ACCOUNTS", "TRANSACTIONS", "MANDATE"],
"redirect_uri": "<string>",
"ui_mode": "redirect",
"user_type": ["PERSONAL"]
},
"mandate_id": "<string>"
}
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({
link_customizations: {
countries: ['HKG', 'SGP'],
institution_id: 'hsbc-hk',
institution_status: 'alpha beta supported',
language: 'en',
link_mode: 'real',
products_supported: ['ACCOUNTS', 'TRANSACTIONS', 'MANDATE'],
redirect_uri: '<string>',
ui_mode: 'redirect',
user_type: ['PERSONAL']
},
mandate_id: '<string>'
})
};
fetch('https://api.prod.finverse.net/mandates/link', 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.prod.finverse.net/mandates/link",
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([
'link_customizations' => [
'countries' => [
'HKG',
'SGP'
],
'institution_id' => 'hsbc-hk',
'institution_status' => 'alpha beta supported',
'language' => 'en',
'link_mode' => 'real',
'products_supported' => [
'ACCOUNTS',
'TRANSACTIONS',
'MANDATE'
],
'redirect_uri' => '<string>',
'ui_mode' => 'redirect',
'user_type' => [
'PERSONAL'
]
],
'mandate_id' => '<string>'
]),
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.prod.finverse.net/mandates/link"
payload := strings.NewReader("{\n \"link_customizations\": {\n \"countries\": [\n \"HKG\",\n \"SGP\"\n ],\n \"institution_id\": \"hsbc-hk\",\n \"institution_status\": \"alpha beta supported\",\n \"language\": \"en\",\n \"link_mode\": \"real\",\n \"products_supported\": [\n \"ACCOUNTS\",\n \"TRANSACTIONS\",\n \"MANDATE\"\n ],\n \"redirect_uri\": \"<string>\",\n \"ui_mode\": \"redirect\",\n \"user_type\": [\n \"PERSONAL\"\n ]\n },\n \"mandate_id\": \"<string>\"\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.prod.finverse.net/mandates/link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"link_customizations\": {\n \"countries\": [\n \"HKG\",\n \"SGP\"\n ],\n \"institution_id\": \"hsbc-hk\",\n \"institution_status\": \"alpha beta supported\",\n \"language\": \"en\",\n \"link_mode\": \"real\",\n \"products_supported\": [\n \"ACCOUNTS\",\n \"TRANSACTIONS\",\n \"MANDATE\"\n ],\n \"redirect_uri\": \"<string>\",\n \"ui_mode\": \"redirect\",\n \"user_type\": [\n \"PERSONAL\"\n ]\n },\n \"mandate_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.finverse.net/mandates/link")
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 \"link_customizations\": {\n \"countries\": [\n \"HKG\",\n \"SGP\"\n ],\n \"institution_id\": \"hsbc-hk\",\n \"institution_status\": \"alpha beta supported\",\n \"language\": \"en\",\n \"link_mode\": \"real\",\n \"products_supported\": [\n \"ACCOUNTS\",\n \"TRANSACTIONS\",\n \"MANDATE\"\n ],\n \"redirect_uri\": \"<string>\",\n \"ui_mode\": \"redirect\",\n \"user_type\": [\n \"PERSONAL\"\n ]\n },\n \"mandate_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"access_token": "link_token",
"expires_in": 300,
"issued_at": "2022-09-01T01:01:00.000Z",
"link_url": "https://link.sandbox.finverse.net/onboarding?mandate_id=ULID&products_supported=PAYMENTStoken=link_token",
"token_type": "Bearer"
}Generate link_url
Generate a short-lived Finverse Link URL (link_url) and access_token (referred to as link_token) to open the Finverse Link UI (in Mandate mode) in a browser window to allow an End-User to authorize the Mandate. The link_token is associated with a specific Customer App (client_id) and End-User (user_id), and expires after 60 minutes (resend request to renew).
Authorization: customer_token.
link_customizations (object, required)
Required parameters for link_customizations
Optional parameters for link_customizations
You can use the following optional parameters to customize the behaviour of Finverse Link’s UI to fit your implementation requirements.
Token handling
Usage
link_token is intended for use by front-end clients to call Finverse API. It is the only Finverse API token that is considered non-sensitive.
Renewal
link_token expires after 60 minutes.
Repeat this request for token renewal.
curl --request POST \
--url https://api.prod.finverse.net/mandates/link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"link_customizations": {
"countries": [
"HKG",
"SGP"
],
"institution_id": "hsbc-hk",
"institution_status": "alpha beta supported",
"language": "en",
"link_mode": "real",
"products_supported": [
"ACCOUNTS",
"TRANSACTIONS",
"MANDATE"
],
"redirect_uri": "<string>",
"ui_mode": "redirect",
"user_type": [
"PERSONAL"
]
},
"mandate_id": "<string>"
}
'import requests
url = "https://api.prod.finverse.net/mandates/link"
payload = {
"link_customizations": {
"countries": ["HKG", "SGP"],
"institution_id": "hsbc-hk",
"institution_status": "alpha beta supported",
"language": "en",
"link_mode": "real",
"products_supported": ["ACCOUNTS", "TRANSACTIONS", "MANDATE"],
"redirect_uri": "<string>",
"ui_mode": "redirect",
"user_type": ["PERSONAL"]
},
"mandate_id": "<string>"
}
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({
link_customizations: {
countries: ['HKG', 'SGP'],
institution_id: 'hsbc-hk',
institution_status: 'alpha beta supported',
language: 'en',
link_mode: 'real',
products_supported: ['ACCOUNTS', 'TRANSACTIONS', 'MANDATE'],
redirect_uri: '<string>',
ui_mode: 'redirect',
user_type: ['PERSONAL']
},
mandate_id: '<string>'
})
};
fetch('https://api.prod.finverse.net/mandates/link', 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.prod.finverse.net/mandates/link",
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([
'link_customizations' => [
'countries' => [
'HKG',
'SGP'
],
'institution_id' => 'hsbc-hk',
'institution_status' => 'alpha beta supported',
'language' => 'en',
'link_mode' => 'real',
'products_supported' => [
'ACCOUNTS',
'TRANSACTIONS',
'MANDATE'
],
'redirect_uri' => '<string>',
'ui_mode' => 'redirect',
'user_type' => [
'PERSONAL'
]
],
'mandate_id' => '<string>'
]),
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.prod.finverse.net/mandates/link"
payload := strings.NewReader("{\n \"link_customizations\": {\n \"countries\": [\n \"HKG\",\n \"SGP\"\n ],\n \"institution_id\": \"hsbc-hk\",\n \"institution_status\": \"alpha beta supported\",\n \"language\": \"en\",\n \"link_mode\": \"real\",\n \"products_supported\": [\n \"ACCOUNTS\",\n \"TRANSACTIONS\",\n \"MANDATE\"\n ],\n \"redirect_uri\": \"<string>\",\n \"ui_mode\": \"redirect\",\n \"user_type\": [\n \"PERSONAL\"\n ]\n },\n \"mandate_id\": \"<string>\"\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.prod.finverse.net/mandates/link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"link_customizations\": {\n \"countries\": [\n \"HKG\",\n \"SGP\"\n ],\n \"institution_id\": \"hsbc-hk\",\n \"institution_status\": \"alpha beta supported\",\n \"language\": \"en\",\n \"link_mode\": \"real\",\n \"products_supported\": [\n \"ACCOUNTS\",\n \"TRANSACTIONS\",\n \"MANDATE\"\n ],\n \"redirect_uri\": \"<string>\",\n \"ui_mode\": \"redirect\",\n \"user_type\": [\n \"PERSONAL\"\n ]\n },\n \"mandate_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.finverse.net/mandates/link")
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 \"link_customizations\": {\n \"countries\": [\n \"HKG\",\n \"SGP\"\n ],\n \"institution_id\": \"hsbc-hk\",\n \"institution_status\": \"alpha beta supported\",\n \"language\": \"en\",\n \"link_mode\": \"real\",\n \"products_supported\": [\n \"ACCOUNTS\",\n \"TRANSACTIONS\",\n \"MANDATE\"\n ],\n \"redirect_uri\": \"<string>\",\n \"ui_mode\": \"redirect\",\n \"user_type\": [\n \"PERSONAL\"\n ]\n },\n \"mandate_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"access_token": "link_token",
"expires_in": 300,
"issued_at": "2022-09-01T01:01:00.000Z",
"link_url": "https://link.sandbox.finverse.net/onboarding?mandate_id=ULID&products_supported=PAYMENTStoken=link_token",
"token_type": "Bearer"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
request body for mandate authorization link
Response
Successful
Link session token (referred to as link_token)
Token validity length (in seconds)
URL to launch the Finverse Link UI flow associated with this link_token, for the end-user to provide required consent and Mandate/Payment inputs.
Possible values: Bearer
Bearer