Sign in

v1

latestOpenAPI 3.1.12026-08-0684304578.8 KB
Payments (Payments)

Charge customer

post/billing/payments/charge/

Headers

{"stackTrail":"paths:/billing/payments/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.

CreditCardAuthNumberstring nullable

Transaction authorization number, as received from a previous Gateway Transaction

Payments_Creditboolean nullable

Credit payments (עסקת קרדיט באשראי) Defaults to False

Payments_Countinteger nullable

Payments count Leave this empty to disable payments

Payments_FirstAmountnumber double nullable

First payment amount Leave this empty to disable payments / automatic payments calculating

Payments_NonFirstAmountnumber double nullable

Non-first payment amount Leave this empty to disable payments / automatic payments calculating

UpdateCustomerByEmailboolean nullable

Update customer by email (notification email, with invoice/receipt download link) Leave this empty to disable email sending feature

UpdateCustomerByEmail_AttachDocumentboolean nullable

Attach invoice/receipt to email Defaults to False

UpdateCustomerByEmail_Language'Hebrew (0)' | 'English (1)' | 'Arabic (2)' | 'Spanish (3)'
SendDocumentByEmailboolean nullable

Send invoice/receipt by email

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

Document description (the description is printed on the document)

VATIncludedboolean nullable

Is VAT included in the prices? Defaults to false

VATRatenumber double nullable

Document VAT Rate Leave empty for company default. Relevant for items only.

AuthoriseOnlyboolean nullable

Should the transaction be processed, or only validated. 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 issued as "Draft".

DraftDocumentboolean nullable

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

PreventDocumentCreationboolean nullable

Prevents document creation following valid payment By default, all valid payments issue documents (final, or draft according to the DraftDocument parameter). Setting PreventDocumentCreation will prevent the automatic document creation.

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

Allow credit instead of charge (debit), in case the total is less than 0? Defaults to false

MerchantNumberstring nullable

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

SendCopyToOrganizationboolean nullable

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

CardTokenNotNeededboolean nullable

Avoids generating credit card token and saving it on the customer payment method. Defaults to False

AutoCaptureboolean nullable

Should the credit card transaction be captured automatically (J4), or only authorized (J5). Leave empty for "True" (Auto capture). Please note, when setting AutoCapture to false, "Order" documents will be issued instead of invoices/receipts.

AuthorizeAmountnumber double nullable

Allows custom authorization amount, other than the specified items.

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.