Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

GetUrl

Get a payment page URL

post/API/PaymentPageRequest.svc/GetUrl

Request body

GroupPrivateTokenstring uuid required

Payment Page Identifier.

Default: No

RedirectURLstring URL nullable

Thank You Page URL - After Successful Payment.

Length: 15 to 500 Default: Page Settings

IPNFailureURLstring url nullable

IPN URL - After Failure in Payment.

Length: 15 to 500 Default: No

IPNMethod1 | 2 nullable

IPN Method Type.

Options: (1=POST 2=GET) Default: Page settings

IPNURLstring url nullable

IPN URL - After Success Payment.

Length: 15 to 500 Default: Page settings

ExemptVATboolean nullable

The Payment Document VAT Settings.

Default: Page Rivhit settings

PriceIncludeVATboolean nullable

Items Sent With or Without VAT.

Default: Page Rivhit settings

MaxPaymentsinteger nullable

Maximum Number of Payments to Choose.

Range: 1 to 100 Default: Page settings

CreditFromPaymentinteger nullable

Minimum Number of Payment to Set as Credit Payments.

Range: 1 to 100 Default: Page settings

Referenceinteger nullable

The Reference Value - Will be Saved in the Invoice.

Range: 0 to 9999999999 Default: No

Orderstring nullable

The Sale Order Value.

Length: 1 to 15 Default: No

EmailAddressstring email nullable

Customer Email Address.

Length: 6 to 50 Default: Rivhit Customer@

CustomerLastNamestring nullable required

Customer Last Name/Company Name.

Length:* 1 to 30 Default: No

CustomerFirstNamestring

Customer First Name.

Length: 1 to 20 Default: Rivhit Customer@

Addressstring nullable

Customer Address.

Length: 1 to 30 Default: Rivhit Customer@

POBinteger nullable

Customer Post Office Box.

Range: 0 to 9999999 Default: No

Citystring nullable

Customer City.

Length: 1 to 20 Default: Rivhit Customer@

PhoneNumber2string nullable

Customer Second Phone Number.

Length: 1 to 15 Default: No

FaxNumberstring nullable

Customer Fax Number.

Length: 1 to 15 Default: Rivhit Customer@

Zipcodestring nullable

Customer Zip Code (to print on invoice - send numbers).

Length: 1 to 7 Default: Rivhit Customer@

IdNumberinteger nullable

Customer Israeli Id (by Custom Format).

Range: 8-9 digits Default: No

PhoneNumberstring nullable

Customer Phone Number.

Length: 1 to 15 Default: Rivhit Customer@

VatNumberinteger nullable

Customer VAT Number (by custom format).

Range: 8-9 digits Default: No

Custom1string nullable

Custom Open Field 1.

Length: 2GB Default: No

Custom2string nullable

Custom Open Field 2.

Length: 2GB Default: No

Custom3string nullable

Custom Open Field 3.

Length: 2GB Default: No

Custom4string nullable

Custom Open Field 4.

Length: 2GB Default: No

Custom5string nullable

Custom Open Field 5.

Length: 2GB Default: No

Custom6string nullable

Custom Open Field 6.

Length: 2GB Default: No

Custom7string nullable

Custom Open Field 7.

Length: 2GB Default: No

Custom8string nullable

Custom Open Field 8.

Length: 2GB Default: No

Custom9string nullable

Custom Open Field 9.

Length: 2GB Default: No

CustomerIdinteger nullable

Customer Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: Page Settings

AgentIdinteger nullable

Agent Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: Page Settings

Commentsstring nullable

The Customer Comments (to print on the invoice).

Length: 1 to 400 Default: Rivhit system settings

ProjectIdinteger nullable

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: Page Settings

EmailBccstring email nullable

Bcc Email Address.

Length: 6 to 50 Default: Rivhit email settings

HideItemListboolean nullable

Hide Items block in Payment Page.

Default: Page settings

DocumentLanguage'he' | 'en' nullable

