User Tools

Site Tools


developers:api:payment_method

Payment Methods

/v1/payment_method/code/get

Fetches a detailed listing of the given payment method.

    $ curl -u user:pass -d "" \
    >      https://api.snapbill.com/v1/payment_method/other/get.json

File: examples/payment_method.txt-1.json -

    {
      "code": 200,
      "type": "list",
      "page": 1,
      "numpages": 1,
      "class": "payment_method",
      "list": [
        {
          "depth": 0,
          "code": "netcash",
          "name": "Netcash Collect",
          "enabled": true,
          "currencies": [
            {
              "code": "ZAR",
              "format": "R%.2f",
              "enabled": true
            }
          ]
        },
        {
          "depth": 0,
          "code": "other",
          "name": "Other",
          "enabled": true
        }
      ]
    }

Parameter listing

Name Availability Description
depth get The depth parameter signals the amount of data for the payment method that was provided. depth=0 is the highest level that provides full detail.
code get The unique code for this payment method inside snapbill as a lower case string.
name get Official name of the payment method in the system
enabled get Boolean value indicating whether the payment method is enabled on the current account or not.
currencies get A list of all the enabled currencies that are supported by this payment method. If there is no restriction this is not included.

/v1/payment_method/list

List all the payment methods that are enabled on the account.

Results can optionally be filtered by the filters listed below.

    $ curl -u user:pass -d "" \
    >      https://api.snapbill.com/v1/payment_method/list.json

File: examples/payment_method.txt-2.json -

    {
      "code": 200,
      "type": "item",
      "class": "payment_method",
      "payment_method": {
        "depth": 0,
        "code": "other",
        "name": "Other",
        "enabled": true
      }
    }

List Payment Details Filters

Name Availability Description
page get The page of results to return.
perpage get The number of results per page to return.
developers/api/payment_method.txt · Last modified: 2014/10/18 11:54 by Jaco van Wyk

Page Tools