Prerequisites
Before you begin this quickstart, ensure you have:- Obtained an API key for StableFX from Circle
- Set up a web3 provider or wallet that supports EIP-712 signatures and Permit2
- Granted a token allowance to the
Permit2contract. See How-to: Grant USDC Allowance to Permit2 for more information. - Installed cURL on your development machine
StableFX uses a single endpoint for all API requests. The base URL is
https://api.circle.com/. The StableFX API uses your API key for authentication
and to determine which environment to use. The TEST environment executes
against Arc testnet and returns mock data.When developing or testing your integration, you should use your TEST API key.
When you are ready to move to production, just update your code to use your
LIVE API key.Part 1: Request a tradable quote
Request a tradable quote for a USDC to EURC trade using the create a quote endpoint. Provide a value for theamount parameter in either the to or from fields, but not
both. Set type to tradable to receive an executable quote that includes
EIP-712 typed data for signing. Include a recipientAddress for the wallet that
receives the destination currency after the trade settles.
typedData object
containing the Permit2 EIP-712 typed data you need to sign before creating the
trade.
Part 2: Sign and create the trade
2.1. Sign the typed data
Using aPermit2-compliant EIP-712 compatible wallet or application, sign the
typedData object returned in the quote response. Use the domain, types,
primaryType, and message fields to construct the EIP-712 signature.
After signing, you have a hex-encoded signature string (for example,
0x1234...). You use this signature in the next step to create the trade.
2.2. Create the trade
Accept the quote and create a trade on StableFX using the create a trade endpoint. You need to provide the quote ID, your wallet address, themessage from the quote
response’s typedData.message field, the signature from the previous step,
and a randomly generated idempotency key in UUIDv4 format.
"status": "pending_settlement". This
confirms that the trade was created and is awaiting funding from both parties.
Part 3: Submit the funds onchain
Deliver the funds onchain to complete the trade. The StableFX API can handle the onchain transaction for you using thePermit2 contract.
3.1. Get the funding signature data
To use the StableFX API to deliver the funds onchain, you must first sign the funding typed data with an EIP-712 signature. To get the data to sign, call the generate funding presign data endpoint. Your request must include the contract ID of the trade (thecontractTradeId value from the Part 2 response) and the side of the trade that
you are taking. The following is an example request:
3.2. Sign the funding data
Using aPermit2-compliant EIP-712 compatible wallet or application, sign the
data from the typedData field returned in the previous step.
3.3. Submit the funding signature
To deliver the funds onchain, you must submit the taker-specificPermit2 data
along with your signature to the
fund trade endpoint. The endpoint
allows you to submit either a single object or a batch of objects along with the
required signatures.
The following is an example request for a single trade:
200 response.
It’s not required to submit the funding transaction through the StableFX API.
You can submit the transaction onchain using your own web3 provider or wallet.
3.4. Confirm the trade is funded
To confirm that the trade is funded, call the get a trade by ID endpoint. A trade is funded when the status istaker_funded.