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 \
  --form transactionHash=0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f

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",
    "transactionHash": "0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f"
}
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>');
form.append('transactionHash', '0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f');

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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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",
    "accountId": "1000000"
  }
}

Request reserved funds

Transitions a funds_reserved transfer to requested status by uploading evidence (wire proof for Settlement Advance or receipt for RWA Redemption Advance).

The request must include an evidence file as multipart form data. Allowed file types are application/pdf, image/jpeg, and image/png.

For RWA Redemption Advance, transactionHash is required and specifies the EVM transaction hash of the confirmed burn transaction on Arc. The onchain burn must have occurred within 24 hours of request time, reached finality, and transferred a positive amount of a whitelisted token to the zero address. Receipt evidence is verified against the onchain burn via automated AI verification.

Providing transactionHash for non-RWA lines is rejected with HTTP 400.

Note: This endpoint is only available for Settlement Advance and RWA Redemption Advance products. RWA Redemption Advance lines connected to a tokenization provider must use the create tokenization advance endpoint instead.

PUT

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 \
  --form transactionHash=0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f

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",
    "transactionHash": "0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f"
}
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>');
form.append('transactionHash', '0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f');

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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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\r\nContent-Disposition: form-data; name=\"transactionHash\"\r\n\r\n0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f\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",
    "accountId": "1000000"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

multipart/form-data

fileName

string

required

Name of the evidence file.

Example:

"wire_proof.pdf"

fileContent

file

required

The evidence file content. Allowed types are application/pdf, image/jpeg, and image/png.

transactionHash

string

The 0x-prefixed 32-byte EVM transaction hash of the confirmed burn transaction on Arc. Required for RWA Redemption Advance; rejected if provided for other credit line types.

Pattern: ^0x[0-9a-fA-F]{64}$

Example:

"0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f"

Response

Successfully requested reserved funds.

data

object

A credit transfer (drawdown) from the credit line.

Show child attributes

API overview

Custody API

Mint API

Cross-currency API

Reserve management API

Credit API

Digital Asset-Backed Borrowing

Webhook events

Request reserved funds

Authorizations

Path Parameters

Body

Response