Package simplify :: Class Payment
[hide private]
[frames] | no frames]

Class Payment

source code

domain.Domain --+
                |
               Payment

A Payment object.

Instance Methods [hide private]

Inherited from domain.Domain: __getitem__, __init__, __str__, class_name, to_dict

Static Methods [hide private]
 
create(params, *auth_args)
Creates an Payment object
source code
 
list(criteria=None, *auth_args)
Retrieve Payment objects.
source code
 
find(object_id, *auth_args)
Retrieve a Payment object from the API
source code
Method Details [hide private]

create(params, *auth_args)
Static Method

source code 

Creates an Payment object

Parameters:
  • params - a dict of parameters; valid keys are:
    • amount: Amount of the payment (minor units). Example: 1000 = 10.00 [min value: 50, max value: 99999999] required
    • card => addressCity: City of the cardholder. [max length: 50, min length: 2]
    • card => addressCountry: Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
    • card => addressLine1: Address of the cardholder. [max length: 255]
    • card => addressLine2: Address of the cardholder if needed. [max length: 255]
    • card => addressState: State code (USPS code) of residence of the cardholder. [max length: 2, min length: 2]
    • card => addressZip: Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers. [max length: 9, min length: 3]
    • card => cvc: CVC security code of the card. This is the code on the back of the card. Example: 123
    • card => expMonth: Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] required
    • card => expYear: Expiration year of the card. Format is YY. Example: 2013 = 13 [max value: 99] required
    • card => name: Name as it appears on the card. [max length: 50, min length: 2]
    • card => number: Card number as it appears on the card. [max length: 19, min length: 13] required
    • currency: Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] required
    • customer: ID of customer. If specified, card on file of customer will be used.
    • description: Custom naming of payment for external systems to use.
    • reference: Custom reference field to be used with outside systems.
    • token: If specified, card associated with card token will be used. [max length: 255]
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
  • private_api_key - Private key to use for the API call. If None, the value of simplify.private_key will be used.
Returns:
a Payment object

list(criteria=None, *auth_args)
Static Method

source code 

Retrieve Payment objects.

Parameters:
  • criteria - a dict of parameters; valid keys are:
    • filter Filters to apply to the list.
    • max Allows up to a max of 50 list items to return. [max value: 50, default: 20]
    • offset Used in paging of the list. This is the start offset of the page. [default: 0]
    • sorting Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated amount id description paymentDate.
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
an object which contains the list of Payment objects in the <code>list</code> property and the total number of objects available for the given criteria in the <code>total</code> property.

find(object_id, *auth_args)
Static Method

source code 

Retrieve a Payment object from the API

Parameters:
  • object_id - ID of object to retrieve
  • auth_args - an Authentication object used for the API call. If no value is passed the gloabl keys simplify.public_key and simplify.private_key are used. For backwards compatibility the public and private keys may be passed instead of an Authentication object.
Returns:
a Payment object