Tesser API

Treasury (v1)

Endpointhttps://sandbox.tesserx.co

Download schema

Get deposits

GET

https://sandbox.tesserx.co

/v1/treasury/deposits

Retrieve a paginated list of all deposits for the workspace.

Get deposits › query Parameters

ids

string[] · style: form

Filter by deposit IDs (comma-separated UUIDs)

to_account_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

Filter by destination account ID (desired.to.account_id).

page

integer · min: 1

Page number for pagination (1-based)

limit

integer · min: 1 · max: 100

Number of items per page (default: 20)

Get deposits › Responses

Deposits retrieved successfully

object[] · required

object · required

GET/v1/treasury/deposits

curl --request GET \
  --url https://sandbox.tesserx.co/v1/treasury/deposits

shell

Example Responses

{
  "data": [
    {
      "id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "organization_reference_id": null,
      "direction": "inbound",
      "desired": {
        "from": {
          "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
          "amount": "1000",
          "currency": "USD",
          "network": null
        },
        "to": {
          "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
          "amount": null,
          "currency": "USDC",
          "network": null
        }
      },
      "estimated": {
        "from": {
          "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
          "amount": "1000",
          "currency": "USD",
          "network": null
        },
        "to": {
          "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
          "amount": "1000",
          "currency": "USDC",
          "network": null
        }
      },
      "actual": {
        "from": {
          "account_id": null,
          "amount": null,
          "currency": null,
          "network": null
        },
        "to": {
          "account_id": null,
          "amount": null,
          "currency": null,
          "network": null
        }
      },
      "steps": [
        {
          "id": "8a4f2c1e-9b6d-4e35-b7a0-3c5d1e9f2b8a",
          "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
          "step_sequence": 0,
          "step_type": "transfer",
          "estimated": {
            "from": {
              "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
              "amount": "1000",
              "currency": "USD",
              "network": null
            },
            "to": {
              "account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
              "amount": "1000",
              "currency": "USD",
              "network": null
            }
          },
          "actual": {
            "from": {
              "account_id": null,
              "amount": null,
              "currency": null,
              "network": null
            },
            "to": {
              "account_id": null,
              "amount": null,
              "currency": null,
              "network": null
            }
          },
          "transaction_hash": null,
          "fees": [],
          "provider_key": "circle_mint",
          "status": "created",
          "status_reasons": null,
          "created_at": "2024-03-01T10:00:00.000Z",
          "updated_at": "2024-03-01T10:00:00.000Z",
          "submitted_at": null,
          "confirmed_at": null,
          "completed_at": null,
          "failed_at": null
        },
        {
          "id": "3b7e9d2f-1c4a-4f68-a5b0-6e8c1d3f9a2b",
          "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
          "step_sequence": 1,
          "step_type": "swap",
          "estimated": {
            "from": {
              "account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
              "amount": "1000",
              "currency": "USD",
              "network": null
            },
            "to": {
              "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
              "amount": "1000",
              "currency": "USDC",
              "network": null
            }
          },
          "actual": {
            "from": {
              "account_id": null,
              "amount": null,
              "currency": null,
              "network": null
            },
            "to": {
              "account_id": null,
              "amount": null,
              "currency": null,
              "network": null
            }
          },
          "transaction_hash": null,
          "fees": [],
          "provider_key": "circle_mint",
          "status": "created",
          "status_reasons": null,
          "created_at": "2024-03-01T10:00:00.000Z",
          "updated_at": "2024-03-01T10:00:00.000Z",
          "submitted_at": null,
          "confirmed_at": null,
          "completed_at": null,
          "failed_at": null
        }
      ],
      "created_at": "2024-03-01T10:00:00.000Z",
      "updated_at": "2024-03-01T10:00:00.000Z",
      "expires_at": "2024-03-01T14:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

json

application/json

Create deposit

POST

https://sandbox.tesserx.co

/v1/treasury/deposits

Create a deposit payment and get deposit instructions.

Create deposit › Request Body

object · required

Caller's stated intent for the deposit.

organization_reference_id

string

Optional client-supplied identifier.

Create deposit › Responses

Deposit created successfully

object · required

POST/v1/treasury/deposits

curl --request POST \
  --url https://sandbox.tesserx.co/v1/treasury/deposits \
  --header 'Content-Type: application/json' \
  --data '
{
  "desired": {
    "from": {
      "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
      "amount": "1000",
      "currency": "USD"
    },
    "to": {
      "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
      "currency": "USDC"
    }
  }
}
'

shell

Example Request Body

{
  "desired": {
    "from": {
      "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
      "amount": "1000",
      "currency": "USD"
    },
    "to": {
      "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
      "currency": "USDC"
    }
  }
}

json

application/json

Example Responses

{
  "data": {
    "id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": null,
    "direction": "inbound",
    "desired": {
      "from": {
        "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "amount": "1000",
        "currency": "USD",
        "network": null
      },
      "to": {
        "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
        "amount": null,
        "currency": "USDC",
        "network": null
      }
    },
    "estimated": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "actual": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "steps": [],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-01T14:00:00.000Z"
  }
}

json

application/json

Get deposit by ID

GET

https://sandbox.tesserx.co

/v1/treasury/deposits/{id}

Retrieve a deposit payment by its unique identifier.

Get deposit by ID › path Parameters

id

string · required

Deposit ID

Get deposit by ID › Responses

Deposit retrieved successfully

object · required

GET/v1/treasury/deposits/{id}

curl --request GET \
  --url https://sandbox.tesserx.co/v1/treasury/deposits/:id

shell

Example Responses

{
  "data": {
    "id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": null,
    "direction": "inbound",
    "desired": {
      "from": {
        "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "amount": "1000",
        "currency": "USD",
        "network": null
      },
      "to": {
        "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
        "amount": null,
        "currency": "USDC",
        "network": null
      }
    },
    "estimated": {
      "from": {
        "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "amount": "1000",
        "currency": "USD",
        "network": null
      },
      "to": {
        "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
        "amount": "1000",
        "currency": "USDC",
        "network": null
      }
    },
    "actual": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "steps": [
      {
        "id": "8a4f2c1e-9b6d-4e35-b7a0-3c5d1e9f2b8a",
        "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
        "step_sequence": 0,
        "step_type": "transfer",
        "estimated": {
          "from": {
            "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
            "amount": "1000",
            "currency": "USD",
            "network": null
          },
          "to": {
            "account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
            "amount": "1000",
            "currency": "USD",
            "network": null
          }
        },
        "actual": {
          "from": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          },
          "to": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          }
        },
        "transaction_hash": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "created",
        "status_reasons": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:00.000Z",
        "submitted_at": null,
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      },
      {
        "id": "3b7e9d2f-1c4a-4f68-a5b0-6e8c1d3f9a2b",
        "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
        "step_sequence": 1,
        "step_type": "swap",
        "estimated": {
          "from": {
            "account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
            "amount": "1000",
            "currency": "USD",
            "network": null
          },
          "to": {
            "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
            "amount": "1000",
            "currency": "USDC",
            "network": null
          }
        },
        "actual": {
          "from": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          },
          "to": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          }
        },
        "transaction_hash": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "created",
        "status_reasons": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:00.000Z",
        "submitted_at": null,
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      }
    ],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-01T14:00:00.000Z"
  }
}

