Request reserved funds
curl --request PUT \
--url https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form fileName=wire_proof.pdf \
--form fileContent='@example-file'import requests
url = "https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds"
files = { "fileContent": ("example-file", open("example-file", "rb")) }
payload = { "fileName": "wire_proof.pdf" }
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('fileName', 'wire_proof.pdf');
form.append('fileContent', '<string>');
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds', 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/transfers/{id}/requestReservedFunds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"id": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
"amount": {
"amount": "100000.00",
"currency": "USD"
},
"status": "requested",
"createDate": "2024-03-20T14:30:00.000Z",
"updateDate": "2024-03-20T14:45:00.000Z"
}
}{
"code": 400,
"message": "Bad request."
}{
"code": 401,
"message": "Malformed authorization."
}{
"code": 404,
"message": "Not found."
}Request reserved funds
Transitions a funds_reserved transfer to requested status by uploading evidence (wire proof). This initiates the manual approval process for Settlement Advance transfers.
The request must include an evidence file (wire proof) as multipart form data. Allowed file types are application/pdf, image/jpeg, and image/png.
Note: This endpoint is only available for Settlement Advance products.
PUT
/
v1
/
credit
/
transfers
/
{id}
/
requestReservedFunds
Request reserved funds
curl --request PUT \
--url https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form fileName=wire_proof.pdf \
--form fileContent='@example-file'import requests
url = "https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds"
files = { "fileContent": ("example-file", open("example-file", "rb")) }
payload = { "fileName": "wire_proof.pdf" }
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('fileName', 'wire_proof.pdf');
form.append('fileContent', '<string>');
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds', 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/transfers/{id}/requestReservedFunds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/credit/transfers/{id}/requestReservedFunds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nwire_proof.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"fileContent\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"id": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
"amount": {
"amount": "100000.00",
"currency": "USD"
},
"status": "requested",
"createDate": "2024-03-20T14:30:00.000Z",
"updateDate": "2024-03-20T14:45:00.000Z"
}
}{
"code": 400,
"message": "Bad request."
}{
"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
Universally unique identifier (UUID v4) of a resource.
Example:
"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"
Body
multipart/form-data
Response
Successfully requested reserved funds.
A credit transfer (drawdown) from the credit line.
Show child attributes
Show child attributes
Was this page helpful?
⌘I