---
title: "ExternalSettlement"
method: POST
path: "/ExternalSettlement"
tags: ["Transactions"]
---

# ExternalSettlement

`POST /ExternalSettlement`

## Request body

- ExternalSettlementRequest, nullable — Settlement request details for an external transaction.
  - `NayaxTransactionId` integer — Nayax Internal Unique identifier for the transaction.
  - `SparkTransactionId` string, nullable — Unique identifier for this transaction, used by Spark.
  - `MachineAuTime` string, yyyyMMddHHmmssfff., nullable — The date time string of when the `/Authorization` took place, in local (machine) time.
  - `SiteId` integer, nullable — Optional. Echo value from Authorization Callback. Represents the Site ID.
  - `TerminalId` string — Unique Identifier for the Nayax Terminal.
  - `TerminalIdType` 1 | 2, nullable — Indicates the type of TerminalId. 1 - Nayax HW serial, 2 - Nayax Machine ID
  - `Amount` number, double — The value to be provided to the Terminal for transaction initiation. Decimal (max 2 digits for cents)
  - `EReceiptData` string, nullable — Optional. Transaction's 3rd party data for receipt generation.
  - `ProductInfo` ProductInfo[], nullable — Array of products associated with the settlement.
    - `Value` number — Mandatory. The monetary amount of the product.
    - `Code` integer, nullable — Represents the product code in the product's map.
    - `Quantity` integer, nullable — Quantity of the product purchased.

## Response `200`

Success

- ExternalSettlementResponse, nullable — Response details for an external settlement request.
  - `SparkTransactionId` string, nullable — The Spark unique identifier for this transaction.
  - `Status` Status — Transaction Status Details
    - `Verdict` string — Status of the request (Approved / Declined)
    - `ErrorCode` integer, nullable — - Conditional - Reason for declined request
    - `ErrorDescription` string, nullable — - Conditional - Length: 255 - Error description
    - `StatusMessage` string, nullable — - Optional - Length: 255 - Transaction status message as free text field
  - `AuthCode` string, nullable — For Credit card implementation, when the transaction is approved, this is the External (usually Card issuer's) Authorization Code.
  - `MachineAuTime` string, yyyyMMddHHmmssfff, nullable — The date time string of when the `/Authorization` or `/Sale` took place, in local (machine) time.
  - `Amount` number, double — The value Settled by the card issuer during the Settlement phase.

---

[API](https://skmtc.net/nayax/apis/nayax-cortina-api.md) · [All operations](https://skmtc.net/nayax/apis/nayax-cortina-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nayax/nayax-cortina-api/revisions/421f6f83c257/schema)