> ## Documentation Index
> Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 取消

Cortina 预付使用 `Cancel` 命令通知集成方,以便在以下任一情况发生时,与 Cortina 支付提供商发起取消流程:

1. 收到失败的 `Authorization` 响应(由于超时或 `Authorization` 响应中包含错误代码)。
2. 产品选择过程中出现的问题 - 消费者无操作/按下取消按钮/消费者选择了无效的产品。
3. 机器故障（产品分发/服务提供方面出现问题）

此命令对于让支付提供商知道交易已在 Nayax 端（以及从消费者的角度来看）被取消至关重要，并且执行此命令是为了让支付提供商在其端完成取消操作。

<Note>
  注意:此命令仅适用于预授权(PreAuthorization)。其在预选择(PreSelection)流程中的等效命令是 `Void` 命令。
</Note>

## 要求

Nayax 的服务器会向您配置的 `Cancel` 端点发送 POST 请求,格式如下:

`(customer's URL)/Cortina/PrePaid/Cancel`

该负载（payload）包含读卡操作的完整结果：

```json theme={null}
{
  "ReasonCode": 999,
  "ReasonText": "General exception",
  "BasicInfo": {
    "TransactionId": 2.3658433596983443e+35,
    "NayaxTransactionId": 0,
    "Amount": 0.1,
    "CurrencyCode": "USD",
    "CurrencyNumeric": 376,
    "SiteId": 12,
    "MachineAuTime": "071221132914",
    "TimeoutMS": 15000,
    "IsProductSelected": true
  },
  "DeviceInfo": {
    "HwSerial": "0434324119376526",
    "FWVersion": "4.0.0.22-RC01 - Aug 25 2021",
    "Type": "Onyx"
  },
  "MachineInfo": {
    "Id": 869761713,
    "Name": "TestPayStaticQR V2",
    "TerminalId": 987654321,
    "DecimalPlace": 2,
    "Offset": 2,
    "GroupId": "Beverages",
    "OperatorId": 12345,
    "Region": "string",
    "City": "string",
    "ZipCode": 10001,
    "Country": {
      "Name": "United States of America",
      "NumericCode": 840,
      "Alpha2Code": "US",
      "Alpha3Code": "USA"
    },
    "GeoLocation": {
      "State": "string",
      "City": "string",
      "CountryCode": "string",
      "ZipCode": "string",
      "Address": "string",
      "Longitude": 34.998819,
      "Latitude": 32.8198988
    }
  },
  "ActorInfo": {
    "Id": 2001102296,
    "Name": "Far East Dev Zone",
    "OperatorId": 2000305191,
    "OperatorName": "TanyaT_OP",
    "MerchantId": 10011,
    "Country": {
      "Name": "string",
      "NumericCode": "string",
      "Alpha2Code": "string",
      "Alpha3Code": "string"
    },
    "GeoLocation": {
      "State": "string",
      "City": "string",
      "CountryCode": "string",
      "ZipCode": "string",
      "Address": "string",
      "Longitude": 34.998819,
      "Latitude": 32.8198988
    }
  },
  "CustomData": {
    "DirectActor": 12312312,
    "Operator": 123121434134,
    "Distributor": "superDistributor",
    "Actor": 12312312,
    "Machine": 131231348
  },
  "CardData": {
    "CardNumber": "string",
    "EntryMode": "string",
    "ExpYear": "string",
    "ExpMonth": "string",
    "EMVData": "string",
    "IDNumber": "string",
    "RandomNumber": "string",
    "BrandInfo": {
      "PrimaryId": "string",
      "PrimaryDescription": "string",
      "SecondaryId": "string",
      "SecondaryDescription": "string"
    },
    "CardHolderName": "Test Card Holder"
  },
  "PaymentInfo": {
    "SrvTranId": 2.3658433596983443e+35,
    "AuthCode": 333333,
    "AuthAmount": 0.1,
    "SettAmount": 0.1,
    "RRN": 111111,
    "Token": "string",
    "AuthDateTime": 230221101008,
    "SettDateTime": 230221101009,
    "TraceNumber": 4444,
    "AuthSource": 555555,
    "AdditionalData": "string",
    "IsGatewayTimeout": true
  }
}
```

### 请求参数

下表描述了请求正文中包含的参数：