json

application/json

Get deposit instructions by id

GET

https://sandbox.tesserx.co

/v1/treasury/deposits/{id}/instructions

Get deposit instructions for an existing deposit.

Get deposit instructions by id › path Parameters

id

string · required

Deposit ID

Get deposit instructions by id › Responses

Deposit instructions retrieved successfully

object · required

GET/v1/treasury/deposits/{id}/instructions

curl --request GET \
  --url https://sandbox.tesserx.co/v1/treasury/deposits/:id/instructions

shell

Example Responses

{
  "data": {
    "from_account": {
      "id": "55042f8f-e527-56f1-b57c-eef23ca862db",
      "name": "Acme Corp Operating Account",
      "bank_name": "Chase Bank",
      "bank_account_number": "845748459212",
      "bank_code_type": "ROUTING",
      "bank_identifier_code": "021000021",
      "bank_swift_code": "CHASUS33XXX"
    },
    "to_account": {
      "id": "7a4c2d8e-1b5f-4e69-a7d1-3f8e5c2b9a0d",
      "name": "Circle USD Wire Deposit Account",
      "bank_name": "STANDARD CHARTERED BANK",
      "bank_account_number": "11001259978",
      "bank_code_type": "ROUTING",
      "bank_identifier_code": "322286803",
      "bank_swift_code": "SCBLSG22XXX",
      "tracking_reference": "CIR24K2SK3",
      "belongs_to": {
        "business_legal_name": "CIRCLE INTERNET FINANCIAL INC",
        "business_street_address1": "99 HIGH STREET",
        "business_street_address2": "LEVEL 17 SUITE 1701",
        "business_city": "BOSTON",
        "business_state": "MA",
        "business_postal_code": "02110",
        "business_country": "US"
      }
    },
    "amount": "1000",
    "currency": "USD"
  }
}

