---
title: "Begin redirect for transaction"
method: POST
path: "/billing/payments/beginredirect/"
tags: ["Payments (Payments)"]
---

# Begin redirect for transaction

`POST /billing/payments/beginredirect/`

## Headers

- `Content-Language` unknown

## Request body

- OfficeGuyAppsBillingMVCAPIPaymentsControllerPaymentsBeginRedirectRequest
  - `Credentials` CoreAPICredentials, required
    - `CompanyID` integer, required — Company identifier
    - `APIKey` string, required — API key secret
  - `Customer` AccountingTypedCustomer, required
    - `ID` integer, nullable — SUMIT identifier Leave empty to create a new entity or search by other fields when applicable
    - `Folder` string, nullable — Folder identifier. Can be either application folder name, or FolderID.
    - `Properties` object, nullable — Entity fields
    - `Name` string, nullable — Customer full name (or company name) Required for creating new customer (Leave empty to search by other fields)
    - `Phone` string, nullable — Customer phone number (Optional field)
    - `EmailAddress` string, nullable — Customer email address (Optional field)
    - `City` string, nullable — Customer city (Optional field)
    - `Address` string, nullable — Customer address (Optional field)
    - `ZipCode` string, nullable — Customer ZipCode (Optional field)
    - `CompanyNumber` string, nullable — Customer registered company number (VAT number) (Optional field)
    - `ExternalIdentifier` string, nullable — Customer external identifier. External identifier from calling application. Optional field
    - `NoVAT` boolean, nullable — NoVAT indication Set to true for VAT exempt customers Defaults to False
    - `SearchMode` 'Automatic (0)' | 'None (1)' | 'ExternalIdentifier (2)' | 'Name (3)' | 'CompanyNumber (4)' | 'Phone (5)' | 'EmailAddress (6)' — Customer searching mode
  - `Items` OfficeGuyAppsBillingMVCAPITypedChargeItem[], required — Items
    - `Item` AccountingTypedIncomeItem
      - `ID` integer, nullable — SUMIT identifier
      - `Name` string, nullable — Item name
      - `Description` string, nullable — Item description
      - `Price` number, double, nullable — Item price (for single unit)
      - `Currency` 'ILS (0)' | 'USD (1)' | 'EUR (2)' | 'CAD (3)' | 'CHF (4)' | 'GBP (5)' | 'AUD (6)' | 'JPY (8)' | 'SEK (9)' | 'NOK (10)' | 'DKK (11)' | 'ZAR (12)' | 'JOD (13)' | 'LBP (14)' | 'EGP (15)' | 'ARS (32)' | 'BSD (44)' | 'BHD (48)' | 'BDT (50)' | 'AMD (51)' | 'BBD (52)' | 'BMD (60)' | 'BTN (64)' | 'BOB (68)' | 'BWP (72)' | 'BZD (84)' | 'SBD (90)' | 'BND (96)' | 'MMK (104)' | 'BIF (108)' | 'KHR (116)' | 'CVE (132)' | 'KYD (136)' | 'LKR (144)' | 'CLP (152)' | 'CNY (156)' | 'COP (170)' | 'KMF (174)' | 'CRC (188)' | 'HRK (191)' | 'CUP (192)' | 'CZK (203)' | 'DOP (214)' | 'SVC (222)' | 'ETB (230)' | 'ERN (232)' | 'FKP (238)' | 'FJD (242)' | 'DJF (262)' | 'GMD (270)' | 'GIP (292)' | 'GTQ (320)' | 'GNF (324)' | 'GYD (328)' | 'HTG (332)' | 'HNL (340)' | 'HKD (344)' | 'HUF (348)' | 'ISK (352)' | 'INR (356)' | 'IDR (360)' | 'IRR (364)' | 'IQD (368)' | 'JMD (388)' | 'KZT (398)' | 'KES (404)' | 'KPW (408)' | 'KRW (410)' | 'KWD (414)' | 'KGS (417)' | 'LAK (418)' | 'LSL (426)' | 'LRD (430)' | 'LYD (434)' | 'MOP (446)' | 'MWK (454)' | 'MYR (458)' | 'MVR (462)' | 'MUR (480)' | 'MXN (484)' | 'MNT (496)' | 'MDL (498)' | 'MAD (504)' | 'OMR (512)' | 'NAD (516)' | 'NPR (524)' | 'ANG (532)' | 'AWG (533)' | 'VUV (548)' | 'NZD (554)' | 'NIO (558)' | 'NGN (566)' | 'PKR (586)' | 'PAB (590)' | 'PGK (598)' | 'PYG (600)' | 'PEN (604)' | 'PHP (608)' | 'QAR (634)' | 'RUB (643)' | 'RWF (646)' | 'SHP (654)' | 'SAR (682)' | 'SCR (690)' | 'SLL (694)' | 'SGD (702)' | 'VND (704)' | 'SOS (706)' | 'SZL (748)' | 'SYP (760)' | 'THB (764)' | 'TOP (776)' | 'TTD (780)' | 'AED (784)' | 'TND (788)' | 'UGX (800)' | 'MKD (807)' | 'TZS (834)' | 'UYU (858)' | 'UZS (860)' | 'WST (882)' | 'YER (886)' | 'TWD (901)' | 'CUC (931)' | 'ZWL (932)' | 'BYN (933)' | 'TMT (934)' | 'GHS (936)' | 'SDG (938)' | 'RSD (941)' | 'MZN (943)' | 'AZN (944)' | 'RON (946)' | 'TRY (949)' | 'XAF (950)' | 'XCD (951)' | 'XOF (952)' | 'XPF (953)' | 'XAU (959)' | 'XDR (960)' | 'XAG (961)' | 'ZMW (967)' | 'SRD (968)' | 'MGA (969)' | 'AFN (971)' | 'TJS (972)' | 'AOA (973)' | 'BGN (975)' | 'CDF (976)' | 'BAM (977)' | 'UAH (980)' | 'GEL (981)' | 'PLN (985)' | 'BRL (986)' | 'CLF (990)'
      - `Cost` number, double, nullable — Item cost (for single unit)
      - `ExternalIdentifier` string, nullable — Income item external identifier
      - `SKU` string, nullable
      - `SearchMode` 'Automatic (0)' | 'None (1)' | 'ExternalIdentifier (2)' | 'Name (3)' | 'SKU (4)' | 'Description (5)'
      - `Properties` object, nullable — Entity fields
    - `Quantity` number, double, nullable — Quantity Defaults to 1
    - `UnitPrice` number, double, nullable — Single unit price in payment currency Required field.
    - `Total` number, double, nullable — Total price in payment currency Optional field
    - `Currency` 'ILS (0)' | 'USD (1)' | 'EUR (2)' | 'CAD (3)' | 'CHF (4)' | 'GBP (5)' | 'AUD (6)' | 'JPY (8)' | 'SEK (9)' | 'NOK (10)' | 'DKK (11)' | 'ZAR (12)' | 'JOD (13)' | 'LBP (14)' | 'EGP (15)' | 'ARS (32)' | 'BSD (44)' | 'BHD (48)' | 'BDT (50)' | 'AMD (51)' | 'BBD (52)' | 'BMD (60)' | 'BTN (64)' | 'BOB (68)' | 'BWP (72)' | 'BZD (84)' | 'SBD (90)' | 'BND (96)' | 'MMK (104)' | 'BIF (108)' | 'KHR (116)' | 'CVE (132)' | 'KYD (136)' | 'LKR (144)' | 'CLP (152)' | 'CNY (156)' | 'COP (170)' | 'KMF (174)' | 'CRC (188)' | 'HRK (191)' | 'CUP (192)' | 'CZK (203)' | 'DOP (214)' | 'SVC (222)' | 'ETB (230)' | 'ERN (232)' | 'FKP (238)' | 'FJD (242)' | 'DJF (262)' | 'GMD (270)' | 'GIP (292)' | 'GTQ (320)' | 'GNF (324)' | 'GYD (328)' | 'HTG (332)' | 'HNL (340)' | 'HKD (344)' | 'HUF (348)' | 'ISK (352)' | 'INR (356)' | 'IDR (360)' | 'IRR (364)' | 'IQD (368)' | 'JMD (388)' | 'KZT (398)' | 'KES (404)' | 'KPW (408)' | 'KRW (410)' | 'KWD (414)' | 'KGS (417)' | 'LAK (418)' | 'LSL (426)' | 'LRD (430)' | 'LYD (434)' | 'MOP (446)' | 'MWK (454)' | 'MYR (458)' | 'MVR (462)' | 'MUR (480)' | 'MXN (484)' | 'MNT (496)' | 'MDL (498)' | 'MAD (504)' | 'OMR (512)' | 'NAD (516)' | 'NPR (524)' | 'ANG (532)' | 'AWG (533)' | 'VUV (548)' | 'NZD (554)' | 'NIO (558)' | 'NGN (566)' | 'PKR (586)' | 'PAB (590)' | 'PGK (598)' | 'PYG (600)' | 'PEN (604)' | 'PHP (608)' | 'QAR (634)' | 'RUB (643)' | 'RWF (646)' | 'SHP (654)' | 'SAR (682)' | 'SCR (690)' | 'SLL (694)' | 'SGD (702)' | 'VND (704)' | 'SOS (706)' | 'SZL (748)' | 'SYP (760)' | 'THB (764)' | 'TOP (776)' | 'TTD (780)' | 'AED (784)' | 'TND (788)' | 'UGX (800)' | 'MKD (807)' | 'TZS (834)' | 'UYU (858)' | 'UZS (860)' | 'WST (882)' | 'YER (886)' | 'TWD (901)' | 'CUC (931)' | 'ZWL (932)' | 'BYN (933)' | 'TMT (934)' | 'GHS (936)' | 'SDG (938)' | 'RSD (941)' | 'MZN (943)' | 'AZN (944)' | 'RON (946)' | 'TRY (949)' | 'XAF (950)' | 'XCD (951)' | 'XOF (952)' | 'XPF (953)' | 'XAU (959)' | 'XDR (960)' | 'XAG (961)' | 'ZMW (967)' | 'SRD (968)' | 'MGA (969)' | 'AFN (971)' | 'TJS (972)' | 'AOA (973)' | 'BGN (975)' | 'CDF (976)' | 'BAM (977)' | 'UAH (980)' | 'GEL (981)' | 'PLN (985)' | 'BRL (986)' | 'CLF (990)'
    - `Description` string, nullable — Item description
  - `VATIncluded` boolean, nullable — Is VAT included in the prices? Leave empty for false. Relevant for items only.
  - `VATRate` number, double, nullable — Document VAT Rate Leave empty for company default.
  - `DocumentType` 'Invoice (0)' | 'InvoiceAndReceipt (1)' | 'Receipt (2)' | 'ProformaInvoice (3)' | 'DonationReceipt (4)' | 'CreditInvoice (5)' | 'CreditInvoiceAndReceipt (6)' | 'CreditReceipt (7)' | 'Order (8)' | 'DeliveryNote (9)' | 'GoodsReturnNote (10)' | 'PurchasingOrder (11)' | 'PriceQuotation (12)' | 'PaymentRequest (13)' | 'CreditDonationReceipt (14)' | 'ExpenseInvoiceReceipt (15)' | 'ExpenseInvoice (16)' | 'ExpenseReceipt (17)' | 'ExpenseRequest (18)' | 'CreditExpenseInvoiceReceipt (19)' | 'CreditExpenseInvoice (20)' | 'CreditExpenseReceipt (21)' | 'SupplierPayment (22)'
  - `RedirectURL` string, nullable — URL to redirect the user on successful payment. The following parameters will be added to the URL: OG-CustomerID: Customer identifier OG-PaymentID: Payment identifier OG-ExternalIdentifier: The original ExternalIdentifier When empty, the user will be redirected to the customer payments history page
  - `CancelRedirectURL` string, nullable — URL to redirect the user on cancelled payment. The following parameters will be added to the URL: OG-ExternalIdentifier: The original ExternalIdentifier When empty, the user will be redirected to the payment page
  - `ExternalIdentifier` string, nullable — External identifier. This identifier will be appended to the RedirectURL on successful payment.
  - `MaximumPayments` integer, nullable — Maximum payments (installments) allowed on the payment page. By default, the maximum payments count is set according to the purchase pages application settings. Set to 0 to disable payments.
  - `MinimumPaymentsCredit` integer, nullable — When allowing installments, this sets the minimum number of payments, from which payments would be offered as credit transaction.
  - `SendUpdateByEmailAddress` string, nullable — Email address to which the result document will be created following payments.
  - `ExpirationHours` integer, nullable — Number of hours, in which the direct URL will expire. Defaults to 1 hours. Maximum of 240 hours (10 days).
  - `Language` 'Hebrew (0)' | 'English (1)' | 'Arabic (2)' | 'Spanish (3)'
  - `Header` string, nullable — Payment page header Defaults to the company name
  - `UpdateOrganizationOnSuccess` boolean, nullable — Send payment notification to organization on successful payment
  - `UpdateOrganizationOnFailure` boolean, nullable — Send payment notification to organization on failed payment
  - `UpdateCustomerOnSuccess` boolean, nullable — Send payment notification to customer on successful payment.
  - `DocumentDescription` string, nullable — Document description (the description is printed on the document)
  - `DraftDocument` boolean, nullable — Create draft document? Leave empty to use the application setting. Please note, when using AuthoriseOnly, documents will always be issued as "Draft".
  - `PreventSavingPaymentMethod` boolean, nullable — Prevents saving the payment method as the default payment method for the customer, following successful payment. Defaults to False
  - `TermsID` integer, nullable — Purchase page terms identifier. Requires the Purchase Pages application to be installed and the terms to exist in the organization.
  - `MerchantNumber` string, nullable

