Terminal

Send a sale transaction request to a physical terminal (BridgePay or Strictly). The terminal will activate and wait for a card payment.

Strictly merchants (asynchronous): the response contains msgIdentifier and pollUrl. Poll GET /public/terminal/processed-messages/{messageId}; complete means the gateway answered — read the payment via its paymentId to see whether it was approved or declined. timeout is not final; do not auto-retry (risk of duplicate charge).

BridgePay merchants (synchronous): the final result is returned directly (transactionId, no msgIdentifier).

error: true can be returned inside a 2xx response.

Required fields: terminalId, amount (integer cents, 1000 = $10.00), receipt (true/false).

Optional: orderNumber, email / phone (when receipt=true: Strictly uses email over phone when both are sent; BridgePay needs both), customValues array, taxes (array of tax IDs forwarded to Strictly).

Errors: 400 validation error or inactive terminal; 401 terminal not owned by the merchant / API user has no access to the terminal; 404 merchant has no BridgePay access or terminal not found (BridgePay); 429 rate limit; 501 declined by the gateway before a transaction id was issued (BridgePay).

Send a pre-authorization request to a terminal. Reserves funds without capturing. Call POST /public/terminal/capture to settle the pre-authorized amount. Same parameters as /pay: terminalId, amount (integer cents), receipt, and optional orderNumber, email, phone, customValues, taxes.

Same response semantics as /pay: asynchronous for Strictly merchants (msgIdentifier + pollUrl, poll processed-messages; timeout is not final), synchronous for BridgePay merchants (transactionId). error: true can be returned inside a 2xx response.

Errors: 400 validation error or inactive terminal; 401 terminal not owned by the merchant / API user has no access to the terminal; 404 merchant has no BridgePay access or terminal not found (BridgePay); 429 rate limit; 501 declined by the gateway before a transaction id was issued (BridgePay).

Capture a pre-authorized terminal transaction. Synchronous — the result is returned directly and is not pollable. Provide terminalId, pnRefNum (gateway transaction id of the pre-auth payment) and amount (integer cents).

Errors: 400 validation error, no payment with that pnRefNum, or the payment is not an open pre-auth (BridgePay); 401 terminal not owned by the merchant / API user has no access to the terminal; 404 not found; 429 rate limit.

Void a terminal transaction that has not yet been settled. Synchronous — the result is returned directly and is not pollable. Provide terminalId and pnRefNum (gateway transaction id of the original pay/auth payment).

Errors: 400 validation error, no payment with that pnRefNum, or the payment is already voided (BridgePay); 401 terminal not owned by the merchant / API user has no access to the terminal; 404 not found; 429 rate limit.

Refund a terminal transaction. Synchronous — the result is returned directly and is not pollable. Provide terminalId, pnRefNum (gateway transaction id) and amount (integer cents, 1000 = $10.00).

Errors: 400 validation error, no payment with that pnRefNum, or the payment is an un-captured auth, voided or already fully refunded (BridgePay); 401 terminal not owned by the merchant / API user has no access to the terminal; 404 not found; 429 rate limit.

Close the current open settlement batch for a terminal. Synchronous — not pollable. Triggers settlement processing for all captured transactions in that batch. Provide terminalId in the request body. HTTP 2xx alone does not mean success: check status and gwResponse.resultTxt (BridgePay) or data.success / data.message (Strictly) in the response.

Errors: 400 validation error, inactive terminal or gateway failure; 401 terminal not owned by the merchant / API user has no access to the terminal; 404 merchant has no BridgePay access or terminal not found (BridgePay); 429 rate limit.

Prefer POST /public/terminal/close-batch. Close the settlement batch specifically for Strictly-native terminals. Synchronous — not pollable. terminalId is the terminal serial number.

Errors: 400 terminal login or close-batch failure upstream; 401 bad credentials.

List the payment terminals of the authenticated merchant. BridgePay merchants receive a paginated { meta, data } response. Strictly merchants receive { data, total } with every terminal (each row includes serialNumber and isActive); page, limit and timezone are ignored.

Poll for the result of an asynchronous terminal operation (Strictly merchants only) using the msgIdentifier returned by /pay and /auth. Capture, void, refund and close-batch are synchronous and not pollable.

Processing statuses: received → processing → complete | failed | timeout. complete means the gateway answered — read the payment via paymentId to see whether it was approved or declined. timeout is not final; do not auto-retry (risk of duplicate charge). A pending sale cannot be cancelled through this API.

Rate limited to 120 requests per minute.