POST /v1/:facility_id/web_payments/create_transport_key
Create a transport key for a web payment

Params

Param name Description
amount
required

The total amount to charge for the transaction

Validations:

  • Must be a String
clerk_id
optional

A unique ID for the user running the transaction. POS can send the server ID, clerk ID, employee ID, register ID or any other ID that identifies the user or system running the transaction.

Validations:

  • Must be a String
terminal_id
optional

Terminal ID to uniquely identify the terminal to the processor. The terminal ID must contain all numeric characters.

Validations:

  • Must be a String
entry_mode
optional

The entry mode for the keypad or web form passed on to the payment provider (default: Keyed)

Validations:

  • Must be a String
invoiceable_item_id
optional

The invoiceableitem ID of the fee that will be applied with a successful payment (depricated, use paymentfee_id)

Validations:

  • Must be a String
invoiceable_item_ledger_id
optional

The ledger ID that the invoiceable_item fee should be applied to (depricated)

Validations:

  • Must be a String
payment_fee_id
optional

The invoiceable_item ID of the fee that will be applied with a successful payment

Validations:

  • Must be a String
payments
optional

The ledgers and amounts being paid for auto reconciliation

Validations:

  • Must be an array of any type