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