v1

OpenAPI 3.1.12026-08-0684304578.8 KB

Accounting (Customers)4

Accounting (Documents)10

Accounting (General)6

Accounting (IncomeItems)2

Books (Transactions)1

Credit card terminal (Billing)3

Credit card terminal (Gateway)4

Credit card terminal (Vault)3

CRM (Data)9

CRM (Schema)2

CRM (Views)1

Customer service (Tickets)1

Deals (Deals)2

Email subscriptions (MailingLists)2

Outgoing faxes (Fax)1

Payments (GeneralBilling)2

Payments (PaymentMethods)3

Payments (Payments)5

Payments (Recurring)5

Scheduled documents (Documents)1

SMS subscriptions (MailingLists)2

SMS subscriptions (SMS)3

Stock management (Stock)1

Triggers (Triggers)2

Website (Companies)5

Website (Permissions)2

Website (Users)2

Credit card terminal (Gateway)

Credit card transaction

This method should be used in rare occasions. For common use scenarios, refer to "Payments -> Charge customer" method.

post/creditguy/gateway/transaction/

Headers

{"stackTrail":"paths:/creditguy/gateway/transaction/:post:parameters:0:schema","oasType":"schema","type":"unknown"}

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

Request body

ParamJ'CheckDetails (2)' | 'Charge (4)' | 'AuthorizeOnly (5)' required

CardNumberstring nullable

Full card number Leave this empty when using FormatPreservingToken/CardToken/SingleUseToken

FormatPreservingTokenstring nullable

Format preserving card number Leave this empty when using CardNumber/CardToken/SingleUseToken

CardTokenstring uuid nullable

Card token Leave this empty when using CardNumber/FormatPreservingToken/SingleUseToken

SingleUseTokenstring nullable

Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID). Used primarily by the Payments JavaScript API. (Leave this empty when using CardNumber/FormatPreservingToken/CardToken)

ExpirationMonthinteger nullable

Card expiration month (1-12) Leave this empty when using SingleUseToken

ExpirationYearinteger nullable

Card expiration year (4 digits) Leave this empty when using SingleUseToken

Amountnumber double

Transaction amount Leave this empty when using ParamJ = CheckDetails

PaymentsNonFirstCountinteger nullable

Non-first payments count Leave this empty for non-payments transaction

PaymentsFirstAmountnumber double nullable

First payment amount Leave this empty for non-payments transaction

PaymentsNonFirstAmountnumber double nullable

Non-first payment amount Leave this empty for non-payments transaction

AuthNumberstring nullable

Transaction authorization number

CVVstring nullable

Card CVV/CVV2

Track2string nullable

Card Track2

CitizenIDstring nullable

Israel Citizen ID / Passport Number

Currency'ILS (0)' | 'USD (1)' | 'EURO (2)'

Languagestring nullable

Transaction language Leave this empty to use the company default language

UniqueIdentifierstring nullable

Unique transaction identifier. This parameter can be used for preventing duplicate transactions

MerchantNumberstring nullable

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

TransactionType'Debit (1)' | 'StandingOrder (11)' | 'Credit (51)' | 'CreditEMV (53)'

CustomData_1string nullable