forked from PaystackOSS/paystack-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpayment_request_.py
More file actions
224 lines (177 loc) · 7.62 KB
/
payment_request_.py
File metadata and controls
224 lines (177 loc) · 7.62 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
# 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 PaymentRequest(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 archive(cls, id, **kwargs): # noqa: E501
"""Archive Payment Request # noqa: E501
:param id: (required)
:type id: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def create(cls, customer, **kwargs): # noqa: E501
"""Create Payment Request # noqa: E501
:param customer: Customer id or code (required)
:type customer: str
:param amount: Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available.
:type amount: int
:param currency: Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN
:type currency: str
:param due_date: ISO 8601 representation of request due date
:type due_date: datetime
:param description: A short description of the payment request
:type description: str
:param line_items: Array of line items
:type line_items: list[object]
:param tax: Array of taxes
:type tax: list[object]
:param send_notification: Indicates whether Paystack sends an email notification to customer. Defaults to true
:type send_notification: list[object]
:param draft: Indicate if request should be saved as draft. Defaults to false and overrides send_notification
:type draft: list[object]
:param has_invoice: Set to true to create a draft invoice (adds an auto incrementing invoice number if none is provided) even if there are no line_items or tax passed
:type has_invoice: list[object]
:param invoice_number: Numeric value of invoice. Invoice will start from 1 and auto increment from there. This field is to help override whatever value Paystack decides. Auto increment for subsequent invoices continue from this point.
:type invoice_number: int
:param split_code: The split code of the transaction split.
:type split_code: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def fetch(cls, id, **kwargs): # noqa: E501
"""Fetch Payment Request # noqa: E501
:param id: (required)
:type id: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def finalize(cls, id, **kwargs): # noqa: E501
"""Finalize Payment Request # noqa: E501
:param id: (required)
:type id: 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 Payment Request # 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 customer: Customer ID
:type customer: str
:param status: Invoice status to filter
:type status: str
:param currency: If your integration supports more than one currency, choose the one to filter
:type currency: 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 notify(cls, id, **kwargs): # noqa: E501
"""Send Notification # noqa: E501
:param id: (required)
:type id: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def totals(cls, **kwargs): # noqa: E501
"""Payment Request Total # noqa: E501
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def update(cls, id, **kwargs): # noqa: E501
"""Update Payment Request # noqa: E501
:param id: (required)
:type id: str
:param customer: Customer id or code
:type customer: str
:param amount: Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available.
:type amount: int
:param currency: Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN
:type currency: str
:param due_date: ISO 8601 representation of request due date
:type due_date: datetime
:param description: A short description of the payment request
:type description: str
:param line_items: Array of line items
:type line_items: list[object]
:param tax: Array of taxes
:type tax: list[object]
:param send_notification: Indicates whether Paystack sends an email notification to customer. Defaults to true
:type send_notification: list[object]
:param draft: Indicate if request should be saved as draft. Defaults to false and overrides send_notification
:type draft: list[object]
:param has_invoice: Set to true to create a draft invoice (adds an auto incrementing invoice number if none is provided) even if there are no line_items or tax passed
:type has_invoice: list[object]
:param invoice_number: Numeric value of invoice. Invoice will start from 1 and auto increment from there. This field is to help override whatever value Paystack decides. Auto increment for subsequent invoices continue from this point.
:type invoice_number: int
:param split_code: The split code of the transaction split.
:type split_code: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def verify(cls, id, **kwargs): # noqa: E501
"""Verify Payment Request # noqa: E501
:param id: (required)
:type id: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass