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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Api
This is the public Twilio REST API.
NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.
"""
from datetime import datetime
from typing import Any, Dict, Optional, Union
from twilio.base import deserialize, serialize, values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class PaymentInstance(InstanceResource):
class BankAccountType(object):
CONSUMER_CHECKING = "consumer-checking"
CONSUMER_SAVINGS = "consumer-savings"
COMMERCIAL_CHECKING = "commercial-checking"
class Capture(object):
PAYMENT_CARD_NUMBER = "payment-card-number"
EXPIRATION_DATE = "expiration-date"
SECURITY_CODE = "security-code"
POSTAL_CODE = "postal-code"
BANK_ROUTING_NUMBER = "bank-routing-number"
BANK_ACCOUNT_NUMBER = "bank-account-number"
class PaymentMethod(object):
CREDIT_CARD = "credit-card"
ACH_DEBIT = "ach-debit"
class Status(object):
COMPLETE = "complete"
CANCEL = "cancel"
class TokenType(object):
ONE_TIME = "one-time"
REUSABLE = "reusable"
PAYMENT_METHOD = "payment-method"
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments resource.
:ivar call_sid: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments resource is associated with. This will refer to the call sid that is producing the payment card (credit/ACH) information thru DTMF.
:ivar sid: The SID of the Payments resource.
:ivar date_created: The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar date_updated: The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar uri: The URI of the resource, relative to `https://api.twilio.com`.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
account_sid: str,
call_sid: str,
sid: Optional[str] = None,
):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.call_sid: Optional[str] = payload.get("call_sid")
self.sid: Optional[str] = payload.get("sid")
self.date_created: Optional[datetime] = deserialize.rfc2822_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.rfc2822_datetime(
payload.get("date_updated")
)
self.uri: Optional[str] = payload.get("uri")
self._solution = {
"account_sid": account_sid,
"call_sid": call_sid,
"sid": sid or self.sid,
}
self._context: Optional[PaymentContext] = None
@property
def _proxy(self) -> "PaymentContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: PaymentContext for this PaymentInstance
"""
if self._context is None:
self._context = PaymentContext(
self._version,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
sid=self._solution["sid"],
)
return self._context
def update(
self,
idempotency_key: str,
status_callback: str,
capture: Union["PaymentInstance.Capture", object] = values.unset,
status: Union["PaymentInstance.Status", object] = values.unset,
) -> "PaymentInstance":
"""
Update the PaymentInstance
:param idempotency_key: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
:param status_callback: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
:param capture:
:param status:
:returns: The updated PaymentInstance
"""
return self._proxy.update(
idempotency_key=idempotency_key,
status_callback=status_callback,
capture=capture,
status=status,
)
async def update_async(
self,
idempotency_key: str,
status_callback: str,
capture: Union["PaymentInstance.Capture", object] = values.unset,
status: Union["PaymentInstance.Status", object] = values.unset,
) -> "PaymentInstance":
"""
Asynchronous coroutine to update the PaymentInstance
:param idempotency_key: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
:param status_callback: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
:param capture:
:param status:
:returns: The updated PaymentInstance
"""
return await self._proxy.update_async(
idempotency_key=idempotency_key,
status_callback=status_callback,
capture=capture,
status=status,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Api.V2010.PaymentInstance {}>".format(context)
class PaymentContext(InstanceContext):
def __init__(self, version: Version, account_sid: str, call_sid: str, sid: str):
"""
Initialize the PaymentContext
:param version: Version that contains the resource
:param account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will update the resource.
:param call_sid: The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.
:param sid: The SID of Payments session that needs to be updated.
"""
super().__init__(version)
# Path Solution
self._solution = {
"account_sid": account_sid,
"call_sid": call_sid,
"sid": sid,
}
self._uri = (
"/Accounts/{account_sid}/Calls/{call_sid}/Payments/{sid}.json".format(
**self._solution
)
)
def update(
self,
idempotency_key: str,
status_callback: str,
capture: Union["PaymentInstance.Capture", object] = values.unset,
status: Union["PaymentInstance.Status", object] = values.unset,
) -> PaymentInstance:
"""
Update the PaymentInstance
:param idempotency_key: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
:param status_callback: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
:param capture:
:param status:
:returns: The updated PaymentInstance
"""
data = values.of(
{
"IdempotencyKey": idempotency_key,
"StatusCallback": status_callback,
"Capture": capture,
"Status": status,
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return PaymentInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
sid=self._solution["sid"],
)
async def update_async(
self,
idempotency_key: str,
status_callback: str,
capture: Union["PaymentInstance.Capture", object] = values.unset,
status: Union["PaymentInstance.Status", object] = values.unset,
) -> PaymentInstance:
"""
Asynchronous coroutine to update the PaymentInstance
:param idempotency_key: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
:param status_callback: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.
:param capture:
:param status:
:returns: The updated PaymentInstance
"""
data = values.of(
{
"IdempotencyKey": idempotency_key,
"StatusCallback": status_callback,
"Capture": capture,
"Status": status,
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return PaymentInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
sid=self._solution["sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Api.V2010.PaymentContext {}>".format(context)
class PaymentList(ListResource):
def __init__(self, version: Version, account_sid: str, call_sid: str):
"""
Initialize the PaymentList
:param version: Version that contains the resource
:param account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.
:param call_sid: The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF.
"""
super().__init__(version)
# Path Solution
self._solution = {
"account_sid": account_sid,
"call_sid": call_sid,
}
self._uri = "/Accounts/{account_sid}/Calls/{call_sid}/Payments.json".format(
**self._solution
)
def create(
self,
idempotency_key: str,
status_callback: str,
bank_account_type: Union[
"PaymentInstance.BankAccountType", object
] = values.unset,
charge_amount: Union[float, object] = values.unset,
currency: Union[str, object] = values.unset,
description: Union[str, object] = values.unset,
input: Union[str, object] = values.unset,
min_postal_code_length: Union[int, object] = values.unset,
parameter: Union[object, object] = values.unset,
payment_connector: Union[str, object] = values.unset,
payment_method: Union["PaymentInstance.PaymentMethod", object] = values.unset,
postal_code: Union[bool, object] = values.unset,
security_code: Union[bool, object] = values.unset,
timeout: Union[int, object] = values.unset,
token_type: Union["PaymentInstance.TokenType", object] = values.unset,
valid_card_types: Union[str, object] = values.unset,
) -> PaymentInstance:
"""
Create the PaymentInstance
:param idempotency_key: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
:param status_callback: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)
:param bank_account_type:
:param charge_amount: A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize.
:param currency: The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Pay Connector are accepted.
:param description: The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions.
:param input: A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs.
:param min_postal_code_length: A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits.
:param parameter: A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the <Pay> Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors).
:param payment_connector: This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [<Pay> Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`.
:param payment_method:
:param postal_code: Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`.
:param security_code: Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`.
:param timeout: The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`.
:param token_type:
:param valid_card_types: Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`
:returns: The created PaymentInstance
"""
data = values.of(
{
"IdempotencyKey": idempotency_key,
"StatusCallback": status_callback,
"BankAccountType": bank_account_type,
"ChargeAmount": charge_amount,
"Currency": currency,
"Description": description,
"Input": input,
"MinPostalCodeLength": min_postal_code_length,
"Parameter": serialize.object(parameter),
"PaymentConnector": payment_connector,
"PaymentMethod": payment_method,
"PostalCode": serialize.boolean_to_string(postal_code),
"SecurityCode": serialize.boolean_to_string(security_code),
"Timeout": timeout,
"TokenType": token_type,
"ValidCardTypes": valid_card_types,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return PaymentInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
)
async def create_async(
self,
idempotency_key: str,
status_callback: str,
bank_account_type: Union[
"PaymentInstance.BankAccountType", object
] = values.unset,
charge_amount: Union[float, object] = values.unset,
currency: Union[str, object] = values.unset,
description: Union[str, object] = values.unset,
input: Union[str, object] = values.unset,
min_postal_code_length: Union[int, object] = values.unset,
parameter: Union[object, object] = values.unset,
payment_connector: Union[str, object] = values.unset,
payment_method: Union["PaymentInstance.PaymentMethod", object] = values.unset,
postal_code: Union[bool, object] = values.unset,
security_code: Union[bool, object] = values.unset,
timeout: Union[int, object] = values.unset,
token_type: Union["PaymentInstance.TokenType", object] = values.unset,
valid_card_types: Union[str, object] = values.unset,
) -> PaymentInstance:
"""
Asynchronously create the PaymentInstance
:param idempotency_key: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.
:param status_callback: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)
:param bank_account_type:
:param charge_amount: A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize.
:param currency: The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Pay Connector are accepted.
:param description: The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions.
:param input: A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs.
:param min_postal_code_length: A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits.
:param parameter: A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the <Pay> Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors).
:param payment_connector: This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [<Pay> Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`.
:param payment_method:
:param postal_code: Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`.
:param security_code: Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`.
:param timeout: The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`.
:param token_type:
:param valid_card_types: Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`
:returns: The created PaymentInstance
"""
data = values.of(
{
"IdempotencyKey": idempotency_key,
"StatusCallback": status_callback,
"BankAccountType": bank_account_type,
"ChargeAmount": charge_amount,
"Currency": currency,
"Description": description,
"Input": input,
"MinPostalCodeLength": min_postal_code_length,
"Parameter": serialize.object(parameter),
"PaymentConnector": payment_connector,
"PaymentMethod": payment_method,
"PostalCode": serialize.boolean_to_string(postal_code),
"SecurityCode": serialize.boolean_to_string(security_code),
"Timeout": timeout,
"TokenType": token_type,
"ValidCardTypes": valid_card_types,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return PaymentInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
)
def get(self, sid: str) -> PaymentContext:
"""
Constructs a PaymentContext
:param sid: The SID of Payments session that needs to be updated.
"""
return PaymentContext(
self._version,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
sid=sid,
)
def __call__(self, sid: str) -> PaymentContext:
"""
Constructs a PaymentContext
:param sid: The SID of Payments session that needs to be updated.
"""
return PaymentContext(
self._version,
account_sid=self._solution["account_sid"],
call_sid=self._solution["call_sid"],
sid=sid,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Api.V2010.PaymentList>"
|
