Pay on terminal
Send a sale transaction request to a physical terminal (BridgePay or Strictly). The terminal will activate and wait for a card payment. The response is asynchronous — use GET /processed-messages/{messageId} to poll for the result.
Required fields: terminalId, amount (in cents, e.g. 100 = $1.00), receipt (true/false).
Optional: orderNumber, email (if receipt=true), phone (if receipt=true), customValues array.
Headers
authorizationPay on terminal › Request Body
receiptReceipt
terminalIdterminal Id
clientIdClient Id
amountAmount to pay
orderNumberOrder number
emailUser email
phonePhone number doing the payment
Custom Values
Pay on terminal › Responses
Request accepted. Poll processed-messages for result.
dataPre-auth on terminal
Send a pre-authorization request to a terminal. Reserves funds without capturing. Call POST /capture to settle the pre-authorized amount. Same parameters as /pay: terminalId, amount (cents), receipt, and optional orderNumber, email, phone.
Headers
authorizationPre-auth on terminal › Request Body
receiptReceipt
terminalIdterminal Id
clientIdClient Id
amountAmount to pay
orderNumberOrder number
emailUser email
phonePhone number doing the payment
Custom Values
Pre-auth on terminal › Responses
Auth request accepted.
Capture on terminal
Capture a pre-authorized terminal transaction. Provide terminalId, pnRefNum (the transaction ID from the pre-auth response), and amount in cents.
Capture on terminal › Request Body
clientIdWebpage/Application that belongs to a company registered with Zero-Platform, not the current user paying
amountAmount to pay
terminalIdterminal Id
pnRefNumThe transaction ID of the payment
Capture on terminal › Responses
Capture request accepted.
Void on terminal
Void a terminal transaction that has not yet been settled. Provide terminalId and pnRefNum (the transaction ID from the original pay/auth response).
Void on terminal › Request Body
clientIdWebpage/Application that belongs to a company registered with Zero-Platform, not the current user paying
terminalIdterminal Id
pnRefNumThe transaction ID of the payment
Void on terminal › Responses
Void request accepted.
Refund on terminal
Refund a settled terminal transaction. Provide terminalId, pnRefNum (transaction ID), and amount in cents (e.g. 100 = $1.00).
Refund on terminal › Request Body
clientIdWebpage/Application that belongs to a company registered with Zero-Platform, not the current user paying
amountAmount to pay
terminalIdterminal Id
pnRefNumThe transaction ID of the payment
Refund on terminal › Responses
Refund request accepted.
Close batch on terminal
Close the current open settlement batch for a terminal. Triggers settlement processing for all captured transactions in that batch. Provide terminalId in the request body.
Close batch on terminal › Request Body
clientIdWebpage/Application that belongs to a company registered with Zero-Platform, not the current user paying
terminalIdterminal Id
Close batch on terminal › Responses
Batch closed.
List terminals
List all payment terminals (BridgePay or Strictly) associated with a merchant client ID.
query Parameters
pagePage number (default: 1)
limitItems per page (default: 25)
clientIdMerchant client ID
timezoneIANA timezone name for date display (e.g. America/New_York)
Headers
authorizationList terminals › Responses
Paginated terminals list.
Poll terminal message status
Poll for the result of an asynchronous terminal operation using the msgIdentifier returned by pay/auth/capture/void/refund responses.
Processing statuses: received → processing → complete | failed | timeout.
Rate limited to 50 requests per minute.
path Parameters
messageIdMessage identifier (msgIdentifier) returned by a terminal operation
Poll terminal message status › Responses
Processed message details.
data