Tesser API

Treasury (v1)

Endpointhttps://sandbox.tesserx.co

Download schema

Create deposit

POST

https://sandbox.tesserx.co

/v1/treasury/deposits

Create a deposit payment and get deposit instructions.

Create deposit › Request Body

from_currency

string · required

Source currency code.

to_currency

string · required

Destination currency code.

from_amount

string · required

Amount to send.

to_account_id

string · required

Destination account ID.

from_account_id

string

Source account ID. Required for Circle deposits.

from_network

string

Network for the source.

to_network

string

Network for the deposit.

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 '
{
  "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
  "from_amount": "1000",
  "from_currency": "USD",
  "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
  "to_currency": "USDC"
}
'

shell

Example Request Body

{
  "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
  "from_amount": "1000",
  "from_currency": "USD",
  "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
  "to_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",
    "funding_account_id": null,
    "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
    "from_amount": "1000",
    "from_network": null,
    "from_currency": "USD",
    "to_account_id": "44031e7e-d416-45f0-a46b-ded12b9751ca",
    "to_amount": null,
    "to_network": null,
    "to_currency": "USDC",
    "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 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

200

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",
    "funding_account_id": null,
    "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
    "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": "USDC",
    "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": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
        "step_sequence": 1,
        "step_type": "transfer",
        "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db",
        "from_amount": "1000",
        "from_network": null,
        "from_currency": "USD",
        "to_account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17",
        "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,
        "finalized_at": null,
        "completed_at": null,
        "failed_at": null
      },
      {
        "id": "3b7e9d2f-1c4a-4f68-a5b0-6e8c1d3f9a2b",
        "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e",
        "step_sequence": 2,
        "step_type": "transfer",
        "from_account_id": "00000000-0000-0000-0001-744269e65952",
        "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": "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,
        "finalized_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

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,
        "finalized_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,
        "finalized_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

Create deposit

POST

https://sandbox.tesserx.co

/v1/treasury/deposits

Create a deposit payment and get deposit instructions.

Create deposit › Request Body

from_currency

string · required

Source currency code.

to_currency

string · required

Destination currency code.

from_amount

string · required

Amount to send.

to_account_id

string · required

Destination account ID.

from_account_id

string

Source account ID. Required for Circle deposits.

from_network

string

Network for the source.

to_network

string

Network for the deposit.

Create deposit › Responses

Deposit created successfully

object · required

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

{ "data": { "id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "organization_reference_id": null, "direction": "inbound", "funding_account_id": null, "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db", "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": "USDC", "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": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e", "step_sequence": 1, "step_type": "transfer", "from_account_id": "55042f8f-e527-56f1-b57c-eef23ca862db", "from_amount": "1000", "from_network": null, "from_currency": "USD", "to_account_id": "a81bc1f4-7e3d-4926-b04f-3d2e8a9c5f17", "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, "finalized_at": null, "completed_at": null, "failed_at": null }, { "id": "3b7e9d2f-1c4a-4f68-a5b0-6e8c1d3f9a2b", "transfer_id": "1c8e4a6f-9b2d-4f53-a0e7-5d3c1b9f2a8e", "step_sequence": 2, "step_type": "transfer", "from_account_id": "00000000-0000-0000-0001-744269e65952", "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": "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, "finalized_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" } }

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

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" } '

{ "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, "finalized_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, "finalized_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" } }