## Response `200`

OK

- ResponseOfficeGuyAppsBillingMVCAPIPaymentsControllerPaymentsBeginRedirectResponse
  - `Status` 'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
  - `UserErrorMessage` string, nullable — Error message, in a user readable format
  - `TechnicalErrorDetails` string, nullable — Technical error details, let us know if you received this.
  - `Data` OfficeGuyAppsBillingMVCAPIPaymentsControllerPaymentsBeginRedirectResponse
    - `RedirectURL` string, nullable — Payment page URL. Redirect your user to this page, in order to continue the payment process.

## Changes

- **2026-08-25** `6f1a9725c9ed` — 4 info
  - added the new optional request property `allOf[#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request]/TermsID` (media type: application/json-patch+json)
  - added the new optional request property `allOf[#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request]/TermsID` (media type: application/json)
  - added the new optional request property `allOf[#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request]/TermsID` (media type: text/json)
  - added the new optional request property `allOf[#/components/schemas/OfficeGuy.Apps.Billing.MVC.API.PaymentsController_Payments_BeginRedirect_Request]/TermsID` (media type: application/*+json)

[Change history](https://skmtc.dev/myofficeguy/apis/sumit-api-full/changes/billing/payments/beginredirect/post.md)

---

[API](https://skmtc.dev/myofficeguy/apis/sumit-api-full.md) · [All operations](https://skmtc.dev/myofficeguy/apis/sumit-api-full/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/myofficeguy/sumit-api-full/revisions/6f1a9725c9ed/schema)