Params-Table
Payment fields requirement by payment method
| Payment Method | Relevant Payment Fields |
|---|
| Credit Card | cc_last_4_digits, credit_term, installments_number, credit_card_brand |
| Bank Transfer | bank, bank_branch, bank_account |
| Cheque | bank, bank_branch, bank_account, cheque_number |
| Cash | |
| PayPal | paypal_account, paypal_transaction_number |
| Other | other_payment_type |
Currencies
| Code | Meaning |
|---|
| ILS | Israeli Shekel |
| USD | US Dollar |
| GBP | British Pounds |
| EUR | Euro |
| CAD | Canadian Dollar |
| CHF | Swiss Franks |
| AUD | Australian Dollar |
| DKK | Danish Krone |
| SEK | Swedish Krona |
| NOK | Norwegian Korne |
| JPY | Japanese Yen |
| JOD | Jordanian Dinar |
| HKD | Hong Kong Dollar |
Payment methods
| Code | Meaning |
|---|
| 1 | Credit Card |
| 3 | Cheque |
| 4 | Bank Transfer |
| 5 | Cash |
| 6 | PayPal |
| 10 | Other |
Country codes
Valid country ISO 3116 two letter code.
for example:
IL for Israel ISO code.
for more ISO codes visit here https://www.iban.com/country-codes
Document actions
Document types
| Code | Meaning |
|---|
| IR | Tax invoice / receipt |
| RE | Receipt |
| DI | Deal Invoice |
| IN | Tax invoice |
Amount types
| Code | Meaning |
|---|
| N | Net – VAT added to amounts |
| G | Gross – VAT extracted from amounts |
Unit types
| Code | Meaning |
|---|
| 1 | Unit |
| 2 | Gram |
| 3 | Kilogram |
| 4 | Metric Ton |
| 5 | Day |
| 6 | Week |
| 7 | Month |
| 8 | Year |
| 9 | Centimeter |
| 10 | Meter |
| 11 | Kilometer |
| 12 | MB |
| 13 | GB |
| 14 | TB |
Item types
| Code | Meaning |
|---|
| I | Item |
| S | Shipping and handling |
| C | Coupon |
Languages
| Code | Meaning |
|---|
| heb | Hebrew |
| eng | English |
Credit card brands
| Code | Meaning |
|---|
| 1 | Mastercard |
| 2 | Visa |
| 3 | Diners |
| 4 | American express |
| 5 | Isracard |
| 6 | JCB |
| 7 | Discover |
| 8 | Maestro |
Credit card credit terms
| Code | Meaning |
|---|
| 1 | Regular |
| 6 | Credit plan (isracredit/visa adif) |
| 8 | Payments |
Document relation types
| Code | Meaning |
|---|
| 1 | Cancelling document number – for whole document cancellation |
| 2 | Cancelling document id – for whole document cancellation |
Document transaction index
| Parameter | Type | Description |
|---|
| txnindex | Integer | this parameter allows you to add a transaction index to the document. It can be used to correlate the document with transactions in the Reports API |
| canceldoc | String | This parameter indicates whether the document is a credit document for a cancelled transaction. If set to Y, the created document's number will be reflected in the report response under the txnfdnumber parameter. |