Client_NewDirectDebitCollection Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Available for use whereby the client has a Direct Debit Pre-authorisation in place.
Header
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
TestMode
Test mode set as true will make no database modifications.
boolean
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 of "API Key, Password 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
CollectionType
Determines if the funds are allocated to and held on a client account or collected against a specific invoiceID.
AllocateToInvoice
ClientID
integer
InvoiceID
integer
Provide a valid InvoiceID associated to the supplied ClientID. The full balance will be collected from the invoice.
ChargeAtDate
date
If a valid date is provided, charge will be collected on that date. Otherwise, charge will be collected immediatly.
PartialAmount
decimal
A partial amount in GBP to be collected.
AllocateToClientAccount
ClientID
integer
Amount
decimal
Amount in GBP to be collected.
PaymentName
Provide a name for your payment.
ChargeAtDate
date
If a valid date is provided, charge will be collected on that date. Otherwise, charge will be collected immediatly.
Endpoint: https://api.quickfile.co.uk/1_2/client/newdirectdebitcollection
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 Client Methods
Create a new client record
Delete a client record
Retrieve client and contact data
Create a new contact record for an existing client
Retrieve a passwordless login URL for a client
Initiate a new Direct Debit collection request
Retrieve client records based on a set of search parameters
Update an existing client record
Quick File Limited - Copyright © 2019
QuickFile Accounting | Community | Knowledgebase