ChargeSimple/Full

post https://testpci.rivhit.co.il/Api/iCreditRestApiService.svc/ChargeSimple/Full

Charge a Credit Card - With Full Data Response

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

AddData

string | null

Send Additional Data to the Defrial Company.

Length: 1 to 20
Default: No

AuthNum

string | null

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

Create a Token for Future Use.

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

CreditTerms

integer | null

Credit Terms of the Transaction Payments.

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

Currency

integer | null

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

uuid

Existing Transaction identifier.

Format: UUID
Default: No

Cvv2

string | null

Card Verification Value (CVV).

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

ExpDate_YYMM

string

The Credit Card Validation Date (YYMM).

Length: 4
Default: No

FirstAmount

double | null

Amount for the First Payment (Multiple Payments).

Range: 0.01 to 999999999.99
Default: No

string | null

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

uuid

Transaction On Hold (J5) Identifier.

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

NumOfPayment

integer | null

Sets the Transaction Number of Payments.

Range: 1 to 100
Default: 1

ParamJ

integer | null

Transaction Param J Type.

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

PreventDuplicates

boolean | null

Prevent Doubled Transactions.

~ Combine with RequestReference
Default: false

RequestReference

string | null

The Transaction Request Reference.

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

ThreeDSServerTransID

uuid

Credit Card Token (Instead of Credit Card Number).

Format: UUID
Default: No

Token

uuid

required

Credit Card Token (Instead of Credit Card Number).

Format: UUID
Default: No

Track2

string

required

Track2 Magnetic Credit Card Code (With EMV Device - Instead of Credit Card Number).

Length: 48 to 50
Default: No

TransactionType

integer | null

The Transaction Type.

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

UniqueNum

string | null

Pass Extra Data to the Credit Card Company

Length: 1 to 20
Default: No

CreditboxToken

uuid

required

Credit Box Identifier.

Format: UUID
Default: No

Amount

double

required

Transaction Amount.

Range: 0.01 to 999999999.99
Default: No

Responses

200Payment With Token was Successful

400Request Error

500Internal Server Error