v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

ChargeSimple/Full

post/Api/iCreditRestApiService.svc/ChargeSimple/Full

Request body

AddDatastring nullable

Send Additional Data to the Credit Card Company.

Length: 1 to 20 Default: No

AuthNumstring nullable

Transaction Approval Number.

~ Usually used with J5 (on hold) charge. Length: 1 to 9 Default: No

CardNumstring required

The Credit Card Number.

Length: 10 to 16 Default: No

CreateTokenboolean nullable

Create a Token for Future Use.

~ The token can be used only with the same iCredit user. Default: false

CreditTerms1 | 6 | 8 nullable

Credit Terms of the Transaction Payments.

Options: (1 = Single payment 6 = Multiple payments - Credit 8 = Multiple Payments - regular) Default: 1

Currency1 | 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

CustomerTransactionIdstring uuid

Existing Transaction identifier.

Format: UUID Default: No

Cvv2string nullable

Card Verification Value (CVV).

~ Will be mandatory checked according to the terminal permissions. Length: 3 to 4 Default: No

ExpDate_YYMMstring required

The Credit Card Validation Date (YYMM).

Length: 4 Default: No

FirstAmountnumber double nullable

Amount for the First Payment (Multiple Payments).

Range: 0.01 to 999999999.99 Default: No

Idstring 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

J5CustomerTransactionIdstring uuid nullable

Transaction On Hold (J5) Identifier.

~ Use for charging the pending payment. ~ Combine with original AuthNum Format: UUID Default: No

NumOfPaymentinteger nullable

Sets the Transaction Number of Payments.

Range: 1 to 100 Default: 1

OrigCustomerTransactionIdstring uuid nullable

Original Transaction Identifier.

~ Used for Apple Payment Refunds. Default: No

ParamJ0 | 2 | 5 nullable

Transaction Param J Type.

Options: (0 = Immediate transaction 2 = CC check + Create token 5 = Pending transaction) Default: 0

PreventDuplicatesboolean nullable

Prevent Doubled Transactions.

~ Combine with RequestReference Default: false

RequestReferencestring nullable

The Transaction Request Reference.

~ Combine with PreventDuplicates ~ Should be unique value Length: 2GB Default: No

ThreeDSServerTransIDstring uuid

3DS Transaction Identifier.

Format: UUID Default: No

Tokenstring uuid required

Credit Card Token (Instead of Credit Card Number).

Format: UUID Default: No

TransactionType1 | 11 | 51 nullable

The Transaction Type.

Options: (1 = Charge 11 = Recurring Transaction 51 = Credit Refund) Default: 1

UniqueNumstring nullable

Pass Extra Data to the Credit Card Company

Length: 1 to 20 Default: No

CreditboxTokenstring uuid required

Credit Box Identifier.

Format: UUID Default: No

Amountnumber double required

Transaction Amount.

Range: 0.01 to 999999999.99 Default: No

Example request

{
  "AddData": "Additional information",
  "AuthNum": "123456",
  "CardNum": "458000*****00000",
  "CreateToken": true,
  "CreditTerms": 1,
  "Currency": 1,
  "CustomerTransactionId": "1627aea5-8e0a-4371-9022-9b504344e724",
  "Cvv2": "123",
  "ExpDate_YYMM": "2508",
  "FirstAmount": 100.5,
  "Id": "123456790",
  "J5CustomerTransactionId": "1627aea5-8e0a-4371-9022-9b504344e724",
  "NumOfPayment": 3,
  "OrigCustomerTransactionId": "1627aea5-8e0a-4371-9022-9b504344e724",
  "ParamJ": 5,
  "PreventDuplicates": true,
  "RequestReference": "abcdefg-&123456789",
  "ThreeDSServerTransID": "61bad37b-63ff-48ce-b25a-2551b2be7feb",
  "Token": "f48034b6-247e-4642-ba1e-6d72003bd7e9",
  "TransactionType": 1,
  "UniqueNum": "Any value",
  "CreditboxToken": "7196ca68-1658-4e9a-bb12-a20e0fc79827",
  "Amount": 10.5
}

Response

Payment With Token was Successful

AddDatastring

Additional Data for the Transaction.

Amountnumber double

Total Transaction Amount.

ApprovalByinteger

Transaction Approvin source.

ApprovalReasonstring

Reason for approval.

AuthNumstring

Transaction Approval Number.

CardHolderIdstring

Cardholder Israeli Id.

CardLabelinteger

Credit Card Label.

CardNamestring

Credit Card Type Name.

CardNumstring

Encrypted Credit Card Number.

CardProducerinteger

Credit Card Producer.

ClubCodestring

Credit Card Club Code.

CochavAmountinteger

Credit Card Stars Amount.

Codeinteger

Transaction Code.

CreditTermsinteger

Transaction Mutiple Payments Type (Single or Multiple/Credit Payments).

Currencyinteger

Transaction Currency.

CustomerTransactionIdstring uuid

The Transaction Identifier.

DefrayelCompanyinteger

The defrayal Company.

ErrorMessagestring

Error Message Returned On the Transaction.

ExpDate_MMYYstring

Expiration Date of the Credit Card (MMYY format).

ExtraInformationstring

Additional Information Related to the Transaction.

FileNumstring

File Number Associated with the Transaction.

FirstAmountnumber double

First Payment Amount of the transaction.

ForeignSigninteger

Foreign Credit Card Flag.

NonFirstAmountnumber double

Constent Payment Amount.

NumOfPaymentinteger

Number of Multiple Payments.

ParamJinteger

Param J Flag (immediate/On Hold/Check Only).

RegisterNuminteger

Number of Terminal Box Identifier.

SerialNuminteger

Serial Number of Terminal Box.

SolekSapakstring

Transaction Solek Sapak (Provider Number).

SpTypestring

Credit Card Type (Regular/Direct/Charged and Others).

Statusinteger

The Transaction Status (Received from Shva 0 = Success).

TerminalNamestring

Name of the Merchant Terminal.

TerminalNumstring

Merchant Terminal Number.

Tokenstring uuid

The Credit Card Token Created.

TransactionCurrencystring

Transaction Currency Name.

TransactionDatetimestring

Date and Time of the Transaction.

TransactionTypeinteger

Transaction Type (Imadiate/Recurring/Refund).

UniqueNumstring

Unique Transaction Reference Number.

Versionstring

Shva System Version.