API method

getPaymentTypes

Method returns list of payment types.

GET

Usage URL

https://hedo-pets.com/api/getPaymentTypes.json?key=YOURAPIKEY

Input
Output
Response JSON
Response XML

Query params

Put these in your URL, e.g. ?id=123.

country string

required

Country iso code.

Example

Two letters format ie: DE, PL, GB, US
id integer or integer[]

Internal identifier of payment type.
More than one value can be specified after comma (,) separator.
modified datetime YYYY-MM-DD HH:MM:SS

Return all payment types modified after the modified param. That is highly recommended when you want to update your local database.
name string

Name of the payment type.

Example

'pay' will return all payment types that contain pay in the `name` field.
fkshipmenttype integer or integer[]

Internal ID of shipment type (from getShipmentTypes) - allows to return payment types available for this shipment type.
More than one value can be specified after comma (,) separator.
lang string

Language of result. ISO 2 Letter Language Codes

Example

en, pl, cs

Response fields

Fields returned by this method.

id integer

Payment type internal identifier.
name string

Payment type name.
description string

Payment type description.
modified datetime YYYY-MM-DD HH:MM:SS

When payment type was last modified
logo string

File name of logo.

Response JSON

Example URL: https://hedo-pets.com/api/getPaymentTypes.json?key=YOURAPIKEY&lang=en&id=3,5

[
    {
        "id": 5,
        "name": "Bank transfer",
        "description": "",
        "modified": "2016-07-13 07:49:51",
        "logo": ""
    },
    {
        "id": 3,
        "name": "Cash on delivery",
        "description": "",
        "modified": "2016-07-13 07:50:06",
        "logo": ""
    }
]

Response XML

Example URL: https://hedo-pets.com/api/getPaymentTypes.xml?key=YOURAPIKEY&lang=en&id=3,5

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<id>5</id>
		<name>Bank transfer</name>
		<description></description>
		<modified>2016-07-13 07:49:51</modified>
		<logo></logo>
	</item>
	<item>
		<id>3</id>
		<name>Cash on delivery</name>
		<description></description>
		<modified>2016-07-13 07:50:06</modified>
		<logo></logo>
	</item>
</root>