API Reference

ChargeSimple

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

Charge Credit Card/Token - Short Response

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Send Additional Data to the Defrayal Company.

Length: 1 to 20 Default: No

string | null

Transaction Approval Number.

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

string
required

The Credit Card Number.

Length: 10 to 16 Default: No

boolean | null

Create a Token for Future Use.

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

integer | null
enum

Credit Terms of the Transaction Payments.

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

Allowed:
integer | null
enum

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

uuid

Existing Transaction identifier.

Format: UUID Default: No

string | null

Card Verification Value (CVV).

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

string
required

The Credit Card Validation Date (YYMM).

Length: 4 Default: No

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

uuid

Transaction On Hold (J5) Identifier.

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

integer | null

Sets the Transaction Number of Payments.

Range: 1 to 100 Default: 1

uuid | null

Original Transaction Identifier.

~ Used for Apple Payment Refunds. Default: No

integer | null
enum

Transaction Param J Type.

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

Allowed:
boolean | null

Prevent Doubled Transactions.

~ Combine with RequestReference Default: false

string | null

The Transaction Request Reference.

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

uuid

3DS Transaction Identifier.

Format: UUID Default: No

uuid
required

Credit Card Token (Instead of Credit Card Number).

Format: UUID Default: No

integer | null
enum

The Transaction Type.

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

Allowed:
string | null

Pass Extra Data to the Credit Card Company

Length: 1 to 20 Default: No

uuid
required

Credit Box Identifier.

Format: UUID Default: No

double
required

Transaction Amount.

Range: 0.01 to 999999999.99 Default: No

Responses

Updated 9 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago