TheDocumentation Index
Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
Use this file to discover all available pages before exploring further.
pay method initiates an immediate transaction where detection, authorization, and settlement occur in one continuous flow. Unlike the two-phase fuel workflow, this serves fixed-price sales or “Pay-Inside” scenarios where the final amount is known before the card is presented.
Use this method to:
- Facilitate instant fulfillment for car washes, vacuum stations, or kiosk items where the price remains fixed.
- Simplify integration by removing the need for a separate settlement call.
- Increase throughput in high-traffic environments where users pay a set fee and move on quickly.
Requests
All requests must include thecommand, requestId, and the exact amount to be charged. The terminal will activate the reader and wait for the customer to present their payment method.
The following example shows a typical request:
Parameter Definitions
The table below describes the parameters available for this request:| Name | Type | Required | Description |
|---|---|---|---|
| amount | integer | Yes | The exact amount to be charged (refer to decimalPlace). |
| channels | array | No | Defines allowed payment methods: CTLS, CHIP, SWIPE, or QR. Defaults to all if omitted. |
Responses
The terminal returns a response only after the payment has been fully authorized and captured by the gateway. The following example shows a typical response:Response Parameters
Below are the parameters returned in thedata object upon a successful payment:
| Name | Type | Description |
|---|---|---|
| transactionId | string | The unique identifier for the completed transaction. |
| amount | integer | The final amount that was successfully charged. |
| state | string | Returns SETTLED (or PAID) upon success. |
| cardBrand | string | The brand of the card used (e.g., VISA, MASTERCARD). |
| cardEntryMode | string | The method used to read the card (e.g., CTLS). |
| maskedPan | string | The masked card number for receipts. |
| approvalCode | string | The bank-issued authorization code for the charge. |