Skip to main content

Physical Sale

POST 
/public/api/v1/sale

Starts an in-person sale on a physical payment terminal connected to a Softpay point of sale.

This endpoint creates the transaction immediately. The transaction returned in the response confirms that the sale request was accepted and created, but not that the cardholder has completed the payment yet.

You’ll receive the outcome of the payment on the notificationUrl you provide within the request, making it the primary way to track the result of this payment. Webhooks can be used separately if you need broader, system-wide updates.

If terminal.id is provided, ePay targets that specific terminal. If terminal is omitted, ePay automatically routes the sale to the fallback terminal for the given point of sale.

The pointOfSaleId must refer to a physical Softpay point of sale that belongs to your account.

Request​

Responses​

Physical sale transaction created successfully. Processing will begin on the terminal shortly.