Payment_Create Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Method for creating a new payment received from a client or paid to a supplier.
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
PaymentDetails
Designation
Payment from a client or to a supplier (CLIENT/SUPPLIER)
string
PaymentType
PAYMENT/CREDIT - Payments are attributed to an invoice. Credits are used for holding funds on a client or supplier account.
string
Enumerated value: PAYMENT
Enumerated value: CREDIT
PaymentDate
date
Date the payment was made.
InvoiceID
integer
Provide an invoice ID if PaymentType is PAYMENT.
DesignatedTo
ClientID
integer
Client ID for which the payment will be linked to.
SupplierID
integer
Supplier ID for which the payment will be linked to.
Amount
double
Total amount of payment.
Currency
Payment currency.
string
Maximum length: 3
Minimum length: 1
PayMethod
Method of payment. Please use on of the predescribed codes. See Appendix in API Spec.
string
Maximum length: 35
Minimum length: 1
BankNominalCode
nonNegativeInteger
ApplyFromCredit
boolean
When set to true we will first try to pay the invoice from available credit on the client account.
SendConfirmation
boolean
When set to true we will send an email notification to the client.
Notes
Additional notes relating to this payment.
string
Maximum length: 100
Endpoint: https://api.quickfile.co.uk/1_2/payment/create
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
|