<Accordion title="参考字段">
  <table>
    <thead>
      <tr>
        字段
        类型
        描述
      </tr>
    </thead>

    <tbody>
      <tr>
        `ReasonCode`
        `Int(16)`

        <td style={{ textAlign: "left" }}>
          有效的取消或拒绝代码:

          <ul>
            1:余额不足
            2:交易 ID 未知
            3:持卡人超出每日/每周/每月交易次数限制
            4:持卡人超出交易金额限制
            5:疑似欺诈
            6:一般系统故障
            7:金额无效
            8/998:请求无法解析(格式错误)/验证错误
            9:不允许该持卡人进行此交易
            40:仅供 Nayax 内部使用。
            990:未找到 CertificateFileName
            991:消息正文解密失败
            992:超时异常
            994:不支持的卡品牌
            996:交易 ID 未知/交易 ID 重复(启动会话错误)
            997:缺少必填参数
            999:一般异常
            1010:未找到公钥证书
            1011:方法未实现
          </ul>
        </td>
      </tr>

      <tr>
        `ReasonText`
        `String`

        <td style={{ textAlign: "left" }}>
          与 `ReasonCode` 对应的文字说明。
        </td>
      </tr>

      <tr>
        `TransactionId`
        `String(36)`

        <td style={{ textAlign: "left" }}>
          此交易的**唯一标识符**。

          <ul>
            如果使用了 `/StartSession`，则回显其中的加密 ID。
            否则，该值由 Nayax Engine 生成。
          </ul>
        </td>
      </tr>

      <tr>
        `NayaxTransactionId`
        `Int(64)`

        <td style={{ textAlign: "left" }}>
          **Nayax 内部交易的唯一 ID** ，在后续请求中会重复出现。
        </td>
      </tr>

      <tr>
        `Amount`
        `Double`

        <td style={{ textAlign: "left" }}>
          **付款金额**（以美分为单位，最多保留 3 位小数）。

          <ul>
            示例:1 分 = `0.01`。
            注意:没有小数位的货币(例如 JYN)仍以双精度浮点数表示(例如 `234.0`)。
          </ul>
        </td>
      </tr>

      <tr>
        `CurrencyCode`
        `String(3)`

        <td style={{ textAlign: "left" }}>
          以 ISO 4217 三位字母格式表示的货币代码。
        </td>
      </tr>

      <tr>
        `CurrencyNumeric`
        `String(3)`

        <td style={{ textAlign: "left" }}>
          ISO 4217 数字 3 位格式的货币代码。
        </td>
      </tr>

      <tr>
        `SiteId`
        `Int(16)`

        <td style={{ textAlign: "left" }}>
          Nayax 服务器区域标识符。
        </td>
      </tr>

      <tr>
        `MachineAuTime`
        `String`

        <td style={{ textAlign: "left" }}>
          机器授权时间戳。
        </td>
      </tr>

      <tr>
        `TimeoutMS`
        `Int(32)`

        <td style={{ textAlign: "left" }}>
          Nayax 服务器超时配置（单位：毫秒）。
        </td>
      </tr>

      <tr>
        `IsProductSelected`
        `Bool`

        <td style={{ textAlign: "left" }}>
          表示产品在支付流程开始之前是否已被预先选定。
        </td>
      </tr>

      <tr>
        `HwSerial`
        `String`

        <td style={{ textAlign: "left" }}>
          Nayax 设备**硬件序列号**。
        </td>
      </tr>

      <tr>
        `FWVersion`
        `String`

        <td style={{ textAlign: "left" }}>
          设备固件版本。
        </td>
      </tr>

      <tr>
        `Type`
        `String`

        <td style={{ textAlign: "left" }}>
          Nayax 设备类型。
        </td>
      </tr>

      <tr>
        `Id`
        `Int(64)`

        <td style={{ textAlign: "left" }}>
          在 Nayax 后台分配的机器实体唯一 ID。
        </td>
      </tr>

      <tr>
        `Name`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          在 Nayax 后台中定义的机器名称。
        </td>
      </tr>

      <tr>
        `TerminalId`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          **终端标识符**。请联系 Nayax TPOC 进行定义。
        </td>
      </tr>

      <tr>
        `DecimalPlace`
        `Int(64)`

        <td style={{ textAlign: "left" }}>
          此机器所用金额的小数点位置。

          <ul>
            示例:值为 `2` 表示金额形式如 123.45。
          </ul>
        </td>
      </tr>

      <tr>
        `Offset`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          UTC 时区偏移量。
        </td>
      </tr>

      <tr>
        `GroupId`
        `String`

        <td style={{ textAlign: "left" }}>
          仅供 Nayax 内部使用。
        </td>
      </tr>

      <tr>
        `OperatorId`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          在 Nayax 后台中定义的商户 ID(字符串格式)。
        </td>
      </tr>

      <tr>
        `Region`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          在 Nayax 后台中定义的地区。
        </td>
      </tr>

      <tr>
        `City`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          在 Nayax 后台中定义的机器所在城市。
        </td>
      </tr>

      <tr>
        `ZipCode`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          在 Nayax 后台中定义的机器邮政编码。
        </td>
      </tr>

      <tr>
        `Name`
        `String`

        <td style={{ textAlign: "left" }}>
          国家**全称**。
        </td>
      </tr>

      <tr>
        `NumericCode`
        `String(3)`

        <td style={{ textAlign: "left" }}>
          ISO-3166-1 Numeric-3 代码。
        </td>
      </tr>

      <tr>
        `Alpha2Code`
        `String(2)`

        <td style={{ textAlign: "left" }}>
          ISO-3166-1 Alpha-2 代码。
        </td>
      </tr>

      <tr>
        `Alpha3Code`
        `String(3)`

        <td style={{ textAlign: "left" }}>
          ISO-3166-1 Alpha-3 代码。
        </td>
      </tr>

      <tr>
        `State`
        `String`

        <td style={{ textAlign: "left" }}>
          演员地理位置**代码**。
        </td>
      </tr>

      <tr>
        `City`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          演员地理**城市**。
        </td>
      </tr>

      <tr>
        `CountryCode`
        `String`

        <td style={{ textAlign: "left" }}>
          演员地理位置**国家代码（ISO3）** 。
        </td>
      </tr>

      <tr>
        `ZipCode`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          演员地理位置**邮政编码**。
        </td>
      </tr>

      <tr>
        `Address`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          演员地理位置**地址**。
        </td>
      </tr>

      <tr>
        `Longitude`
        `String`

        <td style={{ textAlign: "left" }}>
          机器位置**经度**。
        </td>
      </tr>

      <tr>
        `Latitude`
        `String`

        <td style={{ textAlign: "left" }}>
          机器位置**纬度**。
        </td>
      </tr>

      <tr>
        `Id`
        `Int(64)`

        <td style={{ textAlign: "left" }}>
          Actor ID(直接商户/运营商)。
        </td>
      </tr>

      <tr>
        `Name`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          直接商户名称。
        </td>
      </tr>

      <tr>
        `OperatorId`
        `Int(64)`

        <td style={{ textAlign: "left" }}>
          **商户运营商 ID** （整数格式）。
        </td>
      </tr>

      <tr>
        `OperatorName`
        `String`

        <td style={{ textAlign: "left" }}>
          商户运营商名称。
        </td>
      </tr>

      <tr>
        `MerchantId`
        `Int(64)`

        <td style={{ textAlign: "left" }}>
          **商户 ID** 。请联系 Nayax TPOC 进行定义。
        </td>
      </tr>

      <tr>
        `Name`
        `String`

        <td style={{ textAlign: "left" }}>
          国家**全称**。
        </td>
      </tr>

      <tr>
        `NumericCode`
        `String(3)`

        <td style={{ textAlign: "left" }}>
          ISO-3166-1 Numeric-3 代码。
        </td>
      </tr>

      <tr>
        `Alpha2Code`
        `String(2)`

        <td style={{ textAlign: "left" }}>
          ISO-3166-1 Alpha-2 代码。
        </td>
      </tr>

      <tr>
        `Alpha3Code`
        `String(3)`

        <td style={{ textAlign: "left" }}>
          ISO-3166-1 Alpha-3 代码。
        </td>
      </tr>

      <tr>
        `State`
        `String`

        <td style={{ textAlign: "left" }}>
          演员地理位置**代码**。
        </td>
      </tr>

      <tr>
        `City`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          演员地理**城市**。
        </td>
      </tr>

      <tr>
        `CountryCode`
        `String`

        <td style={{ textAlign: "left" }}>
          演员地理位置**国家代码（ISO3）** 。
        </td>
      </tr>

      <tr>
        `ZipCode`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          演员地理位置**邮政编码**。
        </td>
      </tr>

      <tr>
        `Address`
        `String(255)`

        <td style={{ textAlign: "left" }}>
          演员地理位置**地址**。
        </td>
      </tr>

      <tr>
        `Latitude`
        `String`

        <td style={{ textAlign: "left" }}>
          机器位置**纬度**。
        </td>
      </tr>

      <tr>
        `Longitude`
        `String`

        <td style={{ textAlign: "left" }}>
          机器位置**经度**。
        </td>
      </tr>

      <tr>
        `DirectActor`
        `String`

        <td style={{ textAlign: "left" }}>
          直接演员**自定义数据**（ **JSON 格式**的字符串）。
        </td>
      </tr>

      <tr>
        `Operator`
        `String`

        <td style={{ textAlign: "left" }}>
          操作员**自定义数据**（ **JSON 格式**的字符串）。
        </td>
      </tr>

      <tr>
        `Distributor`
        `String`

        <td style={{ textAlign: "left" }}>
          分销商**自定义数据**（ **JSON 格式**的字符串）。
        </td>
      </tr>

      <tr>
        `Actor`
        `String`

        <td style={{ textAlign: "left" }}>
          演员**自定义数据**（ **JSON 格式**的字符串）。
        </td>
      </tr>

      <tr>
        `Machine`
        `String`

        <td style={{ textAlign: "left" }}>
          机器**自定义数据**（ **JSON 格式**的字符串）。
        </td>
      </tr>

      <tr>
        `CardNumber`
        `String`

        <td style={{ textAlign: "left" }}>
          根据交易类型提供的卡片信息：

          <ul>
            对于卡在场的 Authorization/Sale,为完整的 Track 2 数据。
            对于其他交易类型(例如 Refund、Settlement),仅为卡的 PAN。
          </ul>

          **注意：** 卡片详细信息使用设备读取卡片时的相同格式。对于 Mifare 卡,Track 2 数据为十六进制。对于磁条卡,Track 2 数据为 ASCII。
        </td>
      </tr>

      <tr>
        `EntryMode`
        `String(4)`

        <td style={{ textAlign: "left" }}>
          卡片信息的读取方式：

          <ul>
            MCR:磁条读取(刷卡)
            CON:接触式芯片读取(插卡)
            CLS:非接触式芯片读取(轻触)
            NFC:手机/移动设备非接触式读取(手机轻触)
            QR:通过 QR 码读取卡号
            如有特殊情况,请咨询 Nayax POC。
          </ul>
        </td>
      </tr>

      <tr>
        `ExpYear`
        `String`

        <td style={{ textAlign: "left" }}>
          卡片到期年份（ **YY**格式）。**条件性**（仅当接口为 1 或 10 时）。
        </td>
      </tr>

      <tr>
        `ExpMonth`
        `String`

        <td style={{ textAlign: "left" }}>
          卡片到期月份（ **MM**格式）。**条件性**（仅当接口为 1 或 10 时）。
        </td>
      </tr>

      <tr>
        `EMVData`
        `String`

        <td style={{ textAlign: "left" }}>
          EMV标签数据采用**TLV（标签长度-值）格式**。
        </td>
      </tr>

      <tr>
        `IDNumber`
        `String`

        <td style={{ textAlign: "left" }}>
          持卡人**ID号码**。
        </td>
      </tr>

      <tr>
        `RandomNumber`
        `String`

        <td style={{ textAlign: "left" }}>
          暂无更多信息。
        </td>
      </tr>

      <tr>
        `PrimaryId`
        `String`

        <td style={{ textAlign: "left" }}>
          主要品牌 ID。
        </td>
      </tr>

      <tr>
        `PrimaryDescription`
        `String`

        <td style={{ textAlign: "left" }}>
          主要品牌描述。
        </td>
      </tr>

      <tr>
        `SecondaryId`
        `String`

        <td style={{ textAlign: "left" }}>
          次要品牌 ID。
        </td>
      </tr>

      <tr>
        `SecondaryDescription`
        `String`

        <td style={{ textAlign: "left" }}>
          次要品牌描述。
        </td>
      </tr>

      <tr>
        `CardHolderName`
        `String`

        <td style={{ textAlign: "left" }}>
          持卡人姓名。
        </td>
      </tr>

      <tr>
        `SrvTranId`
        `String`

        <td style={{ textAlign: "left" }}>
          **集成商的内部交易 ID** 。

          <ul>
            条件性字段:仅当未使用 `/StartSession` 时为必填项。
            若已使用,该字段应为空,或回传交易 ID。
          </ul>
        </td>
      </tr>

      <tr>
        `AuthCode`
        `String(40)`

        <td style={{ textAlign: "left" }}>
          **外部授权码**（通常来自发卡行的银行）。
        </td>
      </tr>

      <tr>
        `AuthAmount`
        `Double`

        <td style={{ textAlign: "left" }}>
          在 `/Authorization` 请求中请求的原始金额。
        </td>
      </tr>

      <tr>
        `SettAmount`
        `Double`

        <td style={{ textAlign: "left" }}>
          `/Settlement` 或 `/Sale` 流程中请求的原始金额。与 Authorization 无关。
        </td>
      </tr>

      <tr>
        `RRN`
        `String`

        <td style={{ textAlign: "left" }}>
          参考检索号(Reference Retrieval Number)。强烈建议对最终消费者/持卡人可见。
        </td>
      </tr>

      <tr>
        `Token`
        `String(256)`

        <td style={{ textAlign: "left" }}>
          该交易的唯一令牌。仅供 Nayax 内部使用。
        </td>
      </tr>

      <tr>
        `AuthDateTime`
        `String`

        <td style={{ textAlign: "left" }}>
          `/Authorization` 发生的日期和时间字符串。格式：`ddMMyyHHmmss`。
        </td>
      </tr>

      <tr>
        `SettDateTime`
        `Double`

        <td style={{ textAlign: "left" }}>
          结算日期/时间。与授权无关。
        </td>
      </tr>

      <tr>
        `TraceNumber`
        `String`

        <td style={{ textAlign: "left" }}>
          跟踪号(Trace number)。仅供 Nayax 内部使用。
        </td>
      </tr>

      <tr>
        `AuthSource`
        `String(5)`

        <td style={{ textAlign: "left" }}>
          仅供 Nayax 内部使用。
        </td>
      </tr>

      <tr>
        `AdditionalData`
        `String`

        <td style={{ textAlign: "left" }}>
          附加数据字符串， **JSON 格式**。请联系 Nayax TPOC 进行定义。
        </td>
      </tr>

      <tr>
        `IsGatewayTimeout`
        `Bool`

        <td style={{ textAlign: "left" }}>
          指示是否发生**网关超时**（响应中有效）。
        </td>
      </tr>
    </tbody>
  </table>
