Sign in

v1

latestOpenAPI 3.1.12026-08-0684304578.8 KB
Payments (Payments)

Begin redirect for transaction

post/billing/payments/beginredirect/

Headers

{"stackTrail":"paths:/billing/payments/beginredirect/:post:parameters:0:schema","oasType":"schema","type":"unknown"}

Sets the content response language. Defaults to Hebrew (he).

Request body

VATIncludedboolean nullable

Is VAT included in the prices? Leave empty for false. Relevant for items only.

VATRatenumber 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)'
RedirectURLstring 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

CancelRedirectURLstring 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

ExternalIdentifierstring nullable

External identifier. This identifier will be appended to the RedirectURL on successful payment.

MaximumPaymentsinteger 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.

MinimumPaymentsCreditinteger nullable

When allowing installments, this sets the minimum number of payments, from which payments would be offered as credit transaction.

SendUpdateByEmailAddressstring nullable

Email address to which the result document will be created following payments.

ExpirationHoursinteger 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)'
Headerstring nullable

Payment page header Defaults to the company name

UpdateOrganizationOnSuccessboolean nullable

Send payment notification to organization on successful payment

UpdateOrganizationOnFailureboolean nullable

Send payment notification to organization on failed payment

UpdateCustomerOnSuccessboolean nullable

Send payment notification to customer on successful payment.

DocumentDescriptionstring nullable

Document description (the description is printed on the document)

DraftDocumentboolean nullable

Create draft document? Leave empty to use the application setting. Please note, when using AuthoriseOnly, documents will always be issued as "Draft".

PreventSavingPaymentMethodboolean nullable

Prevents saving the payment method as the default payment method for the customer, following successful payment. Defaults to False

MerchantNumberstring nullable

Response

OK

Status'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
UserErrorMessagestring nullable

Error message, in a user readable format

TechnicalErrorDetailsstring nullable

Technical error details, let us know if you received this.