Library
Developer Home
FD1 Client Protocol
Home
Concepts
Reading Data
Writing Data
Protocol Defined
Servers
Connect & Authenticate
Proxies & Tunnels
Webhooks & FirehosesProgramming 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
Webhooks & Firehoses
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
Name | Description | Datatype | Resource | "q" |
sid | Number | |||
type | Number | |||
amount | Money/Currency | |||
eftid | Number | |||
dt | DateTime | |||
sequence | Number | |||
rid | Number | |||
authcode | String | |||
svcaccid | Prepay/SVC account number this payment relates too | Number | ||
physkey | String | |||
chequepayer | String | |||
chequebank | String | |||
chequebranch | String | |||
physkeysvc | String | |||
usagetoken | Bearer token accepted when payment was proven using a UseageToken. Typically seen on external eCommerce sales | String | ||
paysrcuid | Number | |||
paytid | Number | |||
originalname | Name 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 systems | String | ||
cardno | Original card number or other identifier for this payment record. Typically used when eCommerce system payments are recorded | String | ||
overridecode | An authorization code obtained externally to permit this payment to be accepted. Typically used for accounts that exceed their credit limit | String | ||
payflags | Number |