json

application/json

Simulate deposit in sandbox

POST

https://sandbox.tesserx.co

/v1/treasury/deposits/{id}/simulate

Simulate a wire deposit by triggering Circle's mock wire API. Only available in sandbox environments.

Simulate deposit in sandbox › path Parameters

id

string · required

Deposit ID

Simulate deposit in sandbox › Responses

Deposit simulation triggered successfully

object · required

POST/v1/treasury/deposits/{id}/simulate

curl --request POST \
  --url https://sandbox.tesserx.co/v1/treasury/deposits/:id/simulate

shell

Example Responses

{
  "data": {
    "id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": null,
    "direction": "inbound",
    "desired": {
      "from": {
        "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "amount": "1000",
        "currency": "USD",
        "network": null
      },
      "to": {
        "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
        "amount": null,
        "currency": "USDC",
        "network": null
      }
    },
    "estimated": {
      "from": {
        "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "amount": "1000",
        "currency": "USD",
        "network": null
      },
      "to": {
        "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
        "amount": "1000",
        "currency": "USDC",
        "network": null
      }
    },
    "actual": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "steps": [
      {
        "id": "8a4f2c1e-9b6d-4e35-b7a0-3c5d1e9f2b8a",
        "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
        "step_sequence": 0,
        "step_type": "transfer",
        "estimated": {
          "from": {
            "account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
            "amount": "1000",
            "currency": "USD",
            "network": null
          },
          "to": {
            "account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
            "amount": "1000",
            "currency": "USD",
            "network": null
          }
        },
        "actual": {
          "from": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          },
          "to": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          }
        },
        "transaction_hash": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "created",
        "status_reasons": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:00.000Z",
        "submitted_at": null,
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      },
      {
        "id": "3b7e9d2f-1c4a-4f68-a5b0-6e8c1d3f9a2b",
        "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
        "step_sequence": 1,
        "step_type": "swap",
        "estimated": {
          "from": {
            "account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
            "amount": "1000",
            "currency": "USD",
            "network": null
          },
          "to": {
            "account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
            "amount": "1000",
            "currency": "USDC",
            "network": null
          }
        },
        "actual": {
          "from": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          },
          "to": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          }
        },
        "transaction_hash": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "created",
        "status_reasons": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:00.000Z",
        "submitted_at": null,
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      }
    ],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-01T14:00:00.000Z"
  }
}

json

application/json

Get rebalances

GET

https://sandbox.tesserx.co

/v1/treasury/rebalances

Retrieve a paginated list of all rebalances for the workspace.

Get rebalances › query Parameters

page

integer · min: 1

Page number for pagination (1-based)

limit

integer · min: 1 · max: 100

Number of items per page (default: 20)

Get rebalances › Responses

Rebalances retrieved successfully

object[] · required

object · required

GET/v1/treasury/rebalances

curl --request GET \
  --url https://sandbox.tesserx.co/v1/treasury/rebalances

shell

Example Responses

