Payment_GetPayMethods Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Returns a list of available payment method codes supported within the Quick File system.
Header
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
DeviceID
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
string
Minimum length: 0
Maximum length: 100
SubmissionNumber
string
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Authentication
Account number, and an MD5 hash "Account number, API Key and Submission Number"
AccNumber
MD5Value
ApplicationID
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
string
Minimum length: 1
Maximum length: 100
Body
IncludeIconPaths
boolean
By default this is true and the xml response will include an image path to the gif/png icon for the payment method. Select false if you want to minimise the XML response payload.
Endpoint: https://api.quickfile.co.uk/1_2/payment/getpaymethods
Example Request:
We had a problem retrieving a JSON sample for this method, please retry later
Example Response:
Example Request:
We had a problem retrieving an XML sample for this method, please retry later
Example Response:
| Other Payment Methods |
|---|
|
Create a new payment record
|
|
Delete a payment record
|
|
Retrieve a payment record
|
|
Get the collection of payment methods
|
|
Search for a payment based on specific search parameters
|