Payments template

Create and update BigCommerce B2B Edition invoice payments using Shift.

tip

Check out our step-by-step guides for how to import & export.

Quick start

The best way to get started is to run an export and use the file as a guide to the format required.

If you are creating payments, follow the creating payments guide or download the minimal payment creation example.

To see the fields included on export, download the full payment export example.

Import & export columns

Basic columns

Column	Description
Mode	The import mode for this row. See import modes for more information.
ID	The unique identifier provided by BigCommerce for the payment. Use this to update or delete an existing payment. This field is read-only.
External ID	An external payment ID, such as an ID from an ERP or another back office system. This field is required when creating a payment. When creating payments, Shift uses this field to match payment rows across the sheets in the import file.
Applied Status	The applied status for the payment. This field is read-only.
Allowed Operations	The operations currently allowed for the payment. This field is read-only.
Allowed Statuses	The statuses currently allowed for the payment. This field is read-only.
Channel ID	The channel ID linked to the payment.
Channel Name	The channel name linked to the payment.
Created At	The date and time when the payment was created. This field is read-only.
Currency	The payment currency code, e.g. GBP or USD. This field is required when creating a payment.
Company ID	The B2B company ID that this payment belongs to. This field is required when creating a payment.
Customer Name	The customer name. This field is provided for information on exports.
Memo	The payment memo. This field is required when creating a payment.
External Customer ID	An external customer ID, such as an ID from an ERP or another external system.
Fees	The payment fees. This field is read-only.
Funding Status	The funding status. Allowed values: Awaiting Processing, Processing, Completed, Refunded, 1, 2, 3, 4.
Module Name	The payment module name.
Payer Customer ID	The payer customer ID.
Payer Name	The payer name.
Processing Status	The processing status. Allowed values: Awaiting Processing, Processing, Completed, Refunded, 1, 2, 3, 4.
Total	The total payment amount. This field is read-only.
Updated At	The date and time when the payment was last updated. This field is read-only.

Transaction columns

Transactions are exported as child rows for a payment.

info

Transaction columns are export only. Do not include them when importing payments.

Column	Description
Payment ID	The BigCommerce identifier for the payment.
Payment External ID	The payment identifier from your back office system.
Raw Memo	The raw memo on the transaction. This field is read-only.
Raw Transaction	The raw transaction payload. This field is read-only.
Raw Type	The raw transaction type. This field is read-only.

Line item columns

Line items are imported as rows on the Line Items sheet. A payment can have multiple line item rows, with each row applying part of the payment to a different invoice ID and amount.

Column	Description
Payment ID	The BigCommerce identifier for the payment.
Payment External ID	The payment identifier from your back office system. Use this to connect line item rows to a new payment before BigCommerce creates the Payment ID.
Value	The payment amount to apply to the invoice. This field is required when creating a payment.
Invoice ID	The invoice ID to apply this payment amount to. This field is required when creating a payment.
Invoice Number	The invoice number for this payment line. This field is read-only.

info

Payment line items can be added or updated by import, but they cannot be deleted or replaced. Line items always use merge behaviour.

info

On payment updates, BigCommerce accepts a smaller set of editable fields: Line Items, Currency, Memo, Company ID, External ID, External Customer ID, Payer Name, Payer Customer ID, Processing Status, and Funding Status.

Import modes

Use Import modes to control the import behaviour.

The Mode column on import is used to determine what kind of update action is performed for each row.

Mode	Action
Merge	Existing items are updated. New items are created. Missing columns or empty column values are ignored. This is the default mode.
Update	Existing items are updated. New items are ignored. Missing columns or empty column values are ignored
Create	New items are created. Existing items are ignored.
Replace	Existing items are deleted and recreated. New items are created. This is the same as a Delete followed by a Merge.
Delete	Existing items are deleted.
Skip	This item is ignored

Export filters

You can filter payment exports by:

• Payment
• Company
• External Customer ID
• Invoice ID
• Processing Status