--- title: "Cortina Credit Card Incremental Auth" method: POST path: "/Cortina/CreditCard/IncrementalAuth" tags: ["Cortina Credit Card"] --- # Cortina Credit Card Incremental Auth `POST /Cortina/CreditCard/IncrementalAuth` ## Request body - CCSettRequest - `BasicInfo` BasicInfo — Basic transaction information. - `AgeLimitation` integer — Minimum age required for transaction approval. - `Amount` number, double, required — Transaction amount. Use decimal format (e.g. 0.01 for 1 cent). Currencies without decimal places should also be expressed as a double (e.g. 234.0). - `AuditNumber` integer — For internal Nayax use. - `BillingProviderId` integer — ID of the billing provider (assigned by Nayax). - `CurrencyCode` string, required — ISO 4217 currency code in Alpha-3 format (e.g. USD, EUR, ILS). - `CurrencyNumeric` string, required — ISO 4217 currency code in Numeric-3 format. - `IsDeferredAuthorization` boolean — Indicates whether the authorization is deferred. - `IsProductSelected` boolean — Indicates whether a product was pre-selected before payment. - `IsSoftDeclineCompletion` boolean — Indicates whether the transaction was completed after a soft decline. - `MachineAuTime` string — Timestamp of machine authorization (DDMMYYHHMMSS). - `NayaxRRN` string — Reference number for external identification. Should be visible to the end-user or external parties (e.g. card issuer, app provider). Echoed in `/Inquiry` requests. - `NayaxTransactionId` integer — Internal Nayax ID used to track the transaction in future requests. - `PaymentMethodID` integer — ID of the payment method provider (assigned by Nayax). - `SiteId` integer — Region identifier for the Nayax server. - `TimeoutMS` integer — Server timeout in milliseconds. - `TransactionId` string, required — Unique identifier for the transaction. - If `/StartSession` was used, this echoes the encrypted transaction ID (`TranIDCipher`). - If not, the Nayax engine generates this value. - `TransitElement` TransitElement — Transit Element Information - `DenyListIndication` 0 | 1 | 2 — * 0 - unknown/ no effect * 1 - Decline will cause consumer to be added to the deny list * 2 - Approval shall cause the consumer to be removed from deny list. - `TransitTransactionType` 1 | 2 | 3 | 7 — * 1 - Prefunded * 2 - Realtime Authorization * 3 - Post-Authorization Aggregated Transaction * 7 - Debt Recovery - `DeviceInfo` DeviceInfo — Hardware and firmware information of the Nayax device. - `FWVersion` string — Firmware version installed on the device. - `HwSerial` string — Hardware serial number of the Nayax device. - `Type` string — Device type as defined in the Nayax system. - `MachineInfo` MachineInfo — Contains basic information about a machine, including identifiers, location details, and configuration settings. - `MachineID` integer, nullable — The unique identifier of the machine. - `ActorID` integer, nullable — The identifier of the actor associated with the machine. - `CountryID` integer, nullable — The identifier of the country where the machine is located. - `CurrencyID` integer, nullable — The identifier of the currency used by the machine. - `InstituteID` integer, nullable — The identifier of the institute associated with the machine. - `LocationID` integer, nullable — The identifier of the location where the machine is installed. - `MachineGroupID` integer, nullable — The identifier of the group to which the machine belongs. - `MachineModelID` integer, nullable — The identifier of the machine's model. - `MachineName` string, nullable — The name of the machine. - `MachineNumber` string, nullable — The serial number or unique identifier assigned to the machine by the manufacturer. - `MachineStatusBit` integer — A bit field indicating the status of the machine. - `LanguageID` unknown - `OperatorActorID` integer, nullable — The identifier of the operator managing the machine. - `DistributorActorID` integer, nullable — The identifier of the distributor associated with the machine. - `AreaActorID` integer, nullable — The identifier of the area actor responsible for the machine. - `SalesSourceID` integer, nullable — The identifier of the sales source associated with the machine. - `MachineTypeID` 555001 | 555002 | 555003 | 555004 | 555005 | 555006 | 555007 | 555008 | 556017 | 556018 | 30000514 | 30000515 | 30000516 | 30000517 | 30000518 | 30000519 | 30000520 | 30000521 | 30000522 | 30000523 | 30000524 | 30000525 | 30000526 | 30000527 | 30000561 | 30000578 | 30000579 | 30000580 | 30000581 | 30000582 | 30000583 | 30000602 | 30000611 | 30000612 | 30000617 | 30000618 | 30000619 | 30000620 | 30000623 | 176649542 | 227707459 | 227707460 | 504059468 | 529079224 | 363311433 | 244797254 - `SerialNumber` string, nullable — The serial number of the machine. - `VPOSSerialNumber` string, nullable — The VPOS serial number associated with the machine. - `DeviceSerialNumber` string, nullable — The serial number of the device installed in the machine. - `VPOSID` integer, nullable — The unique identifier of the VPOS device associated with the machine. - `DeviceID` integer, nullable — The unique identifier of the device installed in the machine. - `UseLocationFrom` integer, nullable — Specifies where the location information is sourced from. - `GeoCountry` integer, nullable — The country identifier based on geographic data. - `GeoState` string, nullable — The state or region based on geographic data. - `GeoCity` string, nullable — The city based on geographic data. - `GeoAddress` string, nullable — The full address based on geographic data. - `GeoStreetNumber` string, nullable — The street number based on geographic data. - `GeoLongitude` number, double, nullable — The geographic longitude where the machine is located. - `GeoLatitude` number, double, nullable — The geographic latitude where the machine is located. - `GeoZoom` integer, nullable — The zoom level for geographic data representation. - `GeoZipCode` string, nullable — The postal or ZIP code based on geographic data. - `SearchAddress` string, nullable — The address used for search purposes. - `Remarks` string, nullable — Additional remarks or notes about the machine. - `DexType` integer, nullable — The DEX type identifier. - `DexMidnightReadsEnableBit` boolean, nullable — Indicates if midnight DEX reads are enabled. - `DexG85CheckEnableBit` boolean, nullable — Indicates if the G85 check for DEX is enabled. - `DexDivideBillsBy` integer, nullable — The value by which DEX bills are divided. - `DexG85CheckParsingFilterEnableBit` boolean, nullable — Indicates if the parsing filter for DEX G85 check is enabled. - `UseCardPriceCorrectCashPriceBit` boolean, nullable — Indicates if card prices are used to correct cash prices. - `MachineTimeZoneOffset` number, double, nullable — The time zone offset for the machine. - `DexReadInterval` integer, nullable — The interval at which DEX reads occur. - `LocationType` integer, nullable — The identifier of the location type. - `ApplyDisplayPickListSelectionsToReportsBit` boolean, nullable — Indicates if picklist selections should be applied to reports. - `DisplayPickListSelectionsAs` integer, nullable — Specifies how picklist selections are displayed. - `LastUpdated` string, date-time, nullable — The date and time when the machine information was last updated. - `MachineProfile` integer, nullable — The identifier of the machine profile. - `CityID` integer, nullable — The identifier of the city where the machine is located. - `RegionID` integer, nullable — The identifier of the region where the machine is located. - `CountryDialingCode` integer, nullable — The dialing code for the country where the machine is located. - `DexIgnoreCRCCheckBit` boolean, nullable — Indicates if CRC checks are ignored in DEX. - `DexParseLABit` boolean, nullable — Indicates if the DEX LA parsing is enabled. - `ProductMapID` integer, nullable — The identifier of the product map associated with the machine. - `Longitude` number, double, nullable — The geographic longitude where the machine is located. - `Latitude` number, double, nullable — The geographic latitude where the machine is located. - `DexTotalSalesMinusCardSalesBit` boolean, nullable — Indicates if total sales should exclude card sales in DEX. - `RouteActorID` integer, nullable — The identifier of the route actor managing the machine. - `MachineLogicAlertEnableBit` boolean, nullable — Indicates if machine logic alerts are enabled. - `AlertRuleSetId` integer, nullable — The identifier of the alert rule set associated with the machine. - `MachineMemberTypePricingEnableBit` boolean, nullable — Indicates if member type pricing is enabled for the machine. - `DexMultiplyCoinsBy` integer, nullable — The value by which DEX coins are multiplied. - `DexMultiplyTubesBy` integer, nullable — The value by which DEX tubes are multiplied. - `CustomerID` integer, nullable — The unique identifier of the customer associated with the machine. - `CommissionType` integer, nullable — The type of commission applied to the machine. - `CommissionDefaultValue` number, double, nullable — The default commission value applied to the machine. - `CreatedBy` integer, nullable — The unique identifier of the user who created the machine entry. - `CreatedOn` string, date-time, nullable — The date and time when the machine entry was created. - `UpdateBy` integer, nullable — The unique identifier of the user who last updated the machine entry. - `TubeSource` integer, nullable — The source of the tube data for the machine. - `BillSource` integer, nullable — The source of the bill data for the machine. - `SmartStickerId` integer, nullable — The identifier of the smart sticker associated with the machine. - `EnableRemoveVendBit` boolean, nullable — Indicates if the remove vend functionality is enabled. - `EnableEreceiptBit` boolean, nullable — Indicates if the e-receipt functionality is enabled. - `ProductMapAutomaticCreationBit` boolean, nullable — Indicates if the product map is automatically created. - `Refs` object, nullable — Additional references associated with the machine. - `ActorInfo` ActorInfo — Merchant (Actor) details. - `Country` CountryInfo — Actor and Machine Country information - `Alpha2Code` string — String(2) Mandatory ISO-3166-1 format: Alpha-2 code - `Alpha3Code` string — String(3) Mandatory ISO-3166-1 format: Alpha-3 code - `Intra` string — String Mandatory An Intra Region refers to a geographical diversification across countries within a single 'Intra region'. E.g. 'France' is country within the 'European Union' Intra Region. - `Name` string — String Mandatory Country Full Name - `NumericCode` string — String(3) Mandatory ISO-3166-1 format: Numeric-3 code - `DynamicURL` string — Optional URL configuration at the actor level. Supports dynamic URLs. - Max length: 255. - `GeoLocation` GeoLocation — Actor and Machine Geo location information - `Address` string — String(255) Optional Address as defined in the Nayax backoffice - `City` string — - String(255) - Optional - City as defined in the Nayax backoffice - `CountryCode` string — String Optional Country code (ISO3) as defined in the Nayax backoffice - `Latitude` number, double — - Machine Location Latitude as defined in the Nayax backoffice - `Longitude` number, double — - Machine Location Longitude as defined in the Nayax backoffice - `State` string — - String - Optional - Actor geo state code as defined in the Nayax backoffice - `ZipCode` string — String(255) Optional Zip code defined in the Nayax backoffice - `Id` integer — Unique ID of the actor (merchant) as defined in the Nayax backoffice. - `MCC` integer — Merchant Category Code (MCC), classifies businesses by type of goods or services provided. - `MerchantId` string — Merchant identifier as defined in the Nayax backoffice. Contact Nayax to configure. - Max length: 255. - `Name` string — Merchant name as registered in the Nayax backoffice. Max length: 255. - `OperatorId` integer — ID of the operator associated with the merchant. Max length: 255. - `OperatorName` string — Name of the operator associated with the merchant. Max length: 255. - `SubMerchantId` string — Identifier for a sub-merchant under the main merchant. Contact Nayax to configure. Max length: 255. - `CustomData` CustomData — Custom Fields Information, Contact Nayax TPOC to define. - `Actor` string — Actor custom data (String in json format) - `DirectActor` string — Direct actor custom data (String in json format) - `Distributor` string — Distributor custom data (String in json format) - `Machine` string — Machine custom data (String in json format) - `Operator` string — Operator custom data (String in json format) - `SoftDecline` string — Soft Decline custom data (String in json format) - `CardData` CardData — Additional data we read from the card (EMV data, expiration date, cvv2, etc.) - `BrandInfo` CardBrandInfo - `PrimaryDescription` string — Primary Brand Description - `PrimaryId` string — Primary Brand Id - `SecondaryDescription` string — Secondary Brand Description - `SecondaryId` string — Secondary Brand Id - `CVV2` string — Optional, cvv2 - `CardHolderName` string — Card Holder Name - `CardNumber` string — - String () - Mandatory - For card present Authorization and Sale, the full Track2 will be sent in this field. - For card not present, Settlement, Cancel, Void, Refund - The card PAN only will be sent. - `EMVData` string — String of emv tags in TLV format - `EntryMode` string — String (4) Mandatory Optional Value: * MCR - Card number read from the card magnetic stripe. * CON - Card details read from the chip via the contact interface (insert). * CLS - Card details read from the chip via the contactless interface (tap). * NFC - Card details read from the phone via the contactless interface (phone tap). * CLM - Card track2 read from the chip via the contactless interface (contactless magstripe\\legacy mode). * MIF\\MIFH - MIFARE\\MIFARE received as Hexadecimal * QR - Card number read from a QR by the [DOT](https://www.nayax.com/solution/dot/) Other values may also be sent in specific edge case, for more information please consult your Nayax POC. - `ExpMonth` string — Conditional only when Interface is 1 or 10, (MM) - `ExpYear` string — Conditional only when Interface is 1 or 10, (YY) - `IDNumber` string — ID Number - `IsDebitCard` boolean — Indication if card is Debit or Prepaid - `RandomNumber` string - `Products` Product[] - `NayaxProductID` integer, nullable — The unique identifier for the product in the Nayax system. - `ProductGroupID` integer, nullable — The unique identifier of the product group to which the product belongs. - `ActorID` integer, nullable — The unique identifier of the actor associated with the product. - `ProductManufacturerID` integer, nullable — The unique identifier of the product's manufacturer. - `ProductName` string, nullable — The name of the product. - `ProductCatalogNumber` string, nullable — The catalog number assigned to the product. - `ProductBarcode` string, nullable — The barcode associated with the product. - `ProductPackageQuantity` integer, nullable — The quantity of product units per package. - `ProductDescription` string, nullable — A description of the product. - `ProductVolumeTypeID` integer, nullable — The volume type identifier associated with the product. - `DEXProductName` string, nullable — The name of the product in the DEX (Data Exchange) format. - `ProductCostPrice` number, double, nullable — The cost price of the product. - `ProductDefaultRetailPrice` number, double, nullable — The default retail price of the product. - `ProductMinimumPickQTY` integer, nullable — The minimum quantity of the product that can be picked. - `ProductStatus` integer, nullable — The status of the product, typically representing availability. - `ProductCashPrice` number, double, nullable — The price of the product when paid with cash. - `ProductCreditCardPrice` number, double, nullable — The price of the product when paid with a credit card. - `ProductPrepaidCardPrice` number, double, nullable — The price of the product when paid with a prepaid card. - `ProductExternalPrepaidCardPrice` number, double, nullable — The price of the product when paid with an external prepaid card. - `ProductMemberTypePriceBit` boolean, nullable — Indicates if the product has member-type-specific pricing. - `ProductPictureURL` string, nullable — The URL of the product's picture. - `CaloriesPer100g` number, double, nullable — The number of calories per 100 grams of the product. - `CaloriesPerServing` number, double, nullable — The number of calories per serving of the product. - `EANCode` string, nullable — The European Article Number (EAN) code associated with the product. - `ProductCreatedBy` integer, nullable — The identifier of the user who created the product entry. - `ProductCreationDate` string, date-time, nullable — The date and time when the product was created. - `ProductUpdatedBy` integer, nullable — The identifier of the user who last updated the product entry. - `ProductLastUpdated` string, date-time, nullable — The date and time when the product was last updated. - `VatId` integer, nullable — The VAT (Value Added Tax) identifier associated with the product. - `SequenceNumber` integer, nullable — The sequence number of the product. - `AgeVerificationEnableBit` boolean, nullable — Indicates whether age verification is required for this product. - `DepositTypeID` integer, nullable — The type of container for deposit/return schemes. Can be one of the following values: Plastic bottle - 90001, Can - 90002, Reusable Glass bottle - 90003. - `DepositFee` number, double, nullable — Deposit amount for bottle/can return schemes (max 100.00). - `DepositTax` number, double, nullable — Tax percentage applied to the deposit amount (0-100). - `Refs` object, nullable — A map of additional references related to the product. - `PaymentInfo` PaymentInfo — Identifies transaction information and references. Included in all response messages for payment calls. When used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call. - `SrvTranId` string — Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request. - `AuthCode` string — External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values. - `AuthAmount` number, double — Original amount requested in `/Authorization` or `/Sale`. Optional in other cases. - `SettAmount` number, double — Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only. - `RRN` string — Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response. - `Token` string — Unique token for the transaction. For internal Nayax use only. - `AuthDateTime` string — Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss` - `SettDateTime` string — Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss` - `TraceNumber` string — Trace number. For internal Nayax use only. - `AdditionalData` string — Optional custom data in JSON format. Contact Nayax to configure. - `IsGatewayTimeout` boolean — Indicates whether there was a gateway timeout. - `ProviderExternalData` string — External data from provider in JSON format. - `InitiateTranReference` integer — References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction. - `IsRevalueCard` boolean — Indicates whether the card supports revalue. - `EncryptInfo` EncryptInfo — Contains encryption metadata used for secure transmission. - `CertificateFileName` string — Name of the certificate file used for encryption (filename only, without path). - `EncryptedMessage` string — Encrypted JSON message payload. - `EncryptedSessionKey` string — AES session key encrypted with the recipient's public key. - `RandomNumber` string — Random number generated for encryption operations. ## Response `200` Success - CCSettResponse - `Batch` Batch - `AddToBatch` boolean — Denote on whether to add to the batch - `BatchId` integer — Batch id relevant to the transaction - `BatchStatus` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 99 — * 0 - Missing * 1 - Open * 2 - InProgress * 3 - Close * 4 - Reopen * 5 - Closed * 6 - Declined * 99 - Unknown - `BatchTransactionId` string — The transaction id inside the batch (id) - `DeleteFromBatch` boolean — Denote on whether to delete from batch - `OperationToPerform` 1 | 3 — * 1 - Open * 3 - Close - `PaymentInfo` PaymentInfo — Identifies transaction information and references. Included in all response messages for payment calls. When used in requests (e.g. `/Settlement`, `/Void`, `/Refund`, `/Inquiry`), this object should match the `PaymentInfo` returned in a previous call. - `SrvTranId` string — Integrator's internal transaction ID. Use only if `/StartSession` was not used. If `/StartSession` was used, this should be empty or echo the transaction ID from the request. - `AuthCode` string — External authorization code (usually from the card issuer). In dynamic QR, the approval code from the `/Inquiry` response overrides previous values. - `AuthAmount` number, double — Original amount requested in `/Authorization` or `/Sale`. Optional in other cases. - `SettAmount` number, double — Final settled amount, used in `/Settlement`, `/Inquiry`, or `/Sale`. In Cortina External Prepaid, this may reflect a discounted amount and is used for reporting only. - `RRN` string — Reference Retrieval Number. Should be visible to the cardholder and match the one in the `/GenerateQR` response. - `Token` string — Unique token for the transaction. For internal Nayax use only. - `AuthDateTime` string — Date and time of the `/Authorization` or `/Sale`. Format: `ddMMyyHHmmss` - `SettDateTime` string — Date and time of the `/Settlement` or `/Sale`. Format: `ddMMyyHHmmss` - `TraceNumber` string — Trace number. For internal Nayax use only. - `AdditionalData` string — Optional custom data in JSON format. Contact Nayax to configure. - `IsGatewayTimeout` boolean — Indicates whether there was a gateway timeout. - `ProviderExternalData` string — External data from provider in JSON format. - `InitiateTranReference` integer — References the original Nayax transaction ID when reattempting a prepaid loyalty card transaction. - `IsRevalueCard` boolean — Indicates whether the card supports revalue. - `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 --- [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/versions/421f6f83c257/schema)