Wallets
API Overview
Configurations
Developer-Controlled Wallets
Modular Wallets
User-Controlled Wallets
Compliance Engine
List payments
gethttps://api.circle.com/v1/cpn/payments
- Reference
- Playground
Returns a list of all payments that fit the specified parameters.
Query parameters
status
string
Filter by the payment status. If specified, it will only return the payments with the specified status. Otherwise, it will return payments including all the possible statues
customerRefId
string
Filter by the customer reference ID from OFI. If specified, it will return the payments associated with this customer. Otherwise, it will return payments including all customers.
refCode
string
Filter by the payment ref code. If specified it will return the payments associated with this refcode. Otherwise, it will return payments across all ref codes.
from
date-time
Queries items created since the specified date-time (inclusive) in ISO 8601 format.
to
date-time
Queries items created before the specified date-time (inclusive) in ISO 8601 format.
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.
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.
pageSize
integer
1 to 200
Default is 50
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
RequestChoose a language
ResponseChoose an example
1{
2 "data": [
3 {
4 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5 "quoteId": "custom_ref_id",
6 "paymentMethodType": "SPEI",
7 "blockchain": "ETH-SEPOLIA",
8 "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
9 "refCode": "custom_ref_id",
10 "customerRefId": "custom_ref_id",
11 "beneficiaryRefId": "custom_ref_id",
12 "fiatNetworkPaymentRef": "custom_ref_id",
13 "expireDate": "2023-01-01T12:04:05Z",
14 "createDate": "2023-01-01T12:04:05Z",
15 "status": "COMPLETED",
16 "failureReason": "CANCELLED",
17 "useCase": "B2B",
18 "reasonForPayment": "PMT001",
19 "activeRfi": {
20 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
21 "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
22 "status": "APPROVED",
23 "level": "LEVEL_1",
24 "expireDate": "2023-01-01T12:04:05Z",
25 "certificate": {
26 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
27 "certPem": "LS0tLS1CRUdJT...",
28 "domain": "api.circle.com",
29 "jwk": {
30 "crv": "P-256",
31 "kid": "263521881931753643998528753619816524468853605762",
32 "kty": "EC",
33 "x": "KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE",
34 "y": "D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
35 }
36 },
37 "fieldRequirements": {
38 "version": 1,
39 "schema": {
40 "type": "object",
41 "$defs": {
42 "address": {
43 "type": "object",
44 "required": [
45 "street",
46 "city",
47 "country"
48 ],
49 "properties": {
50 "city": {
51 "type": "string",
52 "description": "City name"
53 },
54 "street": {
55 "type": "string",
56 "description": "Street address"
57 },
58 "country": {
59 "type": "string",
60 "pattern": "^[A-Z]{2}$",
61 "description": "Country code (e.g., US, GB)"
62 },
63 "postalCode": {
64 "type": "string",
65 "description": "Postal or ZIP code"
66 },
67 "stateProvince": {
68 "type": "string",
69 "description": "State or province"
70 }
71 },
72 "description": "Full address"
73 },
74 "individual": {
75 "type": "object",
76 "required": [
77 "name",
78 "address",
79 "dateOfBirth"
80 ],
81 "properties": {
82 "name": {
83 "type": "string",
84 "description": "Individual's full name"
85 },
86 "address": {
87 "ref": "#/$defs/address"
88 },
89 "dateOfBirth": {
90 "type": "string",
91 "format": "date",
92 "description": "Individual's date of birth (YYYY-MM-DD)"
93 }
94 },
95 "description": "Individual's RFI data"
96 },
97 "beneficiaryOwner": {
98 "type": "object",
99 "required": [
100 "name",
101 "address",
102 "dateOfBirth",
103 "percentage"
104 ],
105 "properties": {
106 "name": {
107 "type": "string",
108 "description": "Individual's full name"
109 },
110 "address": {
111 "ref": "#/$defs/address"
112 },
113 "percentage": {
114 "type": "number",
115 "description": "Company ownership percentage"
116 },
117 "dateOfBirth": {
118 "type": "string",
119 "format": "date",
120 "description": "Individual's date of birth (YYYY-MM-DD)"
121 }
122 },
123 "description": "Beneficiary owner's RFI data"
124 },
125 "intermediaryBeneficiaryOwner": {
126 "type": "object",
127 "required": [
128 "name",
129 "address",
130 "dateOfFormation",
131 "countryOfFormation",
132 "percentage"
133 ],
134 "properties": {
135 "name": {
136 "type": "string",
137 "description": "Business legal name"
138 },
139 "address": {
140 "ref": "#/$defs/address"
141 },
142 "percentage": {
143 "type": "number",
144 "description": "Company ownership percentage"
145 },
146 "dateOfFormation": {
147 "type": "string",
148 "format": "date",
149 "description": "Company formation date (YYYY-MM-DD)"
150 },
151 "countryOfFormation": {
152 "type": "string",
153 "pattern": "^[A-Z]{2}$",
154 "description": "Entity formation country"
155 }
156 },
157 "description": "Intermediary beneficiary owner's RFI data"
158 }
159 },
160 "title": "RFI Requirements",
161 "$schema": "https://json-schema.org/draft/2020-12/schema",
162 "required": [
163 "SOURCE_OF_FUNDS",
164 "METHOD_OF_VERIFICATION",
165 "NAME",
166 "TRADE_NAME",
167 "NATIONAL_IDENTIFICATION_NUMBER",
168 "DATE_OF_FORMATION",
169 "COUNTRY_OF_FORMATION",
170 "ENTITY_TYPE",
171 "INDUSTRY_TYPE",
172 "ADDRESS",
173 "AUTHORIZED_SIGNATORIES",
174 "BENEFICIARY_OWNERSHIP"
175 ],
176 "properties": {
177 "NAME": {
178 "type": "string",
179 "description": "Business legal registered name"
180 },
181 "EMAIL": {
182 "type": "string",
183 "description": "Business contact email address"
184 },
185 "PHONE": {
186 "type": "string",
187 "description": "Business contact phone number"
188 },
189 "ADDRESS": {
190 "ref": "#/$defs/address"
191 },
192 "WEBSITE": {
193 "type": "string",
194 "description": "Business website URL"
195 },
196 "TRADE_NAME": {
197 "type": "string",
198 "description": "Business trade name or DBA (Doing Business As)"
199 },
200 "ENTITY_TYPE": {
201 "type": "string",
202 "description": "Business structure type (Corporation, LLC, Partnership, etc.)"
203 },
204 "INDUSTRY_TYPE": {
205 "type": "string",
206 "description": "Business activity classification"
207 },
208 "SOURCE_OF_FUNDS": {
209 "type": "string",
210 "description": "Transaction source of funds"
211 },
212 "DATE_OF_FORMATION": {
213 "type": "string",
214 "format": "date",
215 "description": "Company formation date (YYYY-MM-DD)"
216 },
217 "BENEFICIARY_OWNERS": {
218 "ref": "#/$defs/beneficiaryOwner"
219 },
220 "COUNTRY_OF_FORMATION": {
221 "type": "string",
222 "pattern": "^[A-Z]{2}$",
223 "description": "Entity formation country"
224 },
225 "BENEFICIARY_OWNERSHIP": {
226 "type": "boolean",
227 "description": "Whether any individuals or intermediaries own 25% or more of the company"
228 },
229 "AUTHORIZED_SIGNATORIES": {
230 "ref": "#/$defs/individual"
231 },
232 "METHOD_OF_VERIFICATION": {
233 "type": "string",
234 "description": "Verification method used"
235 },
236 "NATIONAL_IDENTIFICATION_NUMBER": {
237 "type": "string",
238 "description": "Business identification number (e.g., Tax ID)"
239 },
240 "INTERMEDIARY_BENEFICIARY_OWNERS": {
241 "ref": "#/$defs/intermediaryBeneficiaryOwner"
242 }
243 },
244 "description": "RFI Data Requirements"
245 }
246 },
247 "fileRequirements": [
248 "FORMATION_DOCUMENT"
249 ]
250 },
251 "rfis": [
252 {
253 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
254 "status": "APPROVED"
255 }
256 ],
257 "onChainTransactions": [
258 {
259 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
260 "status": "PENDING"
261 }
262 ],
263 "sourceAmount": {
264 "amount": "110.27",
265 "currency": "USDC"
266 },
267 "destinationAmount": {
268 "amount": "11000.27",
269 "currency": "MXN"
270 },
271 "fees": {
272 "breakdown": [
273 {
274 "amount": {
275 "amount": "110.27",
276 "currency": "USDC"
277 },
278 "type": "BFI_TRANSACTION_FEE"
279 }
280 ],
281 "totalAmount": {
282 "amount": "110.27",
283 "currency": "USDC"
284 }
285 },
286 "fiatSettlementTime": {
287 "max": "3",
288 "min": "1",
289 "unit": "DAYS"
290 },
291 "refunds": [
292 {
293 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
294 "status": "CREATED",
295 "amount": {
296 "amount": "110.27",
297 "currency": "USDC"
298 },
299 "transactionHash": ""
300 }
301 ]
302 }
303 ]
304}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
