---
title: "ChargePinPad"
method: POST
path: "/PinPad/PinPadRestApiService.svc/ChargePinPad"
---

# ChargePinPad

`POST /PinPad/PinPadRestApiService.svc/ChargePinPad`

## Request body

- object
  - `Amount` number, double, required — Transaction Amount. **Range:** 0.01 to 999999999.99 **Default:** No
  - `CreditTerms` 1 | 6 | 8, nullable — Credit Terms of the Transaction Payments. **Options:** (1 = Single payment 6 = Multiple payments - Credit 8 = Multiple Payments - regular) **Default:** 1
  - `CreditboxToken` string, uuid, required — Credit Box Identifier. **Default:** No
  - `Currency` 1 | 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
  - `FirstAmount` number, double, nullable — Amount for the First Payment (Multiple Payments). **Range:** 0.01 to 999999999.99 **Default:** No
  - `Id` string, 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
  - `NumOfPayment` integer, required — Sets the Transaction Number of Payments. **Range:** 0 to 100 **Default:** No
  - `ParamJ` integer, required — Transaction Param J Type. **Options:** (0 = Immediate transaction) **Default:** No
  - `SessionId` string, uuid, required — Pinpad Session Identifier. **Default:** No
  - `TransactionType` 1 | 51, required — The Transaction Type. **Options:** (1 = Charge, 51 = Refund) **Default:** No
  - `UniqueNum` string, nullable — Pass Extra Data to the Credit Card Company. **Length:** 1 to 20 **Default:** No

## Response `200`

PinPad Charge Response

- object
  - `error_code` integer — The Response Error/Status Number (0 = Success)
  - `client_message` string — The Client Error Message.
  - `debug_message` string — The Response Error Message.
  - `CustomerTransactionId` string, uuid — The Transaction Identifier.

## Other responses

- `400` — Request Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/rivhit/apis/get-payment-url-22-12.md) · [All operations](https://skmtc.net/rivhit/apis/get-payment-url-22-12/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivhit/get-payment-url-22-12/versions/ed5261a52458/schema)