{
  "data": [
    {
      "id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "organization_reference_id": "ref_123",
      "direction": "rebalance",
      "desired": {
        "from": {
          "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
          "amount": "1000",
          "currency": "USDC",
          "network": "BASE"
        },
        "to": {
          "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
          "amount": null,
          "currency": "USDC",
          "network": "BASE"
        }
      },
      "estimated": {
        "from": {
          "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
          "amount": "1000",
          "currency": "USDC",
          "network": "BASE"
        },
        "to": {
          "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
          "amount": "1000",
          "currency": "USDC",
          "network": "BASE"
        }
      },
      "actual": {
        "from": {
          "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
          "amount": "1000",
          "currency": "USDC",
          "network": "BASE"
        },
        "to": {
          "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
          "amount": "1000",
          "currency": "USDC",
          "network": "BASE"
        }
      },
      "balance_status": "reserved",
      "balance_reserved_at": "2024-03-01T10:00:00.000Z",
      "steps": [
        {
          "id": "7d3e1a9f-2c4b-4f85-b0a6-8e5c2d1f3b9a",
          "transfer_id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
          "step_sequence": 0,
          "step_type": "transfer",
          "estimated": {
            "from": {
              "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
              "amount": "1000",
              "currency": "USDC",
              "network": "BASE"
            },
            "to": {
              "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
              "amount": "1000",
              "currency": "USDC",
              "network": "BASE"
            }
          },
          "actual": {
            "from": {
              "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
              "amount": "1000",
              "currency": "USDC",
              "network": "BASE"
            },
            "to": {
              "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
              "amount": "1000",
              "currency": "USDC",
              "network": "BASE"
            }
          },
          "transaction_hash": null,
          "unsigned_transaction": null,
          "fees": [],
          "provider_key": "circle_mint",
          "status": "completed",
          "status_reasons": [],
          "provider_data": null,
          "created_at": "2024-03-01T10:00:00.000Z",
          "updated_at": "2024-03-01T10:02:30.000Z",
          "submitted_at": "2024-03-01T10:00:10.000Z",
          "confirmed_at": "2024-03-01T10:02:00.000Z",
          "completed_at": "2024-03-01T10:02:30.000Z",
          "failed_at": null
        }
      ],
      "created_at": "2024-03-01T10:00:00.000Z",
      "updated_at": "2024-03-01T10:02:30.000Z",
      "expires_at": "2024-03-04T10:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

json

application/json

Create rebalance

POST

https://sandbox.tesserx.co

/v1/treasury/rebalances

Create an internal rebalance between managed accounts.

Validation rules:

desired.from.network / desired.to.network are required for wallet accounts and disallowed for ledger accounts.

Create rebalance › Request Body

object · required

Caller's stated intent for the rebalance.

organization_reference_id

string

Optional client-supplied identifier.

Create rebalance › Responses

Rebalance created successfully

object · required

POST/v1/treasury/rebalances

curl --request POST \
  --url https://sandbox.tesserx.co/v1/treasury/rebalances \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_reference_id": "ref_123",
  "desired": {
    "from": {
      "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
      "amount": "1000",
      "currency": "USDC",
      "network": "BASE"
    },
    "to": {
      "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
      "currency": "USDC",
      "network": "BASE"
    }
  }
}
'

shell

Example Request Body

{
  "organization_reference_id": "ref_123",
  "desired": {
    "from": {
      "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
      "amount": "1000",
      "currency": "USDC",
      "network": "BASE"
    },
    "to": {
      "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
      "currency": "USDC",
      "network": "BASE"
    }
  }
}

json

application/json

Example Responses

{
  "data": {
    "id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": "ref_123",
    "direction": "rebalance",
    "desired": {
      "from": {
        "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      },
      "to": {
        "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
        "amount": null,
        "currency": "USDC",
        "network": "BASE"
      }
    },
    "estimated": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "actual": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "balance_status": "unreserved",
    "balance_reserved_at": null,
    "steps": [],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-04T10:00:00.000Z"
  }
}

json

application/json

Get rebalance by ID

GET

https://sandbox.tesserx.co

/v1/treasury/rebalances/{id}

Retrieve a rebalance by its unique identifier.

Get rebalance by ID › path Parameters

id

string · required

Rebalance ID

Get rebalance by ID › Responses

Rebalance retrieved successfully

object · required

GET/v1/treasury/rebalances/{id}

curl --request GET \
  --url https://sandbox.tesserx.co/v1/treasury/rebalances/:id

shell

Example Responses

{
  "data": {
    "id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": "ref_123",
    "direction": "rebalance",
    "desired": {
      "from": {
        "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      },
      "to": {
        "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
        "amount": null,
        "currency": "USDC",
        "network": "BASE"
      }
    },
    "estimated": {
      "from": {
        "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      },
      "to": {
        "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      }
    },
    "actual": {
      "from": {
        "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      },
      "to": {
        "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      }
    },
    "balance_status": "reserved",
    "balance_reserved_at": "2024-03-01T10:00:00.000Z",
    "steps": [
      {
        "id": "7d3e1a9f-2c4b-4f85-b0a6-8e5c2d1f3b9a",
        "transfer_id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
        "step_sequence": 0,
        "step_type": "transfer",
        "estimated": {
          "from": {
            "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
            "amount": "1000",
            "currency": "USDC",
            "network": "BASE"
          },
          "to": {
            "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
            "amount": "1000",
            "currency": "USDC",
            "network": "BASE"
          }
        },
        "actual": {
          "from": {
            "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
            "amount": "1000",
            "currency": "USDC",
            "network": "BASE"
          },
          "to": {
            "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
            "amount": "1000",
            "currency": "USDC",
            "network": "BASE"
          }
        },
        "transaction_hash": null,
        "unsigned_transaction": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "completed",
        "status_reasons": [],
        "provider_data": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:02:30.000Z",
        "submitted_at": "2024-03-01T10:00:10.000Z",
        "confirmed_at": "2024-03-01T10:02:00.000Z",
        "completed_at": "2024-03-01T10:02:30.000Z",
        "failed_at": null
      }
    ],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:02:30.000Z",
    "expires_at": "2024-03-04T10:00:00.000Z"
  }
}

json

application/json

Submit signed on-chain rebalance step

POST

https://sandbox.tesserx.co

/v1/treasury/rebalances/{id}/steps/{stepId}/sign

Submit a signed on-chain transaction for a wallet-to-wallet rebalance step prepared by the Turnkey provider. The backend validates the signed transaction against the step's destination + amount, then broadcasts it on-chain.

Only steps where provider_key is turnkey and status is created or signature_requested (with an unsigned transaction already prepared) can be signed.

Submit signed on-chain rebalance step › path Parameters

id

string · required

Rebalance ID

stepId

string · required

Rebalance step ID

Submit signed on-chain rebalance step › Request Body

signature

string · minLength: 1 · required

The signed transaction or message.

Submit signed on-chain rebalance step › Responses

Signed transaction accepted and submitted on-chain

object · required

POST/v1/treasury/rebalances/{id}/steps/{stepId}/sign

curl --request POST \
  --url https://sandbox.tesserx.co/v1/treasury/rebalances/:id/steps/:stepId/sign \
  --header 'Content-Type: application/json' \
  --data '
{
  "signature": "0xdeadbeef..."
}
'

shell

Example Request Body

{
  "signature": "0xdeadbeef..."
}

json

Example Responses

{
  "data": {
    "id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": "ref_123",
    "direction": "rebalance",
    "desired": {
      "from": {
        "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      },
      "to": {
        "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
        "amount": null,
        "currency": "USDC",
        "network": "BASE"
      }
    },
    "estimated": {
      "from": {
        "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      },
      "to": {
        "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
        "amount": "1000",
        "currency": "USDC",
        "network": "BASE"
      }
    },
    "actual": {
      "from": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      },
      "to": {
        "account_id": null,
        "amount": null,
        "currency": null,
        "network": null
      }
    },
    "balance_status": "reserved",
    "balance_reserved_at": "2024-03-01T10:00:00.000Z",
    "steps": [
      {
        "id": "7d3e1a9f-2c4b-4f85-b0a6-8e5c2d1f3b9a",
        "transfer_id": "e4a1b7c3-9f2d-4e56-a8b0-3c5d1e7f9a2b",
        "step_sequence": 0,
        "step_type": "transfer",
        "estimated": {
          "from": {
            "account_id": "6de8a7e9-be79-4885-9b65-b25b11d38078",
            "amount": "1000",
            "currency": "USDC",
            "network": "BASE"
          },
          "to": {
            "account_id": "53b7aabd-97bc-4a4f-9f9c-1c1c69474889",
            "amount": "1000",
            "currency": "USDC",
            "network": "BASE"
          }
        },
        "actual": {
          "from": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          },
          "to": {
            "account_id": null,
            "amount": null,
            "currency": null,
            "network": null
          }
        },
        "transaction_hash": "0xabc123",
        "unsigned_transaction": null,
        "fees": [],
        "provider_key": "turnkey",
        "status": "submitted",
        "status_reasons": [],
        "provider_data": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:10.000Z",
        "submitted_at": "2024-03-01T10:00:10.000Z",
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      }
    ],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:10.000Z",
    "expires_at": "2024-03-04T10:00:00.000Z"
  }
}

json

application/json

Create withdrawal

POST

https://sandbox.tesserx.co

/v1/treasury/withdrawals

Create a withdrawal payment.

Create withdrawal › Request Body

from_currency

string · required

Source currency code.

to_currency

string · required

Destination currency code.

from_amount

string · required

Amount to send.

from_account_id

string · required

Source account ID.

to_account_id

string · required

Destination account ID.

from_network

string

Network for the withdrawal.

to_network

string

Network for the destination.

Create withdrawal › Responses

Withdrawal created successfully

object · required

POST/v1/treasury/withdrawals

curl --request POST \
  --url https://sandbox.tesserx.co/v1/treasury/withdrawals \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
  "from_amount": "1000",
  "from_currency": "USDC",
  "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
  "to_currency": "USD"
}
'

shell

Example Request Body

{
  "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
  "from_amount": "1000",
  "from_currency": "USDC",
  "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
  "to_currency": "USD"
}

json

application/json

Example Responses

{
  "data": {
    "id": "6a2f8c1e-3b9d-4e74-b5a0-7c4d2e1f9b3a",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": null,
    "direction": "outbound",
    "funding_account_id": null,
    "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
    "from_amount": "1000",
    "from_network": null,
    "from_currency": "USDC",
    "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
    "to_amount": null,
    "to_network": null,
    "to_currency": "USD",
    "risk_status": null,
    "risk_status_reasons": [],
    "risk_reviewed_by": null,
    "risk_reviewed_at": null,
    "balance_status": null,
    "balance_reserved_at": null,
    "steps": [],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-01T14:00:00.000Z"
  }
}

json

application/json

Get withdrawal by ID

GET

https://sandbox.tesserx.co

/v1/treasury/withdrawals/{id}

Retrieve a withdrawal payment by its unique identifier.

Get withdrawal by ID › path Parameters

id

string · required

Withdrawal ID

Get withdrawal by ID › Responses

200

Withdrawal retrieved successfully

object · required

GET/v1/treasury/withdrawals/{id}

curl --request GET \
  --url https://sandbox.tesserx.co/v1/treasury/withdrawals/:id

shell

Example Responses

{
  "data": {
    "id": "6a2f8c1e-3b9d-4e74-b5a0-7c4d2e1f9b3a",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "organization_reference_id": null,
    "direction": "outbound",
    "funding_account_id": null,
    "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
    "from_amount": "1000",
    "from_network": null,
    "from_currency": "USDC",
    "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
    "to_amount": "1000",
    "to_network": null,
    "to_currency": "USD",
    "risk_status": null,
    "risk_status_reasons": [],
    "risk_reviewed_by": null,
    "risk_reviewed_at": null,
    "balance_status": null,
    "balance_reserved_at": null,
    "steps": [
      {
        "id": "8a4f2c1e-9b6d-4e35-b7a0-3c5d1e9f2b8a",
        "transfer_id": "6a2f8c1e-3b9d-4e74-b5a0-7c4d2e1f9b3a",
        "step_sequence": 1,
        "step_type": "transfer",
        "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "from_amount": "1000",
        "from_network": null,
        "from_currency": "USDC",
        "to_account_id": "00000000-0000-0000-0001-744269e65952",
        "to_amount": "1000",
        "to_network": null,
        "to_currency": "USDC",
        "transaction_hash": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "created",
        "status_reasons": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:00.000Z",
        "submitted_at": null,
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      },
      {
        "id": "3b7e9d2f-1c4a-4f68-a5b0-6e8c1d3f9a2b",
        "transfer_id": "6a2f8c1e-3b9d-4e74-b5a0-7c4d2e1f9b3a",
        "step_sequence": 2,
        "step_type": "transfer",
        "from_account_id": "b72de3f5-8a1c-4b39-c06e-4f9d1a2e7b3c",
        "from_amount": "1000",
        "from_network": null,
        "from_currency": "USD",
        "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
        "to_amount": "1000",
        "to_network": null,
        "to_currency": "USD",
        "transaction_hash": null,
        "fees": [],
        "provider_key": "circle_mint",
        "status": "created",
        "status_reasons": null,
        "created_at": "2024-03-01T10:00:00.000Z",
        "updated_at": "2024-03-01T10:00:00.000Z",
        "submitted_at": null,
        "confirmed_at": null,
        "completed_at": null,
        "failed_at": null
      }
    ],
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z",
    "expires_at": "2024-03-01T14:00:00.000Z"
  }
}

json

application/json

Payments