Generate funding presign data

curl --request POST \
  --url https://api-sandbox.circle.com/v1/exchange/stablefx/signatures/funding/presign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractTradeIds": [
    "10",
    "11",
    "12"
  ],
  "type": "maker",
  "fundingMode": "gross"
}
'

{
  "typedData": {
    "domain": {
      "name": "Permit2",
      "chainId": 11155111,
      "verifyingContract": "0xffd21ca8F0876DaFAD7de09404E0c1f868bbf1AE"
    },
    "types": {
      "EIP712Domain": [
        {
          "name": "name",
          "type": "string"
        },
        {
          "name": "chainId",
          "type": "uint256"
        },
        {
          "name": "verifyingContract",
          "type": "address"
        }
      ],
      "TokenPermissions": [
        {
          "name": "token",
          "type": "address"
        },
        {
          "name": "amount",
          "type": "uint256"
        }
      ],
      "SingleTradeWitness": [
        {
          "name": "id",
          "type": "uint256"
        }
      ],
      "PermitWitnessTransferFrom": [
        {
          "name": "permitted",
          "type": "TokenPermissions"
        },
        {
          "name": "spender",
          "type": "address"
        },
        {
          "name": "nonce",
          "type": "uint256"
        },
        {
          "name": "deadline",
          "type": "uint256"
        },
        {
          "name": "witness",
          "type": "SingleTradeWitness"
        }
      ]
    },
    "primaryType": "PermitWitnessTransferFrom",
    "message": {
      "permitted": {
        "token": "0xTOKEN",
        "amount": "1000"
      },
      "spender": "0xffd21ca8F0876DaFAD7de09404E0c1f868bbf1AE",
      "nonce": "42",
      "deadline": "1735689600",
      "witness": {
        "id": "10"
      }
    }
  }
}

POST

exchange

stablefx

signatures

funding

presign

Generate funding presign data

curl --request POST \
  --url https://api-sandbox.circle.com/v1/exchange/stablefx/signatures/funding/presign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractTradeIds": [
    "10",
    "11",
    "12"
  ],
  "type": "maker",
  "fundingMode": "gross"
}
'

{
  "typedData": {
    "domain": {
      "name": "Permit2",
      "chainId": 11155111,
      "verifyingContract": "0xffd21ca8F0876DaFAD7de09404E0c1f868bbf1AE"
    },
    "types": {
      "EIP712Domain": [
        {
          "name": "name",
          "type": "string"
        },
        {
          "name": "chainId",
          "type": "uint256"
        },
        {
          "name": "verifyingContract",
          "type": "address"
        }
      ],
      "TokenPermissions": [
        {
          "name": "token",
          "type": "address"
        },
        {
          "name": "amount",
          "type": "uint256"
        }
      ],
      "SingleTradeWitness": [
        {
          "name": "id",
          "type": "uint256"
        }
      ],
      "PermitWitnessTransferFrom": [
        {
          "name": "permitted",
          "type": "TokenPermissions"
        },
        {
          "name": "spender",
          "type": "address"
        },
        {
          "name": "nonce",
          "type": "uint256"
        },
        {
          "name": "deadline",
          "type": "uint256"
        },
        {
          "name": "witness",
          "type": "SingleTradeWitness"
        }
      ]
    },
    "primaryType": "PermitWitnessTransferFrom",
    "message": {
      "permitted": {
        "token": "0xTOKEN",
        "amount": "1000"
      },
      "spender": "0xffd21ca8F0876DaFAD7de09404E0c1f868bbf1AE",
      "nonce": "42",
      "deadline": "1735689600",
      "witness": {
        "id": "10"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Body

application/json

Request body for generating funding presign data

contractTradeIds

string[]

required

List of contract trade IDs

Minimum array length: 1

Example:

["10", "11", "12"]

type

enum<string>

required

The type of trader.

Available options:

maker,

taker

fundingMode

enum<string>

default:gross

The funding mode for the operation.

Available options:

gross,

net

Response

200 - application/json

Funding presign data generated successfully

Response containing Permit2 EIP-712 typed data for funding operations

typedData

object

required

EIP-712 typed data structure for single Permit2 transfer

Option 1
Option 2

Show child attributes

typedData.domain

object

required

Permit2 EIP-712 domain separator

Show child attributes

typedData.domain.name

string

required

The name of the signing domain

Example:

"Permit2"

typedData.domain.chainId

integer

required

The chain ID of the network

Example:

11155111

typedData.domain.verifyingContract

string

required

The address of the verifying contract

Example:

"0xffd21ca8F0876DaFAD7de09404E0c1f868bbf1AE"

typedData.types

object

required

EIP-712 type definitions for single Permit2 transfer

Show child attributes

typedData.types.EIP712Domain

object[]

required

Show child attributes

typedData.types.EIP712Domain.name

string

required

The name of the property

typedData.types.EIP712Domain.type

string

required

The type of the property

Example:

[
  { "name": "name", "type": "string" },
  { "name": "chainId", "type": "uint256" },
  {
    "name": "verifyingContract",
    "type": "address"
  }
]

typedData.types.TokenPermissions

object[]

required

Show child attributes

typedData.types.TokenPermissions.name

string

required

The name of the property

typedData.types.TokenPermissions.type

string

required

The type of the property

Example:

[
  { "name": "token", "type": "address" },
  { "name": "amount", "type": "uint256" }
]

typedData.types.SingleTradeWitness

object[]

required

Show child attributes

typedData.types.SingleTradeWitness.name

string

required

The name of the property

typedData.types.SingleTradeWitness.type

string

required

The type of the property

Example:

[{ "name": "id", "type": "uint256" }]

typedData.types.PermitWitnessTransferFrom

object[]

required

Show child attributes

typedData.types.PermitWitnessTransferFrom.name

string

required

The name of the property

typedData.types.PermitWitnessTransferFrom.type

string

required

The type of the property

Example:

[
  {
    "name": "permitted",
    "type": "TokenPermissions"
  },
  { "name": "spender", "type": "address" },
  { "name": "nonce", "type": "uint256" },
  { "name": "deadline", "type": "uint256" },
  {
    "name": "witness",
    "type": "SingleTradeWitness"
  }
]

typedData.primaryType

string

required

The primary type for the EIP-712 signature

Example:

"PermitWitnessTransferFrom"

typedData.message

object

required

The message data for Permit2 signature

Show child attributes

typedData.message.permitted

object

required

Token permissions for Permit2

Show child attributes

typedData.message.permitted.token

string

required

The token contract address

Example:

"0xTOKEN"

typedData.message.permitted.amount

string

required

The amount of tokens permitted, as a string representation of a uint256.

Example:

"1000"

typedData.message.spender

string

required

The spender contract address

Example:

"0xffd21ca8F0876DaFAD7de09404E0c1f868bbf1AE"

typedData.message.nonce

string

required

The nonce for the permit

Example:

"42"

typedData.message.deadline

string

required

The deadline timestamp for the permit

Example:

"1735689600"

typedData.message.witness

object

required

Single trade witness data

Show child attributes

typedData.message.witness.id

string

required

The trade ID

Example:

"10"

Generate trade presign data

Get fee for a trade

StableFX

Authorizations

Body

Response