Skip to main content
POST
/
Settlement
Settlement
curl --request POST \
  --url https://{domain}/api/Settlement \
  --header 'Content-Type: application/json' \
  --data '
{
  "NayaxTransactionId": 2004545072,
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "SiteId": 2,
  "TerminalId": "0434334921100366",
  "TerminalIdType": 1,
  "Amount": 12.25,
  "EReceiptData": "{\"General\":[{\"Company\":\"Your Payments - Our Solutions\",\"Station Name\":\"B12\"}],\"Service\":[{\"Product\":\"Something Yummy\",\"Price Per Unit\":\"$2.45\",\"Number of Units\":2}]}"
}
'
{
  "SparkTransactionId": "12c7cec2-c690-4425-9a1f-db0db60e2d8c",
  "Status": {
    "Verdict": "Approved",
    "ErrorDescription": "No Errors"
  },
  "CardBrand": "Visa",
  "CardLast4Digits": "1234",
  "AuthCode": "333333",
  "MachineAuTime": "20240205194122328",
  "AuTime": "20240205174122328",
  "SeTime": "20240205192215572",
  "CurrencyCode": "EUR",
  "CurrencyNumeric": "978",
  "FiscalRrn": "1A2b3C4d5E6f7g8H9i",
  "NayaxRRN": "111111",
  "Amount": 12.25
}
The Settlement endpoint is used to finalize an approved transaction. After the session ends and the total amount is known, the integrator sends the final amount along with optional e-receipt information. This method is only relevant for transactions with Pre-Authorization.

Body

application/json

The request payload containing the final transaction amount and optional e-receipt data.

The request payload to finalize a pre-authorized transaction after the session ends and the final amount is known. This method is only relevant for transactions using the Pre-Authorization flow.

​
NayaxTransactionId
integer<int64>

The unique transaction ID assigned by Nayax for the transaction being settled.

​
SparkTransactionId
string | null

The unique session ID from the initial /StartAuthentication request. This ID links the settlement to the original transaction.

​
SiteId
integer<int16> | null

The identifier of the site where the transaction occurred. This value is an echo from the initial authorization callback.

​
TerminalId
string

The serial or external ID of the terminal used for the transaction.

​
TerminalIdType
integer<int32> | null

Defines the ID type used for the TerminalId. Use 1 for the HW Serial and 2 for the Nayax Machine ID.

​
Amount
number<double>

The final transaction amount to be settled, specified in major currency units (e.g., dollars or euros).

​
EReceiptData
string | null

An optional JSON-formatted string containing additional e-receipt details. This data can be used to provide digital receipts to consumers via the Nayax eReceipt platform.

Response

200 - application/json
object | null

Success. The transaction has been successfully settled.

The response payload returned by Spark upon a successful Settlement request. This payload includes final transaction details such as the settled amount, card information, and timestamps.

​
SparkTransactionId
string | null

The unique ID used for this transaction session, which is an echo of the value sent in the request.

​
Status
object

Transaction Status Details

​
CardBrand
string | null

The brand of the card used for the transaction, such as Visa or MasterCard.

​
CardLast4Digits
string | null

The last four digits of the payment card used.

​
AuthCode
string | null

The authorization code returned by the payment provider for the transaction.

​
MachineAuTime
string | null

The device timestamp at the moment of authorization, formatted as yyyyMMddHHmmssSSS.

​
AuTime
string | null

The authorization server's timestamp.

​
SeTime
string | null

The timestamp from the settlement server, formatted as yyyyMMddHHmmssSSS.

​
CurrencyCode
string | null

The ISO currency code for the transaction, such as EUR.

​
CurrencyNumeric
string | null

The ISO 4217 numeric currency code, such as 978 for EUR.

​
FiscalRrn
string | null

The fiscal reference number for the transaction, used for receipt and audit purposes.

​
NayaxRRN
string | null

The internal Nayax settlement reference number.

​
Amount
number<double>

The final settled amount, approved by the Payment Provider.