Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Get Recurring Sale Details

post/API/PaymentPageRequest.svc/RecurringSaleDetails

Request body

RecurringSaleIdstring uuid

Recurring Sale Identifier.

Format: UUID Default: No

Example request

{
  "RecurringSaleId": "7b3d58c0-6a6c-462a-80b2-e1a80e9d4ae1"
}

Response

Recurring Sale Details Succesful Response

Addressstring

Customer Address.

Amountnumber double

Recurring Sale Total Amount.

AuthNumstring

Original Transaction Approval Number.

AutoChargeboolean

Recurring Auto Charge Settings.

CardDueDatestring

Credit Card Due date (MMYY).

CardNumstring

Credit Card Number.

CardProducerinteger

Credit Card Producer.

ChargeCountinteger

The Recurring Total Number of Succesful Charges.

ChargeDatestring

Last Charge Date

Citystring

Customer City.

Commentsstring

Customer Comments.

Countrystring

Customer Country.

CreationDatestring

Recurring Creation Date.

Currencyinteger

Recurring Sale Currency.

CustomerFirstNamestring

Customer First Name.

CustomerIdinteger

Customer Identifier in Rivhit

CustomerLastNamestring

Customer Last Name.

Discountnumber double

Recurring Sale Discount Amount.

EmailAddressstring

Customer Email.

EndDatestring

Recurring Sale End Date.

ExemptVatboolean

The Payment Document VAT Settings.

FaxNumberstring

Customer Fax Number.

GroupIdstring uuid

Recurring Sale GroupId (Payment Page Identifier).

IdNumberinteger

Customer Id Number.

IpnUrlstring

IPN (Instant Payment Notification) URL.

IsActiveboolean

Recurring Sale Activation Status.

Orderstring

Recurring Order Number.

POBinteger

Customer Post Office Box.

PhoneNumberstring

Customer Phone Number.

PhoneNumber2string

Customer Second Phone Number.

PriceIncludeVatboolean

Recurring Items Sent With or Without VAT.

ProRataboolean

Create Recurring Sale with Pro Rata First Charge.

RecurringConcatMonthinteger

Month Number Concatenate to Item Description Settings.

RecurringCycleinteger

Recurring Sale Cycle (Every Day/Week/Month).

RecurringDayinteger

Recurring Charge Day (1-28).

RecurringOffsetinteger

Recurring Backword/Forward Total Charge Count.

RecurringSaleCountinteger

Recurring Sale Charge Count Settings (0 = Non Stop).

RecurringStepinteger

Recurring Payment Time Phrase (Every X day/week/month).

Referenceinteger

Recurring Reference Number.

StartDatestring

Recurring Start Date.

Statestring

Customer State.

Tokenstring uuid

Recurring Credit Card Token.

VatNumberinteger

Customer VAT Number.

Zipcodestring

Customer Zip Code.

Example response

{
  "Address": "Ben Yehuda 110",
  "Amount": 15,
  "AuthNum": "123456",
  "AutoCharge": true,
  "CardDueDate": "0827",
  "CardNum": "458000XXXXXX0000",
  "CardProducer": 2,
  "ChargeCount": 4,
  "ChargeDate": "/Date(1720040400000+0300)/",
  "City": "Tel Aviv",
  "Comments": "Here will be the Comments",
  "Country": "Israel",
  "CreationDate": "/Date(1715843248980+0300)/",
  "Currency": 1,
  "CustomerFirstName": "Test",
  "CustomerLastName": "Test777",
  "EmailAddress": "a@a.co.il",
  "EndDate": "/Date(928138800000+0300)/",
  "ExemptVat": true,
  "FaxNumber": "03-4444444",
  "GroupId": "c0144ad3-66a6-47c6-8f85-aa263839c092",
  "IdNumber": 123456790,
  "IpnUrl": "http://a34f-213-57-20-226.ngrok.io/IPN/IPNLogger.php",
  "IsActive": true,
  "Items": [
    {
      "Description": "Test Item",
      "Quantity": 1,
      "UnitPrice": 15
    }
  ],
  "Order": "1115",
  "POB": 111111,
  "PhoneNumber": "String content",
  "PhoneNumber2": "String content",
  "PriceIncludeVat": true,
  "ProRata": true,
  "RecurringConcatMonth": 1,
  "RecurringCycle": 1,
  "RecurringDay": 10,
  "RecurringOffset": -1,
  "RecurringStep": 1,
  "Reference": 11111,
  "StartDate": "/Date(928138800000+0300)/",
  "State": "Texas",
  "Token": "109172b5-7bd0-491c-a899-575a9662507d",
  "VatNumber": 123456790,
  "Zipcode": "111111"
}