API Reference

CreateSale

post
https://testicredit.rivhit.co.il/API/PaymentPageRequest.svc/CreateSale

Create a New Sale

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

To complete the sale creation process use method - CompleteSale

🚀

For Production method URL - remove "test" from the link.

Body Params
uuid
required

Payment Page Identifier.

Default: No

Items
array of objects
required
Items*
integer | null
enum

IPN Method Type.

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

Allowed:
url | null

IPN URL - After Success Payment.

Length: 15 to 500
Default: Page settings

boolean | null

The Payment Document VAT Settings.

Default: Page Rivhit settings

integer | null

The Reference Value - Will be Saved in the Invoice.

Range: 0 to 9999999999
Default: No

string | null

The Sale Order Value.

Length: 1 to 15
Default: No

string | null

Customer Email Address.

Length: 6 to 50
Default: Rivhit Customer@

string | null
required

Customer Last Name/Company Name.

Length:* 1 to 30
Default: No

string

Customer First Name.

Length: 1 to 20
Default: Rivhit Customer@

string | null

Customer Address.

Length: 1 to 30
Default: Rivhit Customer@

integer | null

Customer Post Office Box.

Range: 0 to 9999999
Default: No

string | null

Customer City.

Length: 1 to 20
Default: Rivhit Customer@

string | null

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

Length: 1 to 7
Default: Rivhit Customer@

string | null

Customer Phone Number.

Length: 1 to 15
Default: Rivhit Customer@

string | null

Customer Second Phone Number.

Length: 1 to 15
Default: No

string | null

Customer Fax Number.

Length: 1 to 15
Default: Rivhit Customer@

integer | null

Customer Israeli Id (by Custom Format).

Range: 8-9 digits
Default: No

integer | null

Customer VAT Number (by custom format).

Range: 8-9 digits
Default: No

string | null

Custom Open Field 1.

Length: 2GB
Default: No

string | null

Custom Open Field 2.

Length: 2GB
Default: No

string | null

Custom Open Field 3.

Length: 2GB
Default: No

string | null

Custom Open Field 4.

Length: 2GB
Default: No

string | null

Custom Open Field 5.

Length: 2GB
Default: No

string | null

Custom Open Field 6.

Length: 2GB
Default: No

string | null

Custom Open Field 7.

Length: 2GB
Default: No

string | null

Custom Open Field 8.

Length: 2GB
Default: No

string | null

Custom Open Field 9.

Length: 2GB
Default: No

integer | null

Customer Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: Page Settings

integer | null

Agent Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: Page Settings

string | null

The Customer Comments (to print on the invoice).

Length: 1 to 400
Default: Rivhit system settings

integer | null

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999
Default: Page Settings

string | null

Bcc Email Address.

Length: 6 to 50
Default: Rivhit email settings

string | null
enum

Set the Automatic Invoice/Receipt Language.

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

Allowed:
double | null

Discount Amount - For Invoice/Receipt.

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

boolean | null

Send the Document/Receipt to the Customer.

Default: Page settings

boolean | null

Create a New Customer in Rivhit System.

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

boolean | null

Create New Items (in Rivhit system).

Default: Page settings

boolean | null

Locate Customer by Email Address.

Default: Page settings

boolean | null

Locate Customer by Israeli Id/VAT Number.

Default: Page settings

boolean | null

Locate Customer by Phone Number.

Default: Page settings

integer | null
enum

The Sale Type.

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

Allowed:
boolean | null

Convert Items Price Currency to ILS.

Default: Page settings

double | null

Fixed Currency Exchange Rate to ILS.

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

integer | null

Rivhit User Id (Document/Receipt producer).

Range: 0 to 99999
Default: Page Rivhit settings

boolean | null

Turn On/Off Recurring Sale Creation.

~ Requires a recurring sale service
Default: Page recurring settings

integer | null
enum

Set Time Phrase to Charge a Recurring Sale.

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

Allowed:
integer | null
enum

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

Range: 1-28
Default: Page recurring settings

integer | null

Set the Time Phrase to Charge a Recurring Sale.

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

integer | null

Limit Number of Charges for a Recurring Sale.

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

date | null

Set Start Date for a Recurring Sale.

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

boolean | null

Activate Recurring Sale Automatic Charge.

Default: Page recurring settings

boolean | null

Create Recurring Sale with Pro Rata First Charge.

Default: Page recurring settings

integer | null

Set the Automatic Receipt Type.

Range: 1 to 999
Default: Page settings

integer | null

Set the Automatic Document Type.

Range: 1 to 999
Default: Page settings

boolean | null

Items Sent With or Without VAT.

Default: Page Rivhit settings

string | null

Customer Country.

Length: 1 to 39
Default: Rivhit Customer@

string | null

Customer State.

Length: 1 to 10
Default: No

url | null

IPN URL - After Failure in Payment.

Length: 15 to 500
Default: No

Responses

Updated 12 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 12 months ago

Did this page help you?