Use this file to discover all available pages before exploring further.
This quickstart walks through a complete Settlement Advance draw lifecycle: you
check the credit line, reserve funds, send a wire and upload proof, observe
disbursement and accrued fees, and then repay by wire and confirm the repayment.
For the conceptual model behind these calls, see the
Credit API concept page.
{ "data": { "id": "c9f2a1b3-6d84-4e0f-b512-9a8c7e3d4f01", "description": "WELLS FARGO BANK, NA ****1111", "status": "unverified", "wireInstructions": { "trackingRef": "CIR3XBZZ4N", "beneficiary": { "name": "CIRCLE INTERNET FINANCIAL INC", "address1": "1 Main Street", "address2": "Suite 1" }, "beneficiaryBank": { "swiftCode": "CRYPTO99", "routingNumber": "999999999", "accountNumber": "3302726104", "currency": "USD", "name": "CIRCLE BANKING PARTNER", "address": "100 MAIN STREET", "city": "NEW YORK", "postalCode": "10001", "country": "US" } } }}
The repayment account is unverified until Circle matches the first incoming
wire repayment to it, after which it transitions to active. Cache the
wireInstructions block—you reuse it when repaying in Step 6.
In the sandbox, simulate a matching wire and verify the account by posting a
mock repayment.
Call POST /v1/credit/transfers/reserveFunds to hold capacity against your
credit line while you initiate the supporting wire. To use Credit Express,
include the optional destination field to disburse directly to a verified
address from your Circle Mint recipient address book; omit it to land the
disbursement in your Mint wallet.
Save the transfer id from the response—it identifies this draw for the
remaining steps. Reservations expire 30 minutes after creation and only one can
be open per credit line at a time; for the full set of constraints, see
Settlement Advance lifecycle.
If you can’t send the wire before the reservation expires, cancel it with
PUT /v1/credit/transfers/{id}/cancelReserve
to free the capacity immediately.
Settlement Advance cannot use POST /v1/credit/transfers to create a draw.
That endpoint is for Line of Credit only and returns HTTP 400 for Settlement
Advance credit lines. Use reserveFunds followed by requestReservedFunds.
Using the wire instructions from Step 2, instruct your bank to send a wire to
Circle for the reserved amount. Then upload proof of the wire to request
disbursement by calling PUT /v1/credit/transfers/{id}/requestReservedFunds
with a multipart/form-data request. Accepted file types are application/pdf,
image/jpeg, and image/png.
The transfer moves from funds_reserved to requested. Circle’s Treasury team
manually reviews the wire proof. In the sandbox the request auto-approves
quickly; in production, approval typically takes 20 minutes to 2 hours.
The outstanding amount is the principal plus accrued fees. Each day the credit
line is open with an outstanding balance, recurringFee is applied to the
principal and added to fees.total. The dueDate is 7 days after
disbursedDate for Settlement Advance.If you reserved with a Credit Express destination, the blockchainDestination
block tracks the onchain leg separately from the credit transfer. The
blockchainDestination.transferId references the underlying Circle Mint
transfer once disbursement initiates onchain.
For asynchronous updates, subscribe to creditTransfers, creditFees, and
creditRepayments in the Circle Mint Console. Webhook payloads mirror the
corresponding GET endpoints. See
webhook topics for what each
topic publishes.
Send a wire from the bank account from Step 2 to Circle for the outstanding
amount (principal plus accrued fees). Use the wireInstructions you cached from
Step 2.In the sandbox, simulate the wire by posting a mock repayment:
List repayments filtered to your transfer by calling
GET /v1/credit/repayments?transferId={id} and confirm a record exists with
type: fiat and status: completed.
paymentAmount is the total wire received and amountApplied is the portion
applied to this transfer’s outstanding balance (principal plus fees).Then call GET /v1/credit/transfers/{id} again and confirm the transfer is
paid.
The transfer now shows status: paid, outstanding is zero, and fees.unpaid
is zero—the draw lifecycle is complete.
Settlement Advance does not support crypto repayment. POST /v1/credit/cryptoRepayment returns HTTP 400 for Settlement Advance credit
lines. Repay by wire only.
