FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks & Firehoses Programming Support Logging Minor Facts State Facts Response Format How To Guides eCommerce Sites Custom Point of Sale Customer Access Bulk Downloads Major APIs / Endpoints All Endpoints Products Sales SalesBuilder Session Get Attribute Sale Capture General Purpose Data Capture Devices Barcode Scanners Eftpos IoT Sensors Power Outlets Printing Scales Security Cameras Purchasing / Supply Side Purchase Orders Invoices Invoice Payments Document Capture Rare APIs / Endpoints SSL Certificates API Key Management Diagnositics PosGreen Server to Client Messages Overview Resources / Objects Purchase Order Invoice Payable Invoice Payment Product Supplier Location Sale Lines Sale Delivery Details Sales Price Maps Employees Carriers Payments Product Kits Department 1 Customers

Payments Resource

This resource describes details of a single Payments

"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.

Available Fields

NameDescriptionDatatypeResource"q"
sidNumber
typeNumber
amountMoney/Currency
eftidNumber
dtDateTime
sequenceNumber
ridNumber
authcodeString
svcaccidPrepay/SVC account number this payment relates tooNumber
physkeyString
chequepayerString
chequebankString
chequebranchString
physkeysvcString
usagetokenBearer token accepted when payment was proven using a UseageToken. Typically seen on external eCommerce salesString
paysrcuidNumber
paytidNumber
originalnameName of original payment type, before being converted to a payment type id stored in the 'Type' field. Typically holds the incoming payment type name from eCommerce systemsString
cardnoOriginal card number or other identifier for this payment record. Typically used when eCommerce system payments are recordedString
overridecodeAn authorization code obtained externally to permit this payment to be accepted. Typically used for accounts that exceed their credit limitString
payflagsNumber