Payment Method Methods

API for Payment Methods.

payment_method.available()

Returns a list of available payment methods for this account.

Returns:A list of dictionaries as described in payment_method.info()
payment_method.info()

Describes a payment method.

Parameters:payment_method_id (String) – the unique id of the payment method
Returns:A dictionary with the following keys:
id
String: A unique id to identify this payment method
type
String: One of ‘account’, ‘card’, ‘bank_transfer’, ‘cheque’, ‘paypal’, ‘transfer_or_cheque’, or ‘notset’.
default
Boolean: Indicates whether this is the account’s default payment method.

The following keys are only included where the payment method is a card or billing account.

status
String: Either ‘AVAILABLE’ or ‘EXPIRED’.
name
String: A nickname that the customer gave the payment method.
payment_method.remove()

Remove a payment card from the account.

To remove a payment method that is the default payment method for the account, you must first set the default to a different payment method using payment_method.set_default().

Parameters:payment_method_id (String) – the unique id of the payment method
Returns:A dictionary as described in payment_method.info(), with status=’DELETED’.
payment_method.set_default()

Set the default payment method for the account.

Parameters:payment_method_id (String) – the unique id of the payment method
Returns:A dictionary as described in payment_method.info()

Previous topic

Memstore User Methods

Next topic

Server Methods

This Page