-
Notifications
You must be signed in to change notification settings - Fork 0
/
transfer_client.go
275 lines (264 loc) · 10 KB
/
transfer_client.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
package paystack
import (
"fmt"
"net/http"
)
// TransferClient interacts with endpoints related to paystack transfer resource that lets you
// automate sending money to your Customers.
type TransferClient struct {
*baseAPIClient
}
// NewTransferClient creates a TransferClient
//
// Example
//
// import p "github.com/gray-adeyi/paystack"
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
func NewTransferClient(options ...ClientOptions) *TransferClient {
client := NewAPIClient(options...)
return client.Transfers
}
// Initiate lets you send money to your Customers.
// Status of a transfer object returned will be pending if OTP is disabled.
// In the event that an OTP is required, status will read otp.
//
// Example:
//
// import (
// "fmt"
// p "github.com/gray-adeyi/paystack"
// "encoding/json"
// )
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
// // Alternatively, you can access the transfer client from an APIClient
// // paystackClient := p.NewAPIClient(p.WithSecretKey("<paystack-secret-key>"))
// // paystackClient.Transfers field is a `TransferClient`
// // Therefore, this is possible
// // resp, err := paystackClient.Transfers.Initiate("balance",500000,"RCP_gx2wn530m0i3w3m")
//
// // you can pass in optional parameters to the `Transfers.Initiate` with `p.WithOptionalParameter`
// // for example say you want to specify the `reason`.
// // resp, err := tfClient.Initiate("balance",500000,"RCP_gx2wn530m0i3w3m", p.WithOptionalParameter("reason","Discount Refund"))
// // the `p.WithOptionalParameter` takes in a key and value parameter, the key should match the optional parameter
// // from paystack documentation see https://paystack.com/docs/api/transfer/#initiate
// // Multiple optional parameters can be passed into `Create` each with it's `p.WithOptionalParameter`
//
// resp, err := tfClient.Initiate("balance",500000,"RCP_gx2wn530m0i3w3m")
//
// if err != nil {
// panic(err)
// }
// // you can have data be a custom structure based on the data your interested in retrieving from
// // from paystack for simplicity, we're using `map[string]interface{}` which is sufficient to
// // to serialize the json data returned by paystack
// data := make(map[string]interface{})
//
// err := json.Unmarshal(resp.Data, &data); if err != nil {
// panic(err)
// }
// fmt.Println(data)
func (t *TransferClient) Initiate(source string, amount int, recipient string,
optionalPayloadParameters ...OptionalPayloadParameter) (*Response, error) {
payload := make(map[string]interface{})
payload["source"] = source
payload["amount"] = amount
payload["recipient"] = recipient
for _, optionalPayloadParameter := range optionalPayloadParameters {
payload = optionalPayloadParameter(payload)
}
return t.APICall(http.MethodPost, "/transfer", payload)
}
// Finalize lets you finalize an initiated transfer
//
// Example:
//
// import (
// "fmt"
// p "github.com/gray-adeyi/paystack"
// "encoding/json"
// )
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
// // Alternatively, you can access the transfer client from an APIClient
// // paystackClient := p.NewAPIClient(p.WithSecretKey("<paystack-secret-key>"))
// // paystackClient.Transfers field is a `TransferClient`
// // Therefore, this is possible
// // resp, err := paystackClient.Transfers.Finalize("TRF_vsyqdmlzble3uii","928783")
//
// resp, err := tfClient.Finalize("TRF_vsyqdmlzble3uii","928783")
//
// if err != nil {
// panic(err)
// }
// // you can have data be a custom structure based on the data your interested in retrieving from
// // from paystack for simplicity, we're using `map[string]interface{}` which is sufficient to
// // to serialize the json data returned by paystack
// data := make(map[string]interface{})
//
// err := json.Unmarshal(resp.Data, &data); if err != nil {
// panic(err)
// }
// fmt.Println(data)
func (t *TransferClient) Finalize(transferCode string, otp string) (*Response, error) {
payload := make(map[string]interface{})
payload["transfer_code"] = transferCode
payload["otp"] = otp
return t.APICall(http.MethodPost, "/transfer/finalize_transfer", payload)
}
// BulkInitiate lets you initiate multiple Transfers in a single request.
// You need to disable the Transfers OTP requirement to use this endpoint.
//
// Example:
//
// import (
// "fmt"
// p "github.com/gray-adeyi/paystack"
// "encoding/json"
// )
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
// // Alternatively, you can access the transfer client from an APIClient
// // paystackClient := p.NewAPIClient(p.WithSecretKey("<paystack-secret-key>"))
// // paystackClient.Transfers field is a `TransferClient`
// // Therefore, this is possible
// // Transfers := []map[string]interface{
// // {"amount": 20000,"reference": "588YtfftReF355894J","reason": "Why not?","recipient":"RCP_2tn9clt23s7qr28"},
// // {"amount": 30000,"reference": "YunoTReF35e0r4J","reason": "Because I can","recipient":"RCP_1a25w1h3n0xctjg"},
// // {"amount": 40000,"reason": "Coming right up","recipient": "RCP_aps2aibr69caua7"},
// }
// // resp, err := paystackClient.Transfers.BulkInitiate("balance", Transfers)
//
// Transfers := []map[string]interface{
// {"amount": 20000,"reference": "588YtfftReF355894J","reason": "Why not?","recipient":"RCP_2tn9clt23s7qr28"},
// {"amount": 30000,"reference": "YunoTReF35e0r4J","reason": "Because I can","recipient":"RCP_1a25w1h3n0xctjg"},
// {"amount": 40000,"reason": "Coming right up","recipient": "RCP_aps2aibr69caua7"},
// }
//
// resp, err := tfClient.BulkInitiate("balance", Transfers)
//
// if err != nil {
// panic(err)
// }
// // you can have data be a custom structure based on the data your interested in retrieving from
// // from paystack for simplicity, we're using `map[string]interface{}` which is sufficient to
// // to serialize the json data returned by paystack
// data := make(map[string]interface{})
//
// err := json.Unmarshal(resp.Data, &data); if err != nil {
// panic(err)
// }
// fmt.Println(data)
func (t *TransferClient) BulkInitiate(source string, transfers interface{}) (*Response, error) {
payload := make(map[string]interface{})
payload["source"] = source
payload["Transfers"] = transfers
return t.APICall(http.MethodPost, "/transfer/bulk", payload)
}
// All lets you retrieve all the Transfers made on your Integration.
//
// Example:
//
// import (
// "fmt"
// p "github.com/gray-adeyi/paystack"
// "encoding/json"
// )
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
// // Alternatively, you can access a transfer client from an APIClient
// // paystackClient := p.NewAPIClient(p.WithSecretKey("<paystack-secret-key>"))
// // paystackClient.Transfers field is a `TransferClient`
// // Therefore, this is possible
// // resp, err := paystackClient.Transfers.All()
//
// // All also accepts queries, so say you want to customize how many Transfers to retrieve
// // and which page to retrieve, you can write it like so.
// // resp, err := tfClient.All(p.WithQuery("perPage","50"), p.WithQuery("page","2"))
//
// // see https://paystack.com/docs/api/transfer/#list for supported query parameters
//
// resp, err := tfClient.All()
// if err != nil {
// panic(err)
// }
// // you can have data be a custom structure based on the data your interested in retrieving from
// // from paystack for simplicity, we're using `map[string]interface{}` which is sufficient to
// // to serialize the json data returned by paystack
// data := make(map[string]interface{})
//
// err := json.Unmarshal(resp.Data, &data); if err != nil {
// panic(err)
// }
// fmt.Println(data)
func (t *TransferClient) All(queries ...Query) (*Response, error) {
url := AddQueryParamsToUrl("/transfer", queries...)
return t.APICall(http.MethodGet, url, nil)
}
// FetchOne lets you retrieve the details of a transfer on your Integration.
//
// Example:
//
// import (
// "fmt"
// p "github.com/gray-adeyi/paystack"
// "encoding/json"
// )
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
// // Alternatively, you can access a transfer client from an APIClient
// // paystackClient := p.NewAPIClient(p.WithSecretKey("<paystack-secret-key>"))
// // paystackClient.Transfers field is a `TransferClient`
// // Therefore, this is possible
// // resp, err := paystackClient.Transfers.FetchOne("<idOrCode>")
//
// resp, err := tfClient.FetchOne("<idOrCode>")
// if err != nil {
// panic(err)
// }
// // you can have data be a custom structure based on the data your interested in retrieving from
// // from paystack for simplicity, we're using `map[string]interface{}` which is sufficient to
// // to serialize the json data returned by paystack
// data := make(map[string]interface{})
//
// err := json.Unmarshal(resp.Data, &data); if err != nil {
// panic(err)
// }
// fmt.Println(data)
func (t *TransferClient) FetchOne(idOrCode string) (*Response, error) {
return t.APICall(http.MethodGet, fmt.Sprintf("/transfer/%s", idOrCode), nil)
}
// Verify lets you verify the status of a transfer on your Integration.
//
// Example:
//
// import (
// "fmt"
// p "github.com/gray-adeyi/paystack"
// "encoding/json"
// )
//
// tfClient := p.NewTransferClient(p.WithSecretKey("<paystack-secret-key>"))
// // Alternatively, you can access a transfer client from an APIClient
// // paystackClient := p.NewAPIClient(p.WithSecretKey("<paystack-secret-key>"))
// // paystackClient.Transfers field is a `TransferClient`
// // Therefore, this is possible
// // resp, err := paystackClient.Transfers.Verify("<reference>")
//
// resp, err := tfClient.Verify("<reference>")
// if err != nil {
// panic(err)
// }
// // you can have data be a custom structure based on the data your interested in retrieving from
// // from paystack for simplicity, we're using `map[string]interface{}` which is sufficient to
// // to serialize the json data returned by paystack
// data := make(map[string]interface{})
//
// err := json.Unmarshal(resp.Data, &data); if err != nil {
// panic(err)
// }
// fmt.Println(data)
func (t *TransferClient) Verify(reference string) (*Response, error) {
return t.APICall(http.MethodGet, fmt.Sprintf("/transfer/verify/%s", reference), nil)
}