listSessions

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Travel Rule

USDC Access

Quotes

Trade Configurations

Sessions

List all sessions related to a developer

GEThttps://api.circle.com/v1/w3s/ramp/sessions

List all sessions related to a developer. The list can be filtered by status, ramp type, customer reference id, ref id, tx hash, blockchain, and creation date

Query parameters

rampType

string

status

string

customerRefId

string

refId

string

txHash

string

blockchain

string

from

date-time

Queries items created since the specified date-time (inclusive) in ISO 8601 format.

date-time

Queries items created before the specified date-time (inclusive) in ISO 8601 format.

pageBefore

uuid

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

pageAfter

uuid

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

pageSize

integer

1 to 50

Default is 10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Response

200

Response Body

object

data

array of objects

Required

Show 13 properties

string

Required

System-generated unique identifier of the resource.

rampType

string

Required

Type of ramp session or quote. BUY (Onramp) or SELL (Offramp).

status

string

Required

Status of the session.

url

string

Required

URL for USDC Access widget. Redirects customers to this URL for Buy or Sell session.

refId

string

RefID is a custom label field.

customerRefId

string

Unique customer reference ID.

country

object

Represents a country, and optionally a subdivision (state/province).

Show 2 properties

walletAddress

object

Required

Blockchain address information.

Show 3 properties

quote

object

A real-time best quote for buying or selling USDC based on the given parameters.

Show 10 properties

string

Required

System-generated unique identifier of the resource.

blockchain

string

Required

Blockchain network the resource is on, or will be created on. Networks with a dash indicate a testnet; e.g. ETH-SEPOLIA.

paymentMethodType

string

Required

The fiat payment method type.

fiatAmount

object

Required

Amount and currency of the fiat money.

Show 2 properties

cryptoAmount

object

Required

Amount and currency of the crypto money.

Show 2 properties

partnerName

string

Required

Display Name of the partner for on-ramp or off-ramp transactions.

exchangeRate

object

Required

Exchange rate between the trading pair.

Show 2 properties

fees

object

Required

Total amount and breakdown of the fees.

Show 2 properties

totalAmount

object

Required

Amount and currency of the fiat money.

Show 2 properties

breakdown

array of objects

Required

Show 2 properties

amount

object

Required

Amount and currency of the fiat money.

Show 2 properties

type

string

Required

fee category | MARKUP - fee charged by developer, configured through Circle. NETWORK - network fee for the transaction. PROCESSING - a processing fee charged by liquidity provider. TAX - tax for the transaction, applicable based on country/region.

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

expireDate

string

Required

Date and time the resource expire, in ISO-8601 UTC format.

redirectUrl

string

URL to redirect customer back after session completes, appended with a sessionId as part of it.

transaction

object

Transaction details of the ramp session. Includes details of both onchain and fiat transactions.

Show 7 properties

fiatAmount

object

Amount and currency of the fiat money.

Show 2 properties

cryptoAmount

object

Amount and currency of the crypto money.

Show 2 properties

fromAddress

object

Blockchain address information.

Show 3 properties

toAddress

object

Blockchain address information.

Show 3 properties

txHash

string

Transaction hash on the blockchain.

fees

object

Total amount and breakdown of the fees.

Show 2 properties

totalAmount

object

Required

Amount and currency of the fiat money.

Show 2 properties

breakdown

array of objects

Required

Show 2 properties

amount

object

Required

Amount and currency of the fiat money.

Show 2 properties

type

string

Required

exchangeRate

object

Exchange rate between the trading pair.

Show 2 properties

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

RequestChoose a language

ResponseChoose an example

1{
2  "data": [
3    {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "rampType": "BUY",
6      "status": "PENDING",
7      "url": "",
8      "refId": "d620d523-b5ab-4541-94b0-efe4f4c825c8",
9      "customerRefId": "",
10      "country": {
11        "countryCode": "US",
12        "subdivisionCode": "CA"
13      },
14      "walletAddress": {
15        "blockchain": "ETH",
16        "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911",
17        "addressTag": "Transaction identifier"
18      },
19      "quote": {
20        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
21        "blockchain": "ETH",
22        "paymentMethodType": "WIRE",
23        "fiatAmount": {
24          "amount": "1000.00",
25          "currency": "USD"
26        },
27        "cryptoAmount": {
28          "amount": "1000.00",
29          "currency": "USDC"
30        },
31        "partnerName": "Legend Trading",
32        "exchangeRate": {
33          "rate": "1.010100",
34          "pair": "USDC/USD"
35        },
36        "fees": {
37          "totalAmount": {
38            "amount": "1000.00",
39            "currency": "USD"
40          },
41          "breakdown": [
42            {
43              "amount": {
44                "amount": "1000.00",
45                "currency": "USD"
46              },
47              "type": "MARKUP"
48            }
49          ]
50        },
51        "createDate": "2023-01-01T12:04:05Z",
52        "expireDate": "2023-01-01T12:04:05Z"
53      },
54      "redirectUrl": "",
55      "transaction": {
56        "fiatAmount": {
57          "amount": "1000.00",
58          "currency": "USD"
59        },
60        "cryptoAmount": {
61          "amount": "1000.00",
62          "currency": "USDC"
63        },
64        "fromAddress": {
65          "blockchain": "ETH",
66          "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911",
67          "addressTag": "Transaction identifier"
68        },
69        "toAddress": {
70          "blockchain": "ETH",
71          "address": "0x95Ba4cF87D6723ad9C0Db21737D862bE80e93911",
72          "addressTag": "Transaction identifier"
73        },
74        "txHash": "",
75        "fees": {
76          "totalAmount": {
77            "amount": "1000.00",
78            "currency": "USD"
79          },
80          "breakdown": [
81            {
82              "amount": {
83                "amount": "1000.00",
84                "currency": "USD"
85              },
86              "type": "MARKUP"
87            }
88          ]
89        },
90        "exchangeRate": {
91          "rate": "1.010100",
92          "pair": "USDC/USD"
93        }
94      },
95      "createDate": "2023-01-01T12:04:05Z",
96      "updateDate": "2023-01-01T12:04:05Z"
97    }
98  ]
99}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy