curl --request POST \
--url https://access.utgl.io/v1/cardaccounts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"phoneNumber": "+85255551234",
"xid": "<string>",
"xmetadata": "<unknown>",
"assetLink": {
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"creditAccount": [
"90dde354-826a-4a0a-b1cb-7f2fc361ad5b"
],
"limit": "10000",
"settlementAccount": "de22c824-b8bd-4825-8db5-e5bdd2371dfb"
}
'import requests
url = "https://access.utgl.io/v1/cardaccounts"
payload = {
"name": "<string>",
"phoneNumber": "+85255551234",
"xid": "<string>",
"xmetadata": "<unknown>",
"assetLink": { "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"creditAccount": ["90dde354-826a-4a0a-b1cb-7f2fc361ad5b"],
"limit": "10000",
"settlementAccount": "de22c824-b8bd-4825-8db5-e5bdd2371dfb"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
phoneNumber: '+85255551234',
xid: '<string>',
xmetadata: '<unknown>',
assetLink: {accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
creditAccount: ['90dde354-826a-4a0a-b1cb-7f2fc361ad5b'],
limit: '10000',
settlementAccount: 'de22c824-b8bd-4825-8db5-e5bdd2371dfb'
})
};
fetch('https://access.utgl.io/v1/cardaccounts', 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://access.utgl.io/v1/cardaccounts",
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([
'name' => '<string>',
'phoneNumber' => '+85255551234',
'xid' => '<string>',
'xmetadata' => '<unknown>',
'assetLink' => [
'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'creditAccount' => [
'90dde354-826a-4a0a-b1cb-7f2fc361ad5b'
],
'limit' => '10000',
'settlementAccount' => 'de22c824-b8bd-4825-8db5-e5bdd2371dfb'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://access.utgl.io/v1/cardaccounts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"phoneNumber\": \"+85255551234\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\",\n \"assetLink\": {\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"creditAccount\": [\n \"90dde354-826a-4a0a-b1cb-7f2fc361ad5b\"\n ],\n \"limit\": \"10000\",\n \"settlementAccount\": \"de22c824-b8bd-4825-8db5-e5bdd2371dfb\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://access.utgl.io/v1/cardaccounts")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"phoneNumber\": \"+85255551234\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\",\n \"assetLink\": {\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"creditAccount\": [\n \"90dde354-826a-4a0a-b1cb-7f2fc361ad5b\"\n ],\n \"limit\": \"10000\",\n \"settlementAccount\": \"de22c824-b8bd-4825-8db5-e5bdd2371dfb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://access.utgl.io/v1/cardaccounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"phoneNumber\": \"+85255551234\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\",\n \"assetLink\": {\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"creditAccount\": [\n \"90dde354-826a-4a0a-b1cb-7f2fc361ad5b\"\n ],\n \"limit\": \"10000\",\n \"settlementAccount\": \"de22c824-b8bd-4825-8db5-e5bdd2371dfb\"\n}"
response = http.request(request)
puts response.read_body{
"balance": 10000.25,
"outstanding": 123,
"disputeAmount": 250,
"available": 825.3,
"limit": 10000.25,
"currency": "HKD",
"accountType": "asset-link",
"identityType": "individual",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"xid": "<string>",
"xmetadata": "<unknown>",
"name": "JOHN CHAN",
"accountNumber": "002-010-1234567-0001",
"balanceUsdEquivalent": 10000.25,
"balanceHkdEquivalent": 10000.25,
"programBalance": 7500.5,
"programOutstanding": 6800,
"assetLink": {
"accountId": "<string>"
},
"phoneNumber": "+85212345678",
"walletId": "0ebd3c68-af60-4a6e-aaa9-040d8e64aa8e",
"status": "active",
"settlementAccountId": "abcb107d-d98d-49ee-8456-73fa693dbb55",
"settlementAccountName": "JOHN CHAN",
"settlementAccountNumber": "002-010-1234567-0001"
}{
"code": "PROGRAM_LIMIT_NOT_AVAILABLE",
"message": "<string>"
}Create Card Account
Create a card account
curl --request POST \
--url https://access.utgl.io/v1/cardaccounts \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"phoneNumber": "+85255551234",
"xid": "<string>",
"xmetadata": "<unknown>",
"assetLink": {
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"creditAccount": [
"90dde354-826a-4a0a-b1cb-7f2fc361ad5b"
],
"limit": "10000",
"settlementAccount": "de22c824-b8bd-4825-8db5-e5bdd2371dfb"
}
'import requests
url = "https://access.utgl.io/v1/cardaccounts"
payload = {
"name": "<string>",
"phoneNumber": "+85255551234",
"xid": "<string>",
"xmetadata": "<unknown>",
"assetLink": { "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" },
"creditAccount": ["90dde354-826a-4a0a-b1cb-7f2fc361ad5b"],
"limit": "10000",
"settlementAccount": "de22c824-b8bd-4825-8db5-e5bdd2371dfb"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
phoneNumber: '+85255551234',
xid: '<string>',
xmetadata: '<unknown>',
assetLink: {accountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
creditAccount: ['90dde354-826a-4a0a-b1cb-7f2fc361ad5b'],
limit: '10000',
settlementAccount: 'de22c824-b8bd-4825-8db5-e5bdd2371dfb'
})
};
fetch('https://access.utgl.io/v1/cardaccounts', 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://access.utgl.io/v1/cardaccounts",
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([
'name' => '<string>',
'phoneNumber' => '+85255551234',
'xid' => '<string>',
'xmetadata' => '<unknown>',
'assetLink' => [
'accountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'creditAccount' => [
'90dde354-826a-4a0a-b1cb-7f2fc361ad5b'
],
'limit' => '10000',
'settlementAccount' => 'de22c824-b8bd-4825-8db5-e5bdd2371dfb'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://access.utgl.io/v1/cardaccounts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"phoneNumber\": \"+85255551234\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\",\n \"assetLink\": {\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"creditAccount\": [\n \"90dde354-826a-4a0a-b1cb-7f2fc361ad5b\"\n ],\n \"limit\": \"10000\",\n \"settlementAccount\": \"de22c824-b8bd-4825-8db5-e5bdd2371dfb\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://access.utgl.io/v1/cardaccounts")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"phoneNumber\": \"+85255551234\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\",\n \"assetLink\": {\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"creditAccount\": [\n \"90dde354-826a-4a0a-b1cb-7f2fc361ad5b\"\n ],\n \"limit\": \"10000\",\n \"settlementAccount\": \"de22c824-b8bd-4825-8db5-e5bdd2371dfb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://access.utgl.io/v1/cardaccounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"phoneNumber\": \"+85255551234\",\n \"xid\": \"<string>\",\n \"xmetadata\": \"<unknown>\",\n \"assetLink\": {\n \"accountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"creditAccount\": [\n \"90dde354-826a-4a0a-b1cb-7f2fc361ad5b\"\n ],\n \"limit\": \"10000\",\n \"settlementAccount\": \"de22c824-b8bd-4825-8db5-e5bdd2371dfb\"\n}"
response = http.request(request)
puts response.read_body{
"balance": 10000.25,
"outstanding": 123,
"disputeAmount": 250,
"available": 825.3,
"limit": 10000.25,
"currency": "HKD",
"accountType": "asset-link",
"identityType": "individual",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"xid": "<string>",
"xmetadata": "<unknown>",
"name": "JOHN CHAN",
"accountNumber": "002-010-1234567-0001",
"balanceUsdEquivalent": 10000.25,
"balanceHkdEquivalent": 10000.25,
"programBalance": 7500.5,
"programOutstanding": 6800,
"assetLink": {
"accountId": "<string>"
},
"phoneNumber": "+85212345678",
"walletId": "0ebd3c68-af60-4a6e-aaa9-040d8e64aa8e",
"status": "active",
"settlementAccountId": "abcb107d-d98d-49ee-8456-73fa693dbb55",
"settlementAccountName": "JOHN CHAN",
"settlementAccountNumber": "002-010-1234567-0001"
}{
"code": "PROGRAM_LIMIT_NOT_AVAILABLE",
"message": "<string>"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Name of card account, this is a human-friendly non unique name for a card account and can be changed later. The card account name is used to identify the card account in reports and in the user interface
Phone number of card holder This phone number should be pre verified by the partner.
"+85255551234"
Type of identity of card holder. Currently only individual is supported.
individual, corporate The accountType field specifies asset-link, prepaid, fixed-limit, or program-limit.
An asset-link card account is backed by combined asset value from a an associated account, which determines the available credit limit of the card account. Repayment on this type of account is settled through the backing account automatically through asset repayments.
A prepaid card account, on the other hand, is pre-funded directly by a top-up action. This operates as a prepaid or pre-funded card model.
A fixed-limit card account has a predetermined credit limit that remains unchanged and is not affected by the value of any associated assets. Repayments on this type of account are settled through alternative methods rather than asset repayments.
A program-limit account has an assigned child limit independent of collateral. The server owns program assignment; public program selectors are rejected. It requires a positive finite limit, identity, currency and settlementAccount. Creation requires your account to be approved for the program-limit account type; the account is then assigned to your program by the server (PROGRAM_ASSIGNMENT_NOT_FOUND if no assignment applies to you).
Please note that the accountType field cannot be changed after the card account has been created.
asset-link, prepaid, fixed-limit, program-limit Currency of card account. Must be a valid ISO 4217 currency code. Please consult your solution manager to ensure the correct account currency for your offered card products
HKD, USD 3External identifier, unique across all resources created under this account.
Individual card holder identity information. This is required when account type is individual.
Show child attributes
Show child attributes
Asset link configuration of card account, applicable only when accountType is asset-link
If assetLink is not provided, an account will be created and linked to this card account for both asset backing and repayment.
Show child attributes
Show child attributes
This is array of accountIds where the fixed-limit credit come from, the total limit of all the card accounts (under the same credit account) add up cannot exceed the credit account asset balance. When accountType is set to fixed-limit, this additional parameter needs to be passed in.
["90dde354-826a-4a0a-b1cb-7f2fc361ad5b"]
This is the assigned child limit for fixed-limit or program-limit. Program-limit requires a positive finite amount; this does not update the parent facility ceiling. When accountType is set to fixed-limit, this additional parameter needs to be passed in.
"10000"
This is the settlement account for fixed-limit or program-limit, required for both types. When accountType is set to fixed-limit, this additional parameter needs to be passed in.
"de22c824-b8bd-4825-8db5-e5bdd2371dfb"
Response
OK
The current real-time balance of the card account in the account currency. All transactions in the account are added up to calculate this balance. Purchases and cash withdrawals increase it, while payments and credits decrease it.
For prepaid accounts, the balance will always be negative to indicate a debit balance.
10000.25
The outstanding (captured) balance in the card account currency that needs to be repaid. Meaningful for the credit account types (asset-link, fixed-limit and program-limit).
The card account amount currently under dispute in the card account currency. Returns 0 when there is no disputed amount.
250
The available spendable amount on the card account. It is calculated by subtracting the balance from the assigned credit limit.
This value represents the total available spendable limit for asset-link, prepaid, fixed-limit and program-limit accounts.
On a program record it always equals limit, because the facility's own balance stays at zero; use limit minus programBalance for the remaining program capacity.
A positive value indicates that the card account has available spendable limit. For pre-paid mode accounts, this is the only value that should be used to determine the account's current available balance.
825.3
In Asset-link mode, this is the credit limit assigned to the card account.
For prepaid accounts, the limit is always zero.
For program-limit accounts, this is the limit assigned to that child account.
For a program account, this is the facility ceiling shared across its children; compare it against programBalance to obtain the remaining shared capacity.
10000.25
Currency of the card account.
"HKD"
program is the shared program credit line itself; it is listed as an ordinary card account record.
asset-link, prepaid, fixed-limit, program-limit, program The type of identity associated with the card holder. Must be either "individual" or "corporate".
individual, corporate ID of resource
External identifier, unique across all resources created under this account.
Name of card account
"JOHN CHAN"
Account number of card account
"002-010-1234567-0001"
The equivalent balance of the card account in USD.
10000.25
The equivalent balance of the card account in HKD.
10000.25
Program settlement exposure including reservations. Only returned when accountType is program.
7500.5
Captured program settlement exposure, excluding reservations, so it is never greater than programBalance. Can be negative when refunds or credits exceed captures. Only returned when accountType is program.
6800
Asset link configuration
Show child attributes
Show child attributes
Contact phone number of card holder, also used to receive 3DS one time passcodes. Phone number of card holder, also used to receive 3DS one time passcodes. Partner must ensure that this phone number has been verified.
"+85212345678"
The walletId is one of the Waillets bound to a card account.
"0ebd3c68-af60-4a6e-aaa9-040d8e64aa8e"
The status of card account.
active, frozen "active"
Settlement account id for the fixed limit card account
"abcb107d-d98d-49ee-8456-73fa693dbb55"
Settlement account name for the fixed limit card account
"JOHN CHAN"
Settlement account number for the fixed limit card account
"002-010-1234567-0001"
Was this page helpful?