OFFICEGUY

Redirect / IFrame

בנוסף ל-API המבוסס על כתיבת קוד צד שרת, עבור פניה באמצעות REST או SOAP, קיימים גם ממשקים המתאפשרים באמצעות שימוש ב-HTML/JavaScript בלבד.

Customer payments history
https://www.myofficeguy.com/billing/external/history/?CompanyID={CompanyID}&CustomerElementID={CustomerElementID}

This page shows the customer payments history, including all active payments, while also allowing the customer to update payment method.

Parameter name Description Value type
CustomerElementID
OfficeGuy customer identifier
integer

Update customer credit card
https://www.myofficeguy.com/billing/external/paymentmethod/?CompanyID={CompanyID}&CustomerElementID={CustomerElementID}

This page allows updating a customer credit card by your customer

Parameter name Description Value type
CustomerElementID
OfficeGuy customer identifier
integer

Purchase payment page
https://www.myofficeguy.com/billing/external/purchasemodifycart/?CompanyID={CompanyID}&BundleID={ItemID}&PageID={PageID}

This page allows a new customer to purchase a product/service.

Parameter name Description Value type
ItemID
OfficeGuy product identifier
integer
PageID
Purchase page identifier
integer
ZeroQuantities
Add all items with Quantity = 0. This can be used to skip the product selection page, and allow product selection from the payment page directly.
boolean
ExternalIdentifier
External transaction identifier. This identifier will be passed as a query parameter named OG-ExternalIdentifier to the RedirectURL set by the page or the application settings.
string
Description
Item description. This description will be stored and shown to the customer in the created document and payment.
string

Contact form
https://www.myofficeguy.com/contact/?CompanyID={CompanyID}

This action allows redirecting your customer to a contact form. The contact details will be emailed to your company email address.


Tokenize/Validate credit card
https://www.myofficeguy.com/creditguy/external/tokenize/?CompanyID={CompanyID}&APIPublicKey={APIPublicKey}&Mode={Mode}&Identifier={Identifier}&AuthorizeAmount={AuthorizeAmount}&MerchantNumber={MerchantNumber}&Payments={Payments}&First={First}&NonFirst={NonFirst}&BlockedParams={BlockedParams}&Flexible={Flexible}

This action allows credit card to be input securely by the customer directly on OfficeGuy.
The credit card token card later be stored on an external application, for immediate or future payments.
Following card validation, the customer is redirected to a URL set in the application settings page, with the following URL parameters (QueryString):
  1. "Valid": Indication if tokenization was successful (0 for invalid, 1 for valid tokenization).
  2. "Result": Shva result code (Ignored on "TokenizeOnly" mode).
  3. "Token": Credit card secure token.
  4. "Identifier": The input "Identifier" field provided on the request URL.
  5. "Auth": Shva authorization number (Relevant for "Authorize" mode).
  6. "ID": OfficeGuy transaction ID (Ignored on "TokenizeOnly" mode). This ID can be used for retrieving additional information using "GetTransaction" API.
  7. "CitizenID": Citizen entered by user (Ignored on "TokenizeOnly" mode).

Parameter name Description Value type
APIPublicKey
Your company API public key
string
Mode
Card validation mode

Values:
  • "0" (Default) - Tokenization only. The card won't be validated on Shva.
  • "2" - Validation. The card will be validated on Shva, and tokenized if valid.
  • "5" - Authorization. The card will be authorized on Shva for a minimal amount (as specific in the applicaiton settings), and tokenized if valid.
enum
Identifier
Custom Unique identifier. This parameter will be returned to you after validation as a QueryString parameter.
string
AuthorizeAmount
Authorize amount. This parameter is used for "Authorize" mode, and allows overriding the default authorize amount defined in the application settings.
decimal
MerchantNumber
Shva merchant number (Terminal number). This parameter should only be used when multiple merchants are defined in the company.
integer
Payments
Payments count. This parameter should only be used when payments transaction is requested.
integer
First
First payment amount. This parameter should only be used when payments transaction is requested.
decimal
NonFirst
Non-first payment amount. This parameter should only be used when payments transaction is requested.
decimal
BlockedParams
Blocked card parameters. This parameter should be used when the Card Parameters setting is enabled, to prevent processing blocked cards (such as Foreign or Direct cards)
string
Flexible
Flexible amount/payments. This parameter should be used when the enable external amounts is enabled, to allow the user to specify custom amounts and payments.
boolean

Show content page
https://www.myofficeguy.com/contentpages/page/?CompanyID={CompanyID}&Identifier={Identifier}&Mode={Mode}


Parameter name Description Value type
Identifier
Page identifier
string
Mode
Setting for the page view mode

Values:
  • "0" (Default) - HTML for Redirect. Includes OfficeGuy layout.
  • "1" - HTML for IFrame. Includes basic layout.
  • "2" - HTML only.
enum