v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

ChargePinPad

post/PinPad/PinPadRestApiService.svc/ChargePinPad

Request body

Amountnumber double required

Transaction Amount.

Range: 0.01 to 999999999.99 Default: No

CreditTerms1 | 6 | 8 nullable

Credit Terms of the Transaction Payments.

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

CreditboxTokenstring uuid required

Credit Box Identifier.

Default: No

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

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

NumOfPaymentinteger required

Sets the Transaction Number of Payments.

Range: 0 to 100 Default: No

ParamJinteger required

Transaction Param J Type.

Options: (0 = Immediate transaction) Default: No

SessionIdstring uuid required

Pinpad Session Identifier.

Default: No

TransactionType1 | 51 required

The Transaction Type.

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

UniqueNumstring nullable

Pass Extra Data to the Credit Card Company.

Length: 1 to 20 Default: No

Example request

{
  "Amount": 1,
  "CreditTerms": 1,
  "CreditboxToken": "1627aea5-8e0a-4371-9022-9b504344e724",
  "Currency": 1,
  "FirstAmount": 100.5,
  "Id": "123456790",
  "NumOfPayment": 1,
  "SessionId": "1627aea5-8e0a-4371-9022-9b504344e724",
  "TransactionType": 1,
  "UniqueNum": "Any value"
}

Response

PinPad Charge Response

error_codeinteger

The Response Error/Status Number (0 = Success)

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

CustomerTransactionIdstring uuid

The Transaction Identifier.