|
8 | 8 |
|
9 | 9 | class DynamicBrcode(Resource):
|
10 | 10 | """# DynamicBrcode object
|
11 |
| - When you initialize a DynamicBrcode, the entity will not be automatically |
12 |
| - sent to the Stark Bank API. The 'create' function sends the objects |
13 |
| - to the Stark Bank API and returns the list of created objects. |
14 |
| - DynamicBrcodes are conciliated BR Codes that can be used to receive Pix transactions in a convenient way. |
15 |
| - When a DynamicBrcode is paid, a Deposit is created with the tags parameter containing the character “dynamic-brcode/” followed by the DynamicBrcode’s uuid "dynamic-brcode/{uuid}" for conciliation. |
16 |
| - Additionally, all tags passed on the DynamicBrcode will be transferred to the respective Deposit resource. |
17 |
| - ## Parameters (required): |
18 |
| - - amount [integer]: DynamicBrcode value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34) |
19 |
| - ## Parameters (optional): |
20 |
| - - expiration [integer or datetime.timedelta, default 3600 (1 hour)]: time interval in seconds between due date and expiration date. ex 123456789 |
21 |
| - - tags [list of strings, default []]: list of strings for tagging, these will be passed to the respective Deposit resource when paid |
22 |
| - - display_description [string, default None]: optional description to be shown in the payer bank interface. ex: "Payment for service #1234" |
23 |
| - - rules [list of DynamicBrcode.Rules, default []]: list of DynamicBrcode.Rule objects for modifying invoice behavior. ex: [DynamicBrcode.Rule(key="allowedTaxIds", value=[ "012.345.678-90", "45.059.493/0001-73" ])] |
24 |
| - ## Attributes (return-only): |
25 |
| - - id [string]: id returned on creation, this is the BR code. ex: "00020126360014br.gov.bcb.pix0114+552840092118152040000530398654040.095802BR5915Jamie Lannister6009Sao Paulo620705038566304FC6C" |
26 |
| - - uuid [string]: unique uuid returned when the DynamicBrcode is created. ex: "4e2eab725ddd495f9c98ffd97440702d" |
27 |
| - - picture_url [string]: public QR Code (png image) URL. ex: "https://sandbox.api.starkbank.com/v2/dynamic-brcode/d3ebb1bd92024df1ab6e5a353ee799a4.png" |
28 |
| - - updated [datetime.datetime]: latest update datetime for the DynamicBrcode. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0) |
29 |
| - - created [datetime.datetime]: creation datetime for the DynamicBrcode. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0) |
| 11 | + Check out our API Documentation at https://starkbank.com/docs/api#dynamic-brcode |
30 | 12 | """
|
31 | 13 |
|
32 | 14 | def __init__(self, amount, expiration=None, tags=None, display_description=None, rules=None, id=None, uuid=None,
|
|
0 commit comments