Sign in

v1

latestOpenAPI 3.1.12026-08-0684304578.8 KB
Payments (Recurring)

Charge customer and create recurring payment

post/billing/recurring/charge/

Headers

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

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

Request body

SingleUseTokenstring nullable

Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID). Used primarily by the Payments JavaScript API.

UpdateCustomerByEmailboolean nullable

Update customer by email Defaults to False

UpdateCustomerByEmail_AttachDocumentboolean nullable

Attach invoice/receipt to email Defaults to False

AuthoriseOnlyboolean nullable

Should the transaction be committed, or authorized only. Leave empty for "False" (Auto-Commit). This field could be used for testing the Charge action easily. Please note, when using AuthoriseOnly, documents will be created as "Draft", and recurring items will be created as cancelled.

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)'
SendCopyToOrganizationboolean nullable

Send email to the organization as well. Defaults to the accounting application settings. Relevant when using UpdateCustomerByEmail.

VATIncludedboolean nullable

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

AttributionOffsetinteger nullable

Attribution offset in months

CreditCardPayments_Countinteger nullable

Credit card payments count. Please note this is not the recurrence (how many months the transaction should last), this parameter shouldn't be used on most use cases. Leave this empty to disable payments and use standard direct debit.

MerchantNumberstring nullable

Shva merchant number (Terminal number). This parameter should only be used when multiple merchants are defined in the company.

OnlyDocumentboolean

Generate documents without payment processing

DocumentLanguage'Hebrew (0)' | 'English (1)' | 'Arabic (2)' | 'Spanish (3)'
FirstDocumentDescriptionstring nullable

First document description. The description is shown in the first payment printed document. Please note the description will only be shown when the API requests creates a document, and won't be shown on future documents.

PreventStandingOrderboolean nullable

Prevents the usage of Standing order recurring chargers, force using debit card merchant number, when multiple merchants are supported. Defaults to false.

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.