Documentation / API / Operations on Payment Methods

Retrieve all the items (max 1000)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        }
    }

Retrieve specific items by ID

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id' : ['00000000-0000-0000-0000-000000000000', '12345678-1234-1234-1234-123456781234']
        }
    }

Most complete request (just to give you the format of each parameter)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id': ['00000000-0000-0000-0000-000000000000', '12345678-1234-1234-1234-123456781234'],
		    'name' : ['Payment 1', 'Payment 2'],
		    'type' : ['WIRE'],
		    'appliesto' : ['EVERYWHERE'],
		    'appliestocountryid' : ['75b36fa9-4eb5-4a2f-8bd2-2baafd81cfe9'],
		    'createdon_min' : '2015-01-01',
		    'createdon_max' : '2042-01-01'
        },
        'pagination' : {
            'pageNumber' : '1',
            'pageSize' : '1000'
        }
    }

[
   {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Payment 1",
      "type": "WIRE",
      "appliesto": "EVERYWHERE",
      "appliestocountryid": "75b36fa9-4eb5-4a2f-8bd2-2baafd81cfe9",
      "appliestocountrycode": "CA",
      "appliestocountryname": "Canada",
      "appliestolist": [
         ""
      ],
      "instant": {},
      "author": "Mr Example",
      "createdon": "2016-01-07 14:00:22"
   },
    {
      "id": "381f23e5-1a3a-4912-8ec1-4e0a8d212618",
      "name": "Payment 2",
      "type": "WIRE",
      "appliesto": "EVERYWHERE",
      "appliestocountryid": "75b36fa9-4eb5-4a2f-8bd2-2baafd81cfe9",
      "appliestocountrycode": "CA",
      "appliestocountryname": "Canada",
      "appliestolist": [
         ""
      ],
      "instant": {},
      "author": "Mr Example",
      "createdon": "2016-01-07 14:00:22"
   }
]

Count the items

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        }
    }

Count specific items by country

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'appliestocountryid' : ['75b36fa9-4eb5-4a2f-8bd2-2baafd81cfe9']
        }
    }

Most complete request (just to give you the format of each parameter)

{
        'authentication' : {
            'apiKey' : 'jjns7519v1v3ns6xU162'
        },
        'filters' : {
            'id': ['00000000-0000-0000-0000-000000000000', '12345678-1234-1234-1234-123456781234'],
		    'name' : ['Payment 1', 'Payment 2'],
		    'type' : ['WIRE'],
		    'appliesto' : ['EVERYWHERE'],
		    'appliestocountryid' : ['75b36fa9-4eb5-4a2f-8bd2-2baafd81cfe9'],
		    'createdon_min' : '2015-01-01',
		    'createdon_max' : '2042-01-01'
        }
    }

{
   "count": "2"
}