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