Skip to main content
POST

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 placing a Circle Match order. Use orderType to select the variant: BURN orders require sourceWalletId and fiatAccountId; MINT orders omit those fields.

​
idempotencyKey
string<uuid>
required

Unique UUID v4 per order. Becomes the orderId for all subsequent lookups. Reusing a key with different parameters returns error 137004.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
orderType
enum<string>
required

Whether this is a BURN (USDC-to-USD) or MINT (USD-to-USDC) order

Available options:
BURN
​
amount
object
required

Amount to burn or mint. Minimum $100, must be a multiple of $100.

​
postFillAction
enum<string>
required

Action to take on unfilled remainder after an auction cycle closes.

  • roll: Carry remainder into the next auction as a new linked order.
  • fallback: Route remainder to standard Circle Mint.
  • cancel: Drop the unfilled remainder.
Available options:
roll,
fallback,
cancel
​
sourceWalletId
string
required

Circle Mint wallet ID that funds the burn

Example:

"1000001234"

​
fiatAccountId
string<uuid>
required

Fiat account that receives settlement proceeds

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
feeBps
string | null

For BURN orders: maximum fee in basis points you are willing to pay. For MINT orders: minimum rebate in basis points you require. Omit or set to null for a market order that matches at any clearing fee.

Example:

"5"

Response

Order accepted and resting in the current auction

​
data
object
required