API Reference

ChargePinPad

post
https://pci.rivhit.co.il/PinPad/PinPadRestApiService.svc/ChargePinPad

Charge Remote Pin Pad Device.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

This method can only be used in the Production environment.

Body Params
double
required

Transaction Amount.

Range: 0.01 to 999999999.99
Default: No

integer | null
enum

Credit Terms of the Transaction Payments.

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

Allowed:
uuid
required

Credit Box Identifier.

Default: No

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

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

integer
required

Sets the Transaction Number of Payments.

Range: 0 to 100
Default: No

integer
required

Transaction Param J Type.

Options: (0 = Immediate transaction)
Default: No

uuid
required

Pinpad Session Identifier.

Default: No

integer
enum
required

The Transaction Type.

Options: (1 = Charge, 51 = Refund)
Default: No

Allowed:
string | null

Pass Extra Data to the Credit Card Company.

Length: 1 to 20
Default: No

Responses

Updated 11 months ago

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

Updated 11 months ago

Did this page help you?