--- title: "ChargeSimple/Full" method: POST path: "/Api/iCreditRestApiService.svc/ChargeSimple/Full" --- # ChargeSimple/Full `POST /Api/iCreditRestApiService.svc/ChargeSimple/Full` ## Request body - object - `AddData` string, nullable — Send Additional Data to the Credit Card Company. **Length:** 1 to 20 **Default:** No - `AuthNum` string, nullable — Transaction Approval Number. ~ Usually used with J5 (on hold) charge. **Length:** 1 to 9 **Default:** No - `CardNum` string, required — The Credit Card Number. **Length:** 10 to 16 **Default:** No - `CreateToken` boolean, nullable — Create a Token for Future Use. ~ The token can be used only with the same iCredit user. **Default:** false - `CreditTerms` 1 | 6 | 8, nullable — Credit Terms of the Transaction Payments. **Options:** (1 = Single payment 6 = Multiple payments - Credit 8 = Multiple Payments - regular) **Default:** 1 - `Currency` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, nullable — The Charge Currency Type. **Options:** (1 = NIS 2 = USD 3 = EURO 4 = GBP 5 = AUD 6 = CAD 7 = CHF 8 = SEK 9 = DKK 10 = NOK) **Default:** 1 - `CustomerTransactionId` string, uuid — Existing Transaction identifier. **Format:** `UUID` **Default:** No - `Cvv2` string, nullable — Card Verification Value (CVV). ~ Will be mandatory checked according to the terminal permissions. **Length:** 3 to 4 **Default:** No - `ExpDate_YYMM` string, required — The Credit Card Validation Date (YYMM). **Length:** 4 **Default:** No - `FirstAmount` number, double, nullable — Amount for the First Payment (Multiple Payments). **Range:** 0.01 to 999999999.99 **Default:** No - `Id` string, nullable — The Credit Card Owner Israeli Id (by Custom Format). ~ Will be mandatory checked according to the terminal permissions. **Length:** 8-9 digits **Default:** No - `J5CustomerTransactionId` string, uuid, nullable — Transaction On Hold (J5) Identifier. ~ Use for charging the pending payment. ~ Combine with original AuthNum **Format:** `UUID` **Default:** No - `NumOfPayment` integer, nullable — Sets the Transaction Number of Payments. **Range:** 1 to 100 **Default:** 1 - `OrigCustomerTransactionId` string, uuid, nullable — Original Transaction Identifier. ~ Used for Apple Payment Refunds. **Default:** No - `ParamJ` 0 | 2 | 5, nullable — Transaction Param J Type. **Options:** (0 = Immediate transaction 2 = CC check + Create token 5 = Pending transaction) **Default:** 0 - `PreventDuplicates` boolean, nullable — Prevent Doubled Transactions. ~ Combine with RequestReference **Default:** false - `RequestReference` string, nullable — The Transaction Request Reference. ~ Combine with PreventDuplicates ~ Should be unique value **Length:** 2GB **Default:** No - `ThreeDSServerTransID` string, uuid — 3DS Transaction Identifier. **Format:** `UUID` **Default:** No - `Token` string, uuid, required — Credit Card Token (Instead of Credit Card Number). **Format:** `UUID` **Default:** No - `TransactionType` 1 | 11 | 51, nullable — The Transaction Type. **Options:** (1 = Charge 11 = Recurring Transaction 51 = Credit Refund) **Default:** 1 - `UniqueNum` string, nullable — Pass Extra Data to the Credit Card Company **Length:** 1 to 20 **Default:** No - `CreditboxToken` string, uuid, required — Credit Box Identifier. **Format:** `UUID` **Default:** No - `Amount` number, double, required — Transaction Amount. **Range:** 0.01 to 999999999.99 **Default:** No ## Response `200` Payment With Token was Successful - object - `AddData` string — Additional Data for the Transaction. - `Amount` number, double — Total Transaction Amount. - `ApprovalBy` integer — Transaction Approvin source. - `ApprovalReason` string — Reason for approval. - `AuthNum` string — Transaction Approval Number. - `CardHolderId` string — Cardholder Israeli Id. - `CardLabel` integer — Credit Card Label. - `CardName` string — Credit Card Type Name. - `CardNum` string — Encrypted Credit Card Number. - `CardProducer` integer — Credit Card Producer. - `ClubCode` string — Credit Card Club Code. - `CochavAmount` integer — Credit Card Stars Amount. - `Code` integer — Transaction Code. - `CreditTerms` integer — Transaction Mutiple Payments Type (Single or Multiple/Credit Payments). - `Currency` integer — Transaction Currency. - `CustomerTransactionId` string, uuid — The Transaction Identifier. - `DefrayelCompany` integer — The defrayal Company. - `ErrorMessage` string — Error Message Returned On the Transaction. - `ExpDate_MMYY` string — Expiration Date of the Credit Card (MMYY format). - `ExtraInformation` string — Additional Information Related to the Transaction. - `FileNum` string — File Number Associated with the Transaction. - `FirstAmount` number, double — First Payment Amount of the transaction. - `ForeignSign` integer — Foreign Credit Card Flag. - `NonFirstAmount` number, double — Constent Payment Amount. - `NumOfPayment` integer — Number of Multiple Payments. - `ParamJ` integer — Param J Flag (immediate/On Hold/Check Only). - `RegisterNum` integer — Number of Terminal Box Identifier. - `SerialNum` integer — Serial Number of Terminal Box. - `SolekSapak` string — Transaction Solek Sapak (Provider Number). - `SpType` string — Credit Card Type (Regular/Direct/Charged and Others). - `Status` integer — The Transaction Status (Received from Shva 0 = Success). - `TerminalName` string — Name of the Merchant Terminal. - `TerminalNum` string — Merchant Terminal Number. - `Token` string, uuid — The Credit Card Token Created. - `TransactionCurrency` string — Transaction Currency Name. - `TransactionDatetime` string — Date and Time of the Transaction. - `TransactionType` integer — Transaction Type (Imadiate/Recurring/Refund). - `UniqueNum` string — Unique Transaction Reference Number. - `Version` string — Shva System Version. ## Other responses - `400` — Request Error - `500` — Internal Server Error --- [API](https://skmtc.net/rivhit/apis/get-payment-url-22-12.md) · [All operations](https://skmtc.net/rivhit/apis/get-payment-url-22-12/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivhit/get-payment-url-22-12/versions/ed5261a52458/schema)