forked from PaystackOSS/paystack-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtransfer_.py
More file actions
226 lines (171 loc) · 6.49 KB
/
transfer_.py
File metadata and controls
226 lines (171 loc) · 6.49 KB
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
# coding: utf-8
"""
Paystack
The OpenAPI specification of the Paystack API that merchants and developers can harness to build financial solutions in Africa. # noqa: E501
The version of the OpenAPI document: 1.0.0
Contact: techsupport@paystack.com
"""
from __future__ import absolute_import
import re # noqa: F401
import six
from paystack.api_client import ApiClient
from paystack.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
class Transfer(object):
"""NOTE: This class is auto generated. Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
@classmethod
def bulk(cls, **kwargs): # noqa: E501
"""Initiate Bulk Transfer # noqa: E501
:param source: Where should we transfer from? Only balance is allowed for now
:type source: str
:param transfers: A list of transfer object. Each object should contain amount, recipient, and reference
:type transfers: list[TransferInitiate]
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def disable_otp(cls, **kwargs): # noqa: E501
"""Disable OTP requirement for Transfers # noqa: E501
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def disable_otp_finalize(cls, otp, **kwargs): # noqa: E501
"""Finalize Disabling of OTP requirement for Transfers # noqa: E501
:param otp: OTP sent to business phone to verify disabling OTP requirement (required)
:type otp: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def download(cls, **kwargs): # noqa: E501
"""Export Transfers # noqa: E501
:param per_page: Number of records to fetch per page
:type per_page: int
:param page: The section to retrieve
:type page: int
:param status:
:type status: str
:param _from: The start date
:type _from: datetime
:param to: The end date
:type to: datetime
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def enable_otp(cls, **kwargs): # noqa: E501
"""Enable OTP requirement for Transfers # noqa: E501
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def fetch(cls, code, **kwargs): # noqa: E501
"""Fetch Transfer # noqa: E501
:param code: Transfer code (required)
:type code: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def finalize(cls, transfer_code, otp, **kwargs): # noqa: E501
"""Finalize Transfer # noqa: E501
:param transfer_code: The transfer code you want to finalize (required)
:type transfer_code: str
:param otp: OTP sent to business phone to verify transfer (required)
:type otp: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def initiate(cls, source, amount, recipient, **kwargs): # noqa: E501
"""Initiate Transfer # noqa: E501
:param source: Where should we transfer from? Only balance is allowed for now (required)
:type source: str
:param amount: Amount to transfer in kobo if currency is NGN and pesewas if currency is GHS. (required)
:type amount: str
:param recipient: The transfer recipient's code (required)
:type recipient: str
:param reason: The reason or narration for the transfer.
:type reason: str
:param currency: Specify the currency of the transfer. Defaults to NGN.
:type currency: str
:param reference: If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters are allowed.
:type reference: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def list(cls, **kwargs): # noqa: E501
"""List Transfers # noqa: E501
:param per_page: Number of records to fetch per page
:type per_page: int
:param page: The section to retrieve
:type page: int
:param status:
:type status: str
:param _from: The start date
:type _from: datetime
:param to: The end date
:type to: datetime
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def resend_otp(cls, transfer_code, reason, **kwargs): # noqa: E501
"""Resend OTP for Transfer # noqa: E501
:param transfer_code: The transfer code that requires an OTP validation (required)
:type transfer_code: str
:param reason: Either resend_otp or transfer (required)
:type reason: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def verify(cls, reference, **kwargs): # noqa: E501
"""Verify Transfer # noqa: E501
:param reference: (required)
:type reference: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass