Get a tokenization advance
curl --request GET \
--url https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}', 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-sandbox.circle.com/v1/credit/tokenization/advances/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "c4a2e6f8-3b1d-4f7a-9e2c-5d8b0a1f3e6c",
"amount": {
"amount": "15000.00",
"currency": "USD"
},
"status": "disbursed",
"outstanding": {
"amount": "15030.00",
"currency": "USD"
},
"fees": {
"total": {
"amount": "30.00",
"currency": "USD"
},
"unpaid": {
"amount": "30.00",
"currency": "USD"
}
},
"dueDate": "2024-03-27T14:10:05.000Z",
"disbursedDate": "2024-03-20T14:10:05.000Z",
"accountId": "1000000",
"createDate": "2024-03-20T14:10:02.000Z",
"updateDate": "2024-03-20T14:10:05.000Z",
"provider": "ALPACA",
"providerAccountId": "a7c1e3f0-5d2b-4c8e-9f61-2b7d4e8a1c90",
"transactionHash": "0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f",
"symbol": "AAPL",
"burnedShareQuantity": "100",
"orders": [
{
"orderId": "e2f8a4c6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
"submittedAt": "2024-03-20T14:05:12.000Z",
"allocatedShares": "60",
"weightedAveragePrice": "172.45"
},
{
"orderId": "b9d7c5e3-a1f2-4d6b-8c0e-3f5a7b9d1e2c",
"submittedAt": "2024-03-20T14:06:40.000Z",
"allocatedShares": "40",
"weightedAveragePrice": "172.30"
}
]
}
}{
"code": 400,
"message": "Bad request."
}{
"code": 401,
"message": "Malformed authorization."
}{
"code": 404,
"message": "Not found."
}Get a tokenization advance
Returns a tokenization advance with the token burn and the orders that back it.
Fields outstanding, fees, dueDate, and disbursedDate are only present once the advance reaches disbursed, paid, or past_due status.
GET
/
v1
/
credit
/
tokenization
/
advances
/
{id}
Get a tokenization advance
curl --request GET \
--url https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}', 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-sandbox.circle.com/v1/credit/tokenization/advances/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/credit/tokenization/advances/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "c4a2e6f8-3b1d-4f7a-9e2c-5d8b0a1f3e6c",
"amount": {
"amount": "15000.00",
"currency": "USD"
},
"status": "disbursed",
"outstanding": {
"amount": "15030.00",
"currency": "USD"
},
"fees": {
"total": {
"amount": "30.00",
"currency": "USD"
},
"unpaid": {
"amount": "30.00",
"currency": "USD"
}
},
"dueDate": "2024-03-27T14:10:05.000Z",
"disbursedDate": "2024-03-20T14:10:05.000Z",
"accountId": "1000000",
"createDate": "2024-03-20T14:10:02.000Z",
"updateDate": "2024-03-20T14:10:05.000Z",
"provider": "ALPACA",
"providerAccountId": "a7c1e3f0-5d2b-4c8e-9f61-2b7d4e8a1c90",
"transactionHash": "0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f",
"symbol": "AAPL",
"burnedShareQuantity": "100",
"orders": [
{
"orderId": "e2f8a4c6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
"submittedAt": "2024-03-20T14:05:12.000Z",
"allocatedShares": "60",
"weightedAveragePrice": "172.45"
},
{
"orderId": "b9d7c5e3-a1f2-4d6b-8c0e-3f5a7b9d1e2c",
"submittedAt": "2024-03-20T14:06:40.000Z",
"allocatedShares": "40",
"weightedAveragePrice": "172.30"
}
]
}
}{
"code": 400,
"message": "Bad request."
}{
"code": 401,
"message": "Malformed authorization."
}{
"code": 404,
"message": "Not found."
}Authorizations
Path Parameters
Was this page helpful?