We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Get a payment
GEThttps://api.circle.com/v1/payments/{id}
Path parameters
id
uuid
Required
Universally unique identifier (UUID v4) of a resource.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4 "type": "payment",
5 "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
6 "merchantWalletId": "212000",
7 "amount": {
8 "amount": "3.14",
9 "currency": "USD"
10 },
11 "fromAmount": {
12 "amount": "3.14",
13 "currency": "USD"
14 },
15 "source": {
16 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
17 "type": "card"
18 },
19 "description": "Payment",
20 "status": "pending",
21 "requiredAction": {
22 "type": "three_d_secure_required",
23 "redirectUrl": "https://example.org"
24 },
25 "verification": {
26 "avs": "D",
27 "cvv": "not_requested",
28 "threeDSecure": "pass",
29 "eci": "00"
30 },
31 "originalPayment": {
32 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
33 "type": "payment",
34 "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
35 "merchantWalletId": "212000",
36 "amount": {
37 "amount": "3.14",
38 "currency": "USD"
39 },
40 "fromAmount": {
41 "amount": "3.14",
42 "currency": "USD"
43 },
44 "source": {
45 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
46 "type": "card"
47 },
48 "description": "Payment",
49 "status": "pending",
50 "captured": false,
51 "captureAmount": {
52 "amount": "3.14",
53 "currency": "USD"
54 },
55 "captureDate": "2020-04-10T02:13:30.000Z",
56 "requiredAction": {
57 "type": "three_d_secure_required",
58 "redirectUrl": "https://example.org"
59 },
60 "cancel": {
61 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
62 "type": "cancel",
63 "description": "Payment",
64 "status": "pending",
65 "createDate": "2020-04-10T02:13:30.000Z"
66 },
67 "refunds": [
68 {
69 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
70 "type": "payment",
71 "amount": {
72 "amount": "3.14",
73 "currency": "USD"
74 },
75 "description": "Payment",
76 "status": "pending",
77 "requiredAction": {
78 "type": "three_d_secure_required",
79 "redirectUrl": "https://example.org"
80 },
81 "fees": {
82 "amount": "3.14",
83 "currency": "USD"
84 },
85 "createDate": "2020-04-10T02:13:30.000Z"
86 }
87 ],
88 "fees": {
89 "amount": "3.14",
90 "currency": "USD"
91 },
92 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
93 "createDate": "2020-04-10T02:13:30.000Z",
94 "updateDate": "2020-04-10T02:13:30.000Z"
95 },
96 "cancel": {
97 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
98 "type": "cancel",
99 "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
100 "merchantWalletId": "212000",
101 "amount": {
102 "amount": "3.14",
103 "currency": "USD"
104 },
105 "source": {
106 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
107 "type": "card"
108 },
109 "description": "Payment",
110 "status": "pending",
111 "originalPayment": {
112 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
113 "type": "payment",
114 "amount": {
115 "amount": "3.14",
116 "currency": "USD"
117 },
118 "description": "Payment",
119 "status": "pending",
120 "requiredAction": {
121 "type": "three_d_secure_required",
122 "redirectUrl": "https://example.org"
123 },
124 "fees": {
125 "amount": "3.14",
126 "currency": "USD"
127 },
128 "createDate": "2020-04-10T02:13:30.000Z"
129 },
130 "fees": {
131 "amount": "3.14",
132 "currency": "USD"
133 },
134 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
135 "createDate": "2020-04-10T02:13:30.000Z",
136 "updateDate": "2020-04-10T02:13:30.000Z"
137 },
138 "refunds": [
139 {
140 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
141 "type": "refund",
142 "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
143 "merchantWalletId": "212000",
144 "amount": {
145 "amount": "3.14",
146 "currency": "USD"
147 },
148 "source": {
149 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
150 "type": "card"
151 },
152 "description": "Payment",
153 "status": "pending",
154 "originalPayment": {
155 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
156 "type": "payment",
157 "amount": {
158 "amount": "3.14",
159 "currency": "USD"
160 },
161 "description": "Payment",
162 "status": "pending",
163 "requiredAction": {
164 "type": "three_d_secure_required",
165 "redirectUrl": "https://example.org"
166 },
167 "fees": {
168 "amount": "3.14",
169 "currency": "USD"
170 },
171 "createDate": "2020-04-10T02:13:30.000Z"
172 },
173 "cancel": {
174 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
175 "type": "cancel",
176 "description": "Payment",
177 "status": "pending",
178 "createDate": "2020-04-10T02:13:30.000Z"
179 },
180 "fees": {
181 "amount": "3.14",
182 "currency": "USD"
183 },
184 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
185 "createDate": "2020-04-10T02:13:30.000Z",
186 "updateDate": "2020-04-10T02:13:30.000Z"
187 }
188 ],
189 "fees": {
190 "amount": "3.14",
191 "currency": "USD"
192 },
193 "trackingRef": "24910599141085313498894",
194 "externalRef": "YYYYMMDDXXXXXXXX012345",
195 "errorCode": "payment_failed",
196 "metadata": {
197 "email": "[email protected]",
198 "phoneNumber": "+14155555555"
199 },
200 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
201 "riskEvaluation": {
202 "decision": "approved",
203 "reason": "3000"
204 },
205 "createDate": "2020-04-10T02:13:30.000Z",
206 "updateDate": "2020-04-10T02:13:30.000Z"
207 }
208}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