</Accordion>

## 回复

客户的支付方式发送给 Nayax 服务器的 Cancel 响应。有效负载应如下所示:

```json theme={null}
{
  "Status": {
    "Verdict": "Approved",
    "Code": 0,
    "StatusMessage": "string"
  },
  "Balance": {
    "RegularCreditType": 0,
    "RegularCredit": 0,
    "RevalueCredit": 0
  }
}
```

### 响应参数

下表描述了 API 响应中返回的字段：

<Accordion title="参考字段">
  <table>
    <thead>
      <tr>
        字段
        类型
        描述
      </tr>
    </thead>

    <tbody>
      <tr>
        `Verdict`
        String

        <td style={{ textAlign: "left" }}>
          请求的最终状态。必须是以下常量字符串值之一：

          <ul>
            <li>**`Approved`**</li>
            <li>**`Declined`**</li>
          </ul>
        </td>
      </tr>

      <tr>
        `Code`
        Int(32)

        <td style={{ textAlign: "left" }}>
          拒绝代码（Decline Code）。条件性字段——仅当 `Verdict` 为 “Declined” 时才会出现。有效的拒绝代码包括：

          <ul>
            1:余额不足
            2:交易 ID 未知
            3:持卡人超出交易次数限制
            4:持卡人超出交易金额限制
            5:疑似欺诈
            6:一般系统故障
            7:金额无效
            8:请求无法解析(格式错误)
            9:不允许该持卡人进行此交易
            40:仅供 Nayax 内部使用。
            990:未找到 CertificateFileName
            991:消息正文解密失败
            992:超时异常
            994:不支持的卡品牌
            996:交易 ID 未知/交易 ID 重复(启动会话错误)
            997:缺少必填参数
            998:验证/请求无法解析
            999:一般异常
            1010:未找到公钥证书
            1011:方法未实现
          </ul>
        </td>
      </tr>

      <tr>
        `StatusMessage`
        String(255)

        <td style={{ textAlign: "left" }}>
          包含**交易状态消息**或有关结果的其他不同数据的自由文本字段。
        </td>
      </tr>

      <tr>
        `RegularCreditType`
        Int(32)

        <td style={{ textAlign: "left" }}>
          定义 `RegularCredit` 的计量单位（枚举值）：

          <ul>
            0：信用额度以交易次数计（count）。
            1：信用额度以金额计（currency）。
          </ul>
        </td>
      </tr>

      <tr>
        `RegularCredit`
        Double

        <td style={{ textAlign: "left" }}>
          根据 `RegularCreditType` 计算的常规信用额度值（金额或交易次数）。使用小数位数 2。
        </td>
      </tr>

      <tr>
        `RevalueCredit`
        Int(32)

        <td style={{ textAlign: "left" }}>
          充值金额。

          <ul>
            仅当关联卡配置为可充值时才存在。
            使用 2 位小数。
          </ul>
        </td>
      </tr>
    </tbody>
  </table>
</Accordion>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.