Set the Automatic Invoice/Receipt Language.

Options: (he/en) Default: Page Rivhit settings

Discountnumber double nullable

Discount Amount - For Invoice/Receipt.

Range: Decimal limit (only positive) 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: Page settings

SendMailboolean nullable

Send the Document/Receipt to the Customer.

Default: Page settings

CreateCustomerboolean nullable

Create a New Customer in Rivhit System.

~ When exsiting customer can't be found
Default: Page settings

FindByMailboolean nullable

Locate Customer by Email Address.

Default: Page settings

FindByIdboolean nullable

Locate Customer by Israeli Id/VAT Number.

Default: Page settings

FindByPhoneboolean nullable

Locate Customer by Phone Number.

Default: Page settings

FailRedirectURLstring url nullable

Failure URL - to Redirect The Customer After Failure.

~ Combine with MaxFailedAttempts Length: 15 to 500 Default: Page settings

MaxFailedAttemptsinteger nullable

Max attempts to Redirect the customer after failure.

~ Combine with FailRedirectURL Range: 1 to 99 Default: Page settings

DisplayBackButtonboolean nullable

Add "Back to the Website" Button in Payment Page.

Default: Page settings

SaleType1 | 2 | 3 nullable

The Sale Type.

Options: (1 = Immediate 2 = Pending 3 = Only token) Default: Page settings

NumberOfPaymentsinteger nullable

Set a Fixed Number of Payments.

Range: 1 to 100 Default: No

CreateItemsboolean nullable

Create New Items (in Rivhit system).

Default: Page settings

IsAsyncboolean nullable

Set Payment Proccess to be Asynchronous.

Default: Page settings

ConvertToNISboolean nullable

Convert Items Price Currency to ILS.

Default: Page settings

ExchangeRatenumber double nullable

Fixed Currency Exchange Rate to ILS.

~ Combine with ConvertToNIS Range: Decimal limit (only positive) Default: Page Settings

MinPaymentsinteger nullable

Minimum Number of Payments to Choose.

Range: 1 to 100 Default: Page Settings

DisplayPayPalButtonboolean nullable

Display PayPal Button on the Payment Page.

Default: Page settings

DocumentTypeinteger nullable

Set the Automatic Document Type.

Range: 1 to 999 Default: Page settings

ReceiptTypeinteger nullable

Set the Automatic Receipt Type.

Range: 1 to 999 Default: Page settings

ClosedDocumentTypeinteger nullable

Set the Type of Existing Document to be closed.

~ Combine with ClosedDocumentNumber Range: 1 to 999 Default: No

ClosedDocumentNumberinteger nullable

Set the Number of Existing Document to be closed.

~ combine with ClosedDocumentType Range: 1 to 999999 Default: No

Countrystring nullable

Customer Country.

Length: 1 to 39 Default: Rivhit Customer@

Statestring nullable

Customer State.

Length: 1 to 10 Default: No

CreateRecurringSaleboolean nullable

Turn On/Off Recurring Sale Creation.

~ Requires a recurring sale service Default: Page recurring settings

RecurringSaleCycle1 | 2 | 3 nullable

Set Time Phrase to Charge a Recurring Sale.

Options (1 = day 2 = week 3 = month) Default: Page recurring settings

RecurringSaleDay1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 nullable

Set the Charge Day of the month in a Recurring Sale.

Range: 1-28 Default: Page recurring settings

RecurringSaleStepinteger nullable

Set the Time Phrase to Charge a Recurring Sale.

~ Every X day/week/month Range: 1 to 999 Default: Page recurring settings

RecurringSaleCountinteger nullable

Limit Number of Charges for a Recurring Sale.

~ For non stop charge = 0 Range: 1 to 999 Default: Page recurring settings

RecurringSaleStartDatestring date nullable

Set Start Date for a Recurring Sale.

~ Date format DD-MM-YYYY Length: 10 characters Default: Page recurring settings

