Get settlement instructions
curl --request GET \
--url https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency}"
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/exchange/trades/settlements/instructions/{currency}', 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/exchange/trades/settlements/instructions/{currency}",
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/exchange/trades/settlements/instructions/{currency}"
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/exchange/trades/settlements/instructions/{currency}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency}")
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": {
"currency": "MXN",
"fiatAccountType": "wire",
"instruction": {
"trackingRef": "CIR13FB13A",
"beneficiary": {
"name": "CIRCLE INTERNET FINANCIAL INC",
"address1": "99 HIGH STREET",
"address2": "BOSTON MA 02110"
},
"beneficiaryBank": {
"name": "WELLS FARGO BANK",
"swiftCode": "WFBIUS6SXXX",
"routingNumber": "121000248",
"accountNumber": "****7427",
"currency": "USD",
"address": "4250 EXECUTIVE SQUARE SUITE 300",
"city": "LA JOLLA",
"postalCode": "02110",
"country": "US"
}
}
}
}{
"code": 401,
"message": "Malformed authorization."
}{
"code": 404,
"message": "Not found."
}Get settlement instructions
Returns settlement instructions for a specific currency.
GET
/
v1
/
exchange
/
trades
/
settlements
/
instructions
/
{currency}
Get settlement instructions
curl --request GET \
--url https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency}"
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/exchange/trades/settlements/instructions/{currency}', 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/exchange/trades/settlements/instructions/{currency}",
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/exchange/trades/settlements/instructions/{currency}"
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/exchange/trades/settlements/instructions/{currency}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/exchange/trades/settlements/instructions/{currency}")
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": {
"currency": "MXN",
"fiatAccountType": "wire",
"instruction": {
"trackingRef": "CIR13FB13A",
"beneficiary": {
"name": "CIRCLE INTERNET FINANCIAL INC",
"address1": "99 HIGH STREET",
"address2": "BOSTON MA 02110"
},
"beneficiaryBank": {
"name": "WELLS FARGO BANK",
"swiftCode": "WFBIUS6SXXX",
"routingNumber": "121000248",
"accountNumber": "****7427",
"currency": "USD",
"address": "4250 EXECUTIVE SQUARE SUITE 300",
"city": "LA JOLLA",
"postalCode": "02110",
"country": "US"
}
}
}
}{
"code": 401,
"message": "Malformed authorization."
}{
"code": 404,
"message": "Not found."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Fiat currency name.
Available options:
BRL, MXN Response
Successfully retrieved settlement instructions.
- Option 1
- Option 2
Show child attributes
Show child attributes
Was this page helpful?
⌘I