Transaction

Create a new transaction

Creates a new transaction record.

post/v1/transaction

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/transaction
  • Auth: API key in header x-api-key

Request body

externalIdstring

External ID of the transaction.

paymentMethodstring required

Payment method used for the transaction.

amountnumber required

Amount of the transaction.

typestring required

Type of the transaction.

notesstring

Notes for the transaction.

employeestring

Employee ID who processed the transaction.

balancenumber required

Balance after the transaction.

sessionIdstring

Session ID associated with the transaction. Absent when there is no till session to record against: an online-store order, or a sale on a virtual station, which has no session and no end-of-session reconciliation.

stationIdstring

Station ID where the transaction occurred.

orderIdstring

Order ID associated with the transaction.

refundIdstring

Refund ID associated with the transaction.

outletIdstring

Outlet ID where the transaction occurred.

receiptIdstring

Receipt ID for the transaction.

Example request

{
  "externalId": "ext_txn_123",
  "paymentMethod": "credit_card",
  "amount": 10000,
  "type": "sale",
  "notes": "Customer paid in full",
  "employee": "507f1f77bcf86cd799439011",
  "balance": 10000,
  "sessionId": "507f1f77bcf86cd799439012",
  "stationId": "507f1f77bcf86cd799439016",
  "paymentData": {
    "processor": "stripe",
    "processorTransactionId": "pi_123456789",
    "device": "terminal_001",
    "processorData": "{}",
    "processorFee": 30,
    "paymentMethodType": "card_present",
    "chargeId": "ch_123456789",
    "provider": "stripe"
  },
  "orderId": "507f1f77bcf86cd799439013",
  "refundId": "507f1f77bcf86cd799439014",
  "outletId": "507f1f77bcf86cd799439015",
  "receiptId": "RCP-2025-001"
}

Response

The transaction has been successfully created.

idstring

Unique identifier for the Transaction.

createdAtstring date-time

Timestamp when the Transaction was created.

updatedAtstring date-time

Timestamp when the Transaction was last updated.

companyIdstring

Company ID associated with the Transaction.

externalIdstring

External ID of the transaction.

paymentMethodstring

Payment method used for the transaction.

amountnumber

Amount of the transaction.

currency'USD' | 'EUR' | 'GBP' | 'CAD' | 'AUD' | 'NZD' | 'CHF' | 'CNY' | 'INR' | 'MXN' | 'BRL' | 'ZAR' | 'SGD' | 'HKD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'THB' | 'MYR' | 'PHP' | 'IDR' | 'AED' | 'SAR' | 'ILS' | 'TRY' | 'RUB' | 'HTG' | 'BND' | 'CRC' | 'BDT' | 'UAH' | 'NGN' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BGN' | 'BMD' | 'BOB' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'COP' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'GEL' | 'GHS' | 'GTQ' | 'GYD' | 'HNL' | 'IRR' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MZN' | 'NAD' | 'NIO' | 'NPR' | 'PAB' | 'PEN' | 'PGK' | 'PKR' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SRD' | 'SYP' | 'TJS' | 'TMT' | 'TOP' | 'TTD' | 'TZS' | 'UYU' | 'UZS' | 'VES' | 'WST' | 'XCD' | 'YER' | 'ZMW' | 'CDF' | 'CUP' | 'ERN' | 'FKP' | 'GIP' | 'GMD' | 'KPW' | 'LRD' | 'LSL' | 'MGA' | 'MWK' | 'SCR' | 'SDG' | 'SHP' | 'SLE' | 'SOS' | 'SSP' | 'STN' | 'SZL' | 'VED' | 'XCG' | 'JPY' | 'KRW' | 'VND' | 'CLP' | 'ISK' | 'HUF' | 'TWD' | 'GNF' | 'BIF' | 'DJF' | 'KMF' | 'PYG' | 'RWF' | 'UGX' | 'VUV' | 'XAF' | 'XOF' | 'XPF' | 'KWD' | 'BHD' | 'OMR' | 'JOD' | 'TND' | 'LYD' | 'IQD'

Currency of the Transaction. ISO 4217 currency code.

typestring

Type of the transaction.

notesstring

Notes for the transaction.

employeestring

Employee ID who processed the transaction.

balancenumber

Balance after the transaction.

sessionIdstring

Session ID associated with the transaction. Absent when there is no till session to record against: an online-store order, or a sale on a virtual station, which has no session and no end-of-session reconciliation.

stationIdstring

Station ID where the transaction occurred.

orderIdstring

Order ID associated with the transaction.

refundIdstring

Refund ID associated with the transaction.

outletIdstring

Outlet ID where the transaction occurred.

receiptIdstring

Receipt ID for the transaction.

minorUnitsnumber

The Minor Units of the Transaction to convert the amount from minor units to major units.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "externalId": "ext_txn_123",
  "paymentMethod": "credit_card",
  "amount": 10000,
  "currency": "USD",
  "type": "sale",
  "notes": "Customer paid in full",
  "employee": "507f1f77bcf86cd799439011",
  "balance": 10000,
  "sessionId": "507f1f77bcf86cd799439012",
  "stationId": "507f1f77bcf86cd799439016",
  "paymentData": {
    "processor": "stripe",
    "processorTransactionId": "pi_123456789",
    "device": "terminal_001",
    "processorData": "{}",
    "processorFee": 30,
    "paymentMethodType": "card_present",
    "chargeId": "ch_123456789",
    "provider": "stripe"
  },
  "orderId": "507f1f77bcf86cd799439013",
  "refundId": "507f1f77bcf86cd799439014",
  "outletId": "507f1f77bcf86cd799439015",
  "receiptId": "RCP-2025-001"
}

Changes

No recorded changes to this operation across all 1 revision of this API.