Skip to content

Commit 2c2b45b

Browse files
committed
added detailed description to Payment Class
1 parent 427d9e6 commit 2c2b45b

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

figo/models.py

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,28 @@ def __init__(self, session, **kwargs):
251251

252252
class Payment(ModelBase):
253253

254-
"""Object representing a Payment."""
254+
"""
255+
Object representing a Payment.
256+
257+
When creating a new Payment for submitment to the Figo API all necessary
258+
fields have to be set on the Payment object.
259+
260+
Required fields:
261+
- account_id - Internal figo connect ID of the account
262+
- type - Payment type (Valid values: Transfer, Direct Debit, SEPA transfer, SEPA direct debit)
263+
- name - Name of creditor or debtor
264+
- account_number - Account number of creditor or debtor
265+
- bank_code - Bank code of creditor or debtor
266+
- amount - Order amount
267+
- purpose - Purpose text
268+
269+
Optional fields:
270+
- currency - Three-character currency code (Default: EUR / Valid values: EUR)
271+
- text_key - DTA text key
272+
- text_key_extension - DTA text key extension
273+
- notification_recipient - Recipient of the payment notification, should be an email address
274+
- cents - If true, the amount is submitted and displayed as cents
275+
"""
255276

256277
__dump_attributes__ = ["type", "name", "account_number", "bank_code", "amount", "currency", "purpose"]
257278

0 commit comments

Comments
 (0)