We refreshed our doc site!
Bookmarked links may have changed
Read release notesPOSThttps://api.circle.com/v1/payments
Indicates the verification method for this payment.
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
Universally unique identifier (UUID v4) of the public key used in encryption. NOTE the sandbox environment uses the default value of key1
. For this reason the example supplied is key1
rather than a UUID.
Triggers the automatic capture of the full payment amount. If set to false the payment will only be authorized but not captured.
The URL to redirect users to after successful 3DS authentication.
The URL to redirect users to after failed 3DS authentication.
Description of the payment with length restriction of 240 characters.
PGP encrypted base64 encoded string. Contains CVV.
verification
is cvv
.The channel identifier that can be set for the payment. When not provided, the default channel is used.
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 "source": {
12 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
13 "type": "card"
14 },
15 "description": "Payment",
16 "status": "pending",
17 "captured": false,
18 "captureAmount": {
19 "amount": "3.14",
20 "currency": "USD"
21 },
22 "captureDate": "2020-04-10T02:13:30.000Z",
23 "requiredAction": {
24 "type": "three_d_secure_required",
25 "redirectUrl": "https://example.org"
26 },
27 "verification": {
28 "avs": "D",
29 "cvv": "not_requested",
30 "threeDSecure": "pass",
31 "eci": "00"
32 },
33 "cancel": {
34 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
35 "type": "cancel",
36 "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
37 "merchantWalletId": "212000",
38 "amount": {
39 "amount": "3.14",
40 "currency": "USD"
41 },
42 "source": {
43 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
44 "type": "card"
45 },
46 "description": "Payment",
47 "status": "pending",
48 "originalPayment": {
49 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
50 "type": "payment",
51 "amount": {
52 "amount": "3.14",
53 "currency": "USD"
54 },
55 "description": "Payment",
56 "status": "pending",
57 "requiredAction": {
58 "type": "three_d_secure_required",
59 "redirectUrl": "https://example.org"
60 },
61 "fees": {
62 "amount": "3.14",
63 "currency": "USD"
64 },
65 "createDate": "2020-04-10T02:13:30.000Z"
66 },
67 "fees": {
68 "amount": "3.14",
69 "currency": "USD"
70 },
71 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
72 "createDate": "2020-04-10T02:13:30.000Z",
73 "updateDate": "2020-04-10T02:13:30.000Z"
74 },
75 "refunds": [
76 {
77 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
78 "type": "refund",
79 "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
80 "merchantWalletId": "212000",
81 "amount": {
82 "amount": "3.14",
83 "currency": "USD"
84 },
85 "source": {
86 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
87 "type": "card"
88 },
89 "description": "Payment",
90 "status": "pending",
91 "originalPayment": {
92 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
93 "type": "payment",
94 "amount": {
95 "amount": "3.14",
96 "currency": "USD"
97 },
98 "description": "Payment",
99 "status": "pending",
100 "requiredAction": {
101 "type": "three_d_secure_required",
102 "redirectUrl": "https://example.org"
103 },
104 "fees": {
105 "amount": "3.14",
106 "currency": "USD"
107 },
108 "createDate": "2020-04-10T02:13:30.000Z"
109 },
110 "cancel": {
111 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
112 "type": "cancel",
113 "description": "Payment",
114 "status": "pending",
115 "createDate": "2020-04-10T02:13:30.000Z"
116 },
117 "fees": {
118 "amount": "3.14",
119 "currency": "USD"
120 },
121 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
122 "createDate": "2020-04-10T02:13:30.000Z",
123 "updateDate": "2020-04-10T02:13:30.000Z"
124 }
125 ],
126 "fees": {
127 "amount": "3.14",
128 "currency": "USD"
129 },
130 "trackingRef": "24910599141085313498894",
131 "errorCode": "payment_failed",
132 "metadata": {
133 "email": "[email protected]",
134 "phoneNumber": "+14155555555"
135 },
136 "riskEvaluation": {
137 "decision": "approved",
138 "reason": "3000"
139 },
140 "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
141 "createDate": "2020-04-10T02:13:30.000Z",
142 "updateDate": "2020-04-10T02:13:30.000Z"
143 }
144}