-
Notifications
You must be signed in to change notification settings - Fork 0
/
payments.go
460 lines (433 loc) · 12.6 KB
/
payments.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
package payments
import (
"fmt"
"net/http"
circlesdk "github.com/bryk-io/circle-sdk"
)
// API The Circle Payments API allows you to take payments from your end users
// via traditional methods such as debit & credit cards, bank accounts, etc.,
// and receive settlement in USDC. Businesses with users already holding USDC
// are also able to take on-chain payments on supported blockchains.
//
// With the Circle Payments API you can:
// - Take card and bank transfer payments for goods or services.
// - Build a credit & debit card or bank transfer on-ramp for your crypto exchange.
// - Take card or bank transfer deposits for your savings, lending, investing or P2P
// payments product.
// - Take USDC payments directly through on-chain transfers.
type API struct {
cl *circlesdk.Client
}
// CreateCard creates a card for future usage, i.e. creating payments.
// https://developers.circle.com/reference/payments-cards-create
func (mod *API) CreateCard(c circlesdk.CreateCardRequest, opts ...circlesdk.CallOption) (*circlesdk.Card, error) {
res := new(circlesdk.Card)
req := &circlesdk.RequestOptions{
Method: http.MethodPost,
Endpoint: "v1/cards",
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if req.IdempotencyKey != "" {
c.IdempotencyKey = req.IdempotencyKey
}
req.Input = &c
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// GetCard returns details of the specified card.
// https://developers.circle.com/reference/payments-cards-get-id
func (mod *API) GetCard(id string, opts ...circlesdk.CallOption) (*circlesdk.Card, error) {
res := new(circlesdk.Card)
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/cards/" + id,
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// ListCards returns a list of cards based on the passed options.
// https://developers.circle.com/reference/payments-cards-get
func (mod *API) ListCards(opts ...circlesdk.CallOption) ([]*circlesdk.Card, error) {
var list []*circlesdk.Card
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/cards",
UnwrapData: true,
Output: &list,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return list, nil
}
// UpdateCard updates the details of the specified card.
// https://developers.circle.com/reference/payments-cards-update-id
func (mod *API) UpdateCard(
id string,
c circlesdk.UpdateCardRequest,
opts ...circlesdk.CallOption) (*circlesdk.Card, error) {
res := new(circlesdk.Card)
req := &circlesdk.RequestOptions{
Method: http.MethodPut,
Endpoint: "v1/cards/" + id,
UnwrapData: true,
Output: res,
Input: map[string]interface{}{
"keyId": c.KeyID,
"encryptedData": c.EncryptedData,
"expMonth": c.ExpMonth,
"expYear": c.ExpYear,
},
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// CreateBankAccount creates a bank account for future usage, i.e. creating payments.
// https://developers.circle.com/reference/payments-bank-accounts-ach-create
func (mod *API) CreateBankAccount(
b circlesdk.CreateBankAccountRequest,
opts ...circlesdk.CallOption) (*circlesdk.BankAccount, error) {
res := new(circlesdk.BankAccount)
req := &circlesdk.RequestOptions{
Method: http.MethodPost,
Endpoint: "v1/banks/ach",
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if req.IdempotencyKey != "" {
b.IdempotencyKey = req.IdempotencyKey
}
req.Input = &b
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// GetBankAccount returns the details of the specified bank account.
// https://developers.circle.com/reference/payments-bank-accounts-ach-get-id
func (mod *API) GetBankAccount(id string, opts ...circlesdk.CallOption) (*circlesdk.BankAccount, error) {
res := new(circlesdk.BankAccount)
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/banks/ach/" + id,
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// CreatePayment creates a new payment.
// https://developers.circle.com/reference/payments-payments-create
func (mod *API) CreatePayment(
c circlesdk.CreatePaymentRequest,
opts ...circlesdk.CallOption) (*circlesdk.Payment, error) {
res := new(circlesdk.Payment)
req := &circlesdk.RequestOptions{
Method: http.MethodPost,
Endpoint: "v1/payments",
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if req.IdempotencyKey != "" {
c.IdempotencyKey = req.IdempotencyKey
}
req.Input = &c
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// GetPayment returns the details of the specified payment.
// https://developers.circle.com/reference/payments-payments-get-id
func (mod *API) GetPayment(id string, opts ...circlesdk.CallOption) (*circlesdk.Payment, error) {
res := new(circlesdk.Payment)
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/payments/" + id,
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// ListPayments returns a list of payments based on the passed request and options.
// https://developers.circle.com/reference/payments-payments-get
func (mod *API) ListPayments(
l circlesdk.ListPaymentsRequest,
opts ...circlesdk.CallOption) ([]*circlesdk.Payment, error) {
var list []*circlesdk.Payment
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/payments",
UnwrapData: true,
Output: &list,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if l.Source != "" {
req.AddQueryParam("source", l.Source)
}
if l.SettlementID != "" {
req.AddQueryParam("settlementId", l.SettlementID)
}
if l.Status != "" {
req.AddQueryParam("status", string(l.Status))
}
for _, t := range l.Type {
req.AddQueryParam("type", t)
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return list, nil
}
// CapturePayment the given amount will be captured for the authorized payment if
// possible. If no amount is specified, the full amount will be captured. You can
// only capture once per authorization. A successful response does not mean the
// payment has been captured. It only means the capture request was successfully
// submitted.
// https://developers.circle.com/reference/capturepayment
func (mod *API) CapturePayment(
id string,
c circlesdk.CapturePaymentRequest,
opts ...circlesdk.CallOption) error {
req := &circlesdk.RequestOptions{
Method: http.MethodPost,
Endpoint: fmt.Sprintf("v1/payments/%s/capture", id),
}
for _, opt := range opts {
if err := opt(req); err != nil {
return err
}
}
if req.IdempotencyKey != "" {
c.IdempotencyKey = req.IdempotencyKey
}
req.Input = &c
if err := mod.cl.Dispatch(req); err != nil {
return err
}
return nil
}
// CancelPayment the payment will be voided if possible meaning the payment source
// will not be charged & the payment will never settle. Otherwise, the payment will
// be refunded meaning the payment source will be charged & the payment will be
// refunded from deductions of future settlements. Not all payments are eligible
// to be canceled. A successful response does not mean the payment has been canceled;
// it only means the cancellation request is successfully submitted.
// https://developers.circle.com/reference/payments-payments-cancel-id
func (mod *API) CancelPayment(
id string,
c circlesdk.CapturePaymentRequest,
opts ...circlesdk.CallOption) (*circlesdk.Payment, error) {
res := new(circlesdk.Payment)
req := &circlesdk.RequestOptions{
Method: http.MethodPost,
Endpoint: fmt.Sprintf("v1/payments/%s/cancel", id),
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if req.IdempotencyKey != "" {
c.IdempotencyKey = req.IdempotencyKey
}
req.Input = &c
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// RefundPayment the payment source will be refunded if possible. Not all payments
// are eligible to be canceled. A successful response does not mean the payment has
// been refunded; it only means the refund request is successfully submitted.
// https://developers.circle.com/reference/payments-payments-refund-id
func (mod *API) RefundPayment(
id string, r circlesdk.RefundPaymentRequest,
opts ...circlesdk.CallOption) (*circlesdk.Payment, error) {
res := new(circlesdk.Payment)
req := &circlesdk.RequestOptions{
Method: http.MethodPost,
Endpoint: fmt.Sprintf("v1/payments/%s/refund", id),
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if req.IdempotencyKey != "" {
r.IdempotencyKey = req.IdempotencyKey
}
req.Input = &r
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// GetSettlement returns the details of the specified settlement.
// https://developers.circle.com/reference/payments-settlements-get-id
func (mod *API) GetSettlement(id string, opts ...circlesdk.CallOption) (*circlesdk.Settlement, error) {
res := new(circlesdk.Settlement)
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/settlements/" + id,
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// ListSettlements returns a list of settlements based on the passed options.
// https://developers.circle.com/reference/payments-settlements-get
func (mod *API) ListSettlements(opts ...circlesdk.CallOption) ([]*circlesdk.Settlement, error) {
var list []*circlesdk.Settlement
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/settlements",
UnwrapData: true,
Output: &list,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return list, nil
}
// GetChargeback returns the details of the specified chargeback.
// https://developers.circle.com/reference/payments-chargebacks-get-id
func (mod *API) GetChargeback(id string, opts ...circlesdk.CallOption) (*circlesdk.ChargeBack, error) {
res := new(circlesdk.ChargeBack)
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/chargebacks/" + id,
UnwrapData: true,
Output: res,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return res, nil
}
// ListChargebacks returns a list of chargebacks based on the passed options.
// https://developers.circle.com/reference/payments-chargebacks-get
func (mod *API) ListChargebacks(paymentID string, opts ...circlesdk.CallOption) ([]*circlesdk.ChargeBack, error) {
var list []*circlesdk.ChargeBack
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/chargebacks",
UnwrapData: true,
Output: &list,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if paymentID != "" {
req.AddQueryParam("paymentID", paymentID)
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return list, nil
}
// ListReversals returns a list of reversals based on the passed options.
// https://developers.circle.com/reference/payments-reversals-get
func (mod *API) ListReversals(status string, opts ...circlesdk.CallOption) ([]*circlesdk.Reversal, error) {
var list []*circlesdk.Reversal
req := &circlesdk.RequestOptions{
Method: http.MethodGet,
Endpoint: "v1/reversals",
UnwrapData: true,
Output: &list,
}
for _, opt := range opts {
if err := opt(req); err != nil {
return nil, err
}
}
if status != "" {
req.AddQueryParam("status", status)
}
if err := mod.cl.Dispatch(req); err != nil {
return nil, err
}
return list, nil
}