GetUrl

post

https://testicredit.rivhit.co.il/API/PaymentPageRequest.svc/GetUrl

Get a payment page URL

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚀
Most API reference methods show the test environment URL by default. For production, remove test from the URL.

Body Params

GroupPrivateToken

uuid

required

Payment Page Identifier.

Default: No

Items

array of objects

required

Items*

RedirectURL

string | null

Thank You Page URL - After Successful Payment.

Length: 15 to 500
Default: Page Settings

IPNFailureURL

url | null

IPN URL - After Failure in Payment.

Length: 15 to 500
Default: No

IPNMethod

integer | null

enum

IPN Method Type.

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

Allowed:

IPNURL

url | null

IPN URL - After Success Payment.

Length: 15 to 500
Default: Page settings

ExemptVAT

boolean | null

The Payment Document VAT Settings.

Default: Page Rivhit settings

PriceIncludeVAT

boolean | null

Items Sent With or Without VAT.

Default: Page Rivhit settings

MaxPayments

integer | null

Maximum Number of Payments to Choose.

Range: 1 to 100
Default: Page settings

CreditFromPayment

integer | null

Minimum Number of Payment to Set as Credit Payments.

Range: 1 to 100
Default: Page settings

Reference

integer | null

The Reference Value - Will be Saved in the Invoice.

Range: 0 to 9999999999
Default: No

Order

string | null

The Sale Order Value.

Length: 1 to 15
Default: No

EmailAddress

string | null

Customer Email Address.

Length: 6 to 50
Default: Rivhit Customer@

CustomerLastName

string | null

required

Customer Last Name/Company Name.

Length:* 1 to 30
Default: No

CustomerFirstName

string

Customer First Name.

Length: 1 to 20
Default: Rivhit Customer@

Address

string | null

Customer Address.

Length: 1 to 30
Default: Rivhit Customer@

POB

integer | null

Customer Post Office Box.

Range: 0 to 9999999
Default: No

City

string | null

Customer City.

Length: 1 to 20
Default: Rivhit Customer@

PhoneNumber2

string | null

Customer Second Phone Number.

Length: 1 to 15
Default: No

FaxNumber

string | null

Customer Fax Number.

Length: 1 to 15
Default: Rivhit Customer@

Zipcode

string | null

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

Length: 1 to 7
Default: Rivhit Customer@

IdNumber

integer | null

Customer Israeli Id (by Custom Format).

Range: 8-9 digits
Default: No

PhoneNumber

string | null

Customer Phone Number.

Length: 1 to 15
Default: Rivhit Customer@

VatNumber

integer | null

Customer VAT Number (by custom format).

Range: 8-9 digits
Default: No

Custom1

string | null

Custom Open Field 1.

Length: 2GB
Default: No

Custom2

string | null

Custom Open Field 2.

Length: 2GB
Default: No

Custom3

string | null

Custom Open Field 3.

Length: 2GB
Default: No

Custom4

string | null

Custom Open Field 4.

Length: 2GB
Default: No

Custom5

string | null

Custom Open Field 5.

Length: 2GB
Default: No

Custom6

string | null

Custom Open Field 6.

Length: 2GB
Default: No

Custom7

string | null

Custom Open Field 7.

Length: 2GB
Default: No

Custom8

string | null

Custom Open Field 8.

Length: 2GB
Default: No

Custom9

string | null

Custom Open Field 9.

Length: 2GB
Default: No

CustomerId

integer | null

Customer Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: Page Settings

AgentId

integer | null

Agent Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: Page Settings

Comments

string | null

The Customer Comments (to print on the invoice).

Length: 1 to 400
Default: Rivhit system settings

ProjectId

integer | null

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: Page Settings

EmailBcc

string | null

Bcc Email Address.

Length: 6 to 50
Default: Rivhit email settings

HideItemList

boolean | null

Hide Items block in Payment Page.

Default: Page settings

DocumentLanguage

string | null

enum

Set the Automatic Invoice/Receipt Language.

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

Allowed:

Discount

double | null

Discount Amount - For Invoice/Receipt.

Range: Decimal limit (only positive)
Default: No

Currency

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: Page settings

SendMail

boolean | null

Send the Document/Receipt to the Customer.

Default: Page settings

CreateCustomer

boolean | null

Create a New Customer in Rivhit System.

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

FindByMail

boolean | null

Locate Customer by Email Address.

Default: Page settings

FindById

boolean | null

Locate Customer by Israeli Id/VAT Number.

Default: Page settings

FindByPhone

boolean | null

Locate Customer by Phone Number.

Default: Page settings

FailRedirectURL

url | null

Failure URL - to Redirect The Customer After Failure.

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

MaxFailedAttempts

integer | null

Max attempts to Redirect the customer after failure.

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

DisplayBackButton

boolean | null

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

Default: Page settings

SaleType

integer | null

enum

The Sale Type.

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

Allowed:

NumberOfPayments

integer | null

Set a Fixed Number of Payments.

Range: 1 to 100
Default: No

CreateItems

boolean | null

Create New Items (in Rivhit system).

Default: Page settings

IsAsync

boolean | null

Set Payment Proccess to be Asynchronous.

Default: Page settings

ConvertToNIS

boolean | null

Convert Items Price Currency to ILS.

Default: Page settings

ExchangeRate

double | null

Fixed Currency Exchange Rate to ILS.

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

MinPayments

integer | null

Minimum Number of Payments to Choose.

Range: 1 to 100
Default: Page Settings

DisplayPayPalButton

boolean | null

Display PayPal Button on the Payment Page.

Default: Page settings

DocumentType

integer | null

Set the Automatic Document Type.

Range: 1 to 999
Default: Page settings

ReceiptType

integer | null

Set the Automatic Receipt Type.

Range: 1 to 999
Default: Page settings

ClosedDocumentType

integer | null

Set the Type of Existing Document to be closed.

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

ClosedDocumentNumber

integer | null

Set the Number of Existing Document to be closed.

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

Country

string | null

Customer Country.

Length: 1 to 39
Default: Rivhit Customer@

State

string | null

Customer State.

Length: 1 to 10
Default: No

CreateRecurringSale

boolean | null

Turn On/Off Recurring Sale Creation.

~ Requires a recurring sale service
Default: Page recurring settings

RecurringSaleCycle

integer | null

enum

Set Time Phrase to Charge a Recurring Sale.

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

Allowed:

RecurringSaleDay

integer | null

enum

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

Range: 1-28
Default: Page recurring settings

RecurringSaleStep

integer | null

Set the Time Phrase to Charge a Recurring Sale.

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

RecurringSaleCount

integer | null

Limit Number of Charges for a Recurring Sale.

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

RecurringSaleStartDate

date | null

Set Start Date for a Recurring Sale.

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

RecurringSaleAutoCharge

boolean | null

Activate Recurring Sale Automatic Charge.

Default: Page recurring settings

RecurringSaleProRata

boolean | null

Create Recurring Sale with Pro Rata First Charge.

Default: Page recurring settings

Use3DS

boolean | null

Activate 3DS Security Check on Payment.

~ Requires a 3DS service
Default: Page settings

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json