RecurringSaleAutoChargeboolean nullable

Activate Recurring Sale Automatic Charge.

Default: Page recurring settings

RecurringSaleProRataboolean nullable

Create Recurring Sale with Pro Rata First Charge.

Default: Page recurring settings

Use3DSboolean nullable

Activate 3DS Security Check on Payment.

~ Requires a 3DS service Default: Page settings

Example request

{
  "GroupPrivateToken": "a1408bfc-18da-49dc-aa77-d65870f7943e",
  "Items": [
    {
      "Id": 0,
      "CatalogNumber": "1a",
      "UnitPrice": 5,
      "Quantity": 1,
      "Description": "item1"
    },
    {
      "Id": 0,
      "CatalogNumber": "2a",
      "UnitPrice": 5,
      "Quantity": 1,
      "Description": "item2"
    }
  ],
  "RedirectURL": "https://www.icredit.co.il/",
  "IPNFailureURL": "http://9188dde0.ngrok.io/test/ipn_listener.php",
  "IPNMethod": 1,
  "IPNURL": "http://9188dde0.ngrok.io/test/ipn_listener.php",
  "PriceIncludeVAT": true,
  "MaxPayments": 12,
  "CreditFromPayment": 4,
  "Reference": 12345,
  "Order": "ab12345",
  "EmailAddress": "a@a.com",
  "CustomerLastName": "Israeli",
  "CustomerFirstName": "Moshe",
  "Address": "Ben Yehuda 1",
  "POB": 12345,
  "City": "Tel Aviv",
  "PhoneNumber2": "054-4444444",
  "FaxNumber": "03-3333333",
  "IdNumber": 123456790,
  "PhoneNumber": "054-4444444",
  "VatNumber": 123456790,
  "Custom1": "Custom1 value",
  "Custom2": "Custom2 value",
  "Custom3": "Custom3 value",
  "Custom4": "Custom4 value",
  "Custom5": "Custom5 value",
  "Custom6": "Custom6 value",
  "Custom7": "Custom7 value",
  "Custom8": "Custom8 value",
  "Custom9": "Custom9 value",
  "Comments": "Comments will be here",
  "EmailBcc": "a@a.com",
  "HideItemList": true,
  "DocumentLanguage": "en",
  "Discount": 10,
  "Currency": 1,
  "SendMail": true,
  "CreateCustomer": true,
  "FindByMail": true,
  "FindById": true,
  "FindByPhone": true,
  "FailRedirectURL": "https://www.icredit.co.il/",
  "MaxFailedAttempts": 4,
  "SaleType": 1,
  "NumberOfPayments": 1,
  "CreateItems": true,
  "ExchangeRate": 3.8,
  "MinPayments": 1,
  "DocumentType": 2,
  "ClosedDocumentType": 1,
  "Country": "Israel",
  "State": "Texas",
  "RecurringSaleCycle": 3,
  "RecurringSaleDay": 10,
  "RecurringSaleStep": 1,
  "RecurringSaleCount": 12,
  "RecurringSaleStartDate": "01-03-2025",
  "RecurringSaleAutoCharge": true
}

Response

Payment URL successfully retrieved

DebugMessagestring

The Response Error Message.

PrivateSaleTokenstring uuid

The Sale Private Identifier

PublicSaleTokenstring uuid

The Sale Public Identifier

Statusinteger

The Response Status Number (0 = Success).

URLstring url

The Payment Page URL.

Example response

{
  "PrivateSaleToken": "8e2f51dd-2eff-4c2c-96bb-a636d0f64da9",
  "PublicSaleToken": "2a517967-85e5-43a0-820c-dc12d8721a12",
  "URL": "https://testicredit.rivhit.co.il/payment/PaymentItems.aspx?GroupId=1beb572a-0db9-4854-908b-cdf7378e49c9&Token=2a517967-85e5-43a0-820c-dc12d8721a12"
}
All 88 operations