SFTP Retail Headers

Please review the standard Green Check fields below to ensure you send the necessary data in your CSV file.

Records missing required fields will fail to upload. Sales missing product details (product_grams, product_type) will upload but will be marked as Unchecked (unchecked sales may not meet your Financial Institutions compliance standards).
Payment amounts across all payment fields must add up to transaction_total.
Timezone handling: a trailing Z is treated as UTC, an explicit offset (e.g. -05:00) is respected, and timestamps with no timezone are assumed to be in your organization's local timezone.

Field Name	Definition	Format
transaction_id	Unique identifier for a transaction	Alphanumeric
receipt_date	Date and time stamp of transaction	ISO format, e.g. 2021-02-27T12:30:00.000Z
customer_id_number	A unique ID number assigned to the customer record	Alphanumeric
transaction_total	Subtotal plus tax on all products sold within a transaction	Numeric
medical_or_adult_use	Whether a sale is medical or adult	medical or adult
location_id	This is your unique identifier per location	Alphanumeric

At least one payment field must be present on each record. Fields you don't use can be left blank, set to 0, or omitted from the file entirely.

Field Name	Definition	Format
transaction_cash_paid	Amount of cash paid during a transaction	Numeric, can be 0 or negative (change back)
transaction_debit_paid	Amount put on a debit card during a transaction	Numeric, can be 0
transaction_credit_paid	Amount put on a credit card during a transaction	Numeric, can be 0
transaction_check_paid	Amount paid with a check during a transaction	Numeric, can be 0
transaction_ach_paid	Amount paid via ACH during a transaction	Optional, numeric, can be 0
transaction_other_paid	Amount paid via any payment method not listed above	Optional, numeric, can be 0

While optional, most of these fields are used to check for compliance on sales. Omitting these values will result in unchecked sales.

Field Name	Definition	Format
customer_id_type	The type of ID provided	Optional, i.e. MMJ, Driver's License, Non-Driver State ID
customer_id_expiry_date	The expiration date provided on the customer's license	Optional, eg. 2021-02-27
customer_dob	Date of birth of the customer	Optional, eg. 2021-02-27
product_id	PoS ID number or SKU of the product sold	Optional, alphanumeric
product_name	Name of product sold	Optional, alphanumeric
product_grams	Grams of marijuana that an individual product sold contains	Optional, numeric, can be 0
product_price_per_unit	Pre-tax price of one unit of a product sold	Optional, numeric
product_type	Type of product sold	Optional, eg., flower, edible, oil, accessory, etc
transaction_subtotal	Subtotal of all products sold within a transaction	Optional, numeric
transaction_tax	Total amount of taxes applied across all products on the transaction	Optional, numeric

To correct or refund a previously submitted sale, either:

Resend the sale with the same transaction_id and updated (e.g. zeroed) amounts. The existing sale is updated in place.
Send a new transaction_id with negative amounts to offset the original sale.

Do not resend the same transaction_id with negative amounts; this replaces the original rather than netting against it.