.. meta::
    :description: This documentation will guide you through the use of the Memset API.

.. index::
   double: Methods; payment_method

.. _payment_method:

Payment Method Methods
----------------------

API for Payment Methods.

.. function:: payment_method.available

    Returns a list of available payment methods for this account.
    
    
    :returns: A list of dictionaries as described in :func:`payment_method.info`

.. function:: payment_method.info

    Describes a payment method.
    
    :param payment_method_id: the unique id of the payment method
    :type payment_method_id: String
    
    :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.

.. function:: 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 :func:`payment_method.set_default`.
    
    :param payment_method_id: the unique id of the payment method
    :type payment_method_id: String
    
    :returns: A dictionary as described in :func:`payment_method.info`, with status='DELETED'.

.. function:: payment_method.set_default

    Set the default payment method for the account.
    
    :param payment_method_id: the unique id of the payment method
    :type payment_method_id: String
    
    :returns: A dictionary as described in :func:`payment_method.info`