curl --request POST \
  --url https://api-sandbox.circle.com/v1/credit/tokenization/advances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "provider": "ALPACA",
  "providerAccountId": "a7c1e3f0-5d2b-4c8e-9f61-2b7d4e8a1c90",
  "transactionHash": "0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f",
  "orders": [
    {
      "orderId": "e2f8a4c6-1b3d-4e5f-8a9b-0c1d2e3f4a5b"
    },
    {
      "orderId": "b9d7c5e3-a1f2-4d6b-8c0e-3f5a7b9d1e2c"
    }
  ],
  "amount": {
    "amount": "15000.00",
    "currency": "USD"
  }
}
'

{
  "data": {
    "id": "c4a2e6f8-3b1d-4f7a-9e2c-5d8b0a1f3e6c",
    "amount": {
      "amount": "15000.00",
      "currency": "USD"
    },
    "status": "requested",
    "accountId": "1000000",
    "createDate": "2024-03-20T14:10:02.000Z",
    "updateDate": "2024-03-20T14:10:02.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."
}

{
  "code": 409,
  "message": "Conflicts with another request."
}

Create a tokenization advance

Requests an RWA Redemption Advance backed by a token burn on Arc and the brokerage sell orders for the underlying shares. The advance is validated when you submit it. There is no reserve step and no manual review, so a valid request returns requested and disburses asynchronously.

List the burn’s eligible orders first, then send the IDs of the orders to use. The orders’ available shares must cover the burned token quantity, at one share per token. Circle counts shares from the highest-valued order first, and orders with the same value from the oldest first, until it reaches the burned token quantity. The order that reaches it counts only the shares still needed. An order that contributes no shares is not used and stays available for another advance.

amount must not exceed the value of the counted shares, after the advance rate for the token. Each order’s advanceLimit from the list eligible orders endpoint shows this value for that order alone.

Every order with counted shares is used in full, even when only some of its shares were counted. A burn backs at most one advance. Reusing a burn returns HTTP 409.

Note: This endpoint is only available for RWA Redemption Advance products with a provider connection.

POST

credit

tokenization

advances

curl --request POST \
  --url https://api-sandbox.circle.com/v1/credit/tokenization/advances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "provider": "ALPACA",
  "providerAccountId": "a7c1e3f0-5d2b-4c8e-9f61-2b7d4e8a1c90",
  "transactionHash": "0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f",
  "orders": [
    {
      "orderId": "e2f8a4c6-1b3d-4e5f-8a9b-0c1d2e3f4a5b"
    },
    {
      "orderId": "b9d7c5e3-a1f2-4d6b-8c0e-3f5a7b9d1e2c"
    }
  ],
  "amount": {
    "amount": "15000.00",
    "currency": "USD"
  }
}
'

{
  "data": {
    "id": "c4a2e6f8-3b1d-4f7a-9e2c-5d8b0a1f3e6c",
    "amount": {
      "amount": "15000.00",
      "currency": "USD"
    },
    "status": "requested",
    "accountId": "1000000",
    "createDate": "2024-03-20T14:10:02.000Z",
    "updateDate": "2024-03-20T14:10:02.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."
}

{
  "code": 409,
  "message": "Conflicts with another request."
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request body for creating a tokenization advance.

idempotencyKey

string<uuid>

required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

provider

enum<string>

required

The tokenization provider.

Available options:

ALPACA

Example:

"ALPACA"

providerAccountId

string

required

The provider account that placed the sell orders.

Example:

"a7c1e3f0-5d2b-4c8e-9f61-2b7d4e8a1c90"

transactionHash

string

required

The transaction hash of the token burn on Arc (0x-prefixed 32-byte hex string).

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

Example:

"0x5ba3602c1ffcbac77db82bf1360fe44f2042042c782e9114ea29ecb1708c239f"

orders

object[]

required

The sell orders to back the advance. Each order ID may appear once. Circle decides how many shares of each order to count.

Minimum array length: 1

Show child attributes

amount

object

required

The amount to advance. Currency must match the credit line currency.

Show child attributes

destination

object

Optional blockchain destination for the advance. When provided, disbursed funds are sent to the specified verified blockchain address instead of the default fiat account.

Show child attributes

accountId

string

Optional identifier of the funding account for the advance. When omitted, falls back to the entity's default funding account.

Example:

"1000000"

Response

Successfully created a tokenization advance.

data

object

An RWA Redemption Advance backed by a token burn and brokerage sell orders.

Show child attributes

API overview

Custody API

Mint API

Cross-currency API

Reserve management API

Credit API

Digital Asset-Backed Borrowing

Webhook events

Create a tokenization advance

Authorizations

Body

Response