We refreshed our doc site!

Bookmarked links may have changed

Read release notes

getSession

Web3 Services

Retrieve a session

GEThttps://api.circle.com/v1/w3s/ramp/sessions/{id}

Retrieves details of a specific session given its unique identifier.

Path parameters
id
uuid
Required

The universally unique identifier of the resource.

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