Developer Portal
11 JSON Request Fields
11.1 Top Level
| Name | Description |
|---|---|
| request | Request Name. This contains the request name, must be one of the following: “getPaywaySession” “getApplePaySession” “addAccount” “authorize” “trialAuthorize” “sale” “credit” “salePreAuthorized” “void” “capture” “getTransaction” “getAccount” “updateTransactionNotes” “queueSale” “queueAuthorize” “queueTrialAuthorize” “queueCredit” “sendQueuedTransaction” “hostedTransactionResults” “queueAddAccount” “sendQueuedAddAccount” “hostedAddAccountResults” |
| userName | For getPaywaySession, Payway user name |
| password | For getPaywaySession, user’s password |
| companyId | For getPaywaySession, company id for the user. This is part of the user configuration. See the PaywayAdmin application. |
| divisionId | For retrieving and adding data at the division level, for example the addAccount request. |
| accountInputMode | Specifies how the account information is added. Possible values are: “primaryAccountNumber” “magtek” “idtech” |
| paywaySessionToken | Used for all background requests except getPaywaySession. Session tokens expire after 5 minutes without being used. |
| paywayRequestToken | Used for interactive web-based requests. Returned by ‘queue’ type calls such as queueSale. |
| paywayAccountToken | Used for tokenized recurring transactions. |
| applePayToken | Used by the applePay java script. Encrypted Apple Pay data is decrypted on the PaywayWS server. |
| googlePayToken | Used by the googlePayway java script. Encrypted Google Pay data is decrypted by on the PaywayWS server. |
| transactionName | Used for requests requiring a transaction name and a source id. For example, capture and getTransaction. |
| sourceID | Used for requests requiring a transaction name and a source id. For example, capture and getTransaction. |
11.2 Card Account
| Name | Description |
|---|---|
| firstName | First name from cardholder billing data |
| middleName | Middle name. Usually blank, not part of card processing |
| lastName | Last name from cardholder billing data |
| address | Address from cardholder billing data, may include unit number, apartment, etc. |
| city | City from cardholder billing data |
| state | State or province |
| zip | Zip code (US) or province code (CAD). It is strongly recommended to have at least zip available to reduce merchant fees and ideally as much of the cardholder name and address information as is available should be populated. |
| phone | Cardholder phone number. Optional, not part of card processing data. |
| accountNumber | Credit card account number. Required. |
| expirationDate | Expiration date in mmyy or mmyyyy format. Required. |
| p2peInput | For Payway P2PE devices, output of device goes in this field and is decrypted by Payway. |
| Email of the cardholder. | |
| fsv | Fraud security value (3 digits or 4 digits for AMEX) |
| accountNotes1 | Account notes, optional data up to 128 bytes |
| accountNotes2 | Account notes, optional data up to 128 bytes |
| accountNotes3 | Account notes, optional data up to 128 bytes |
11.3 Card Transaction
| Name | JSON Object | Description |
|---|---|---|
| name | Unique name of the card transaction. Names must be unique within a division. If name field is empty, Payway will assign a unique transaction name that is returned with transaction replies. Required if not assigned by payway. |
|
| amount | Amount IN PENNIES. Ex $1.23 submitted as ‘123’ Required. |
|
| tax | Tax amount IN PENNIES. Ex $1.23 submitted as ‘123.’ Tax cannot be more than the ‘amount.’ |
|
| eciType | 1 → MOTO Indicator/ Single Transaction mail/telephone order: designates a transaction where the cardholder is not present at a merchant location and consummates the sale via the phone or through the mail. The transaction is not for recurring services or product and does not include sales that are processed via an installment plan. 2 → MOTO Indicator – Recurring Transaction: designates a transaction that represents an arrangement between a cardholder and the merchant where transactions are going to occur on a periodic basis. Required for all Card On File (COF) transactions including ApplePay and GooglePay. 3 → MOTO Indicator – Installment Payment: designates a group of transactions that originated from a single purchase where the merchant agrees to bill the cardholder in installments. 4 → MOTO Indicator – Deferred Transaction: designates a transaction that represents an order with a delayed payment for a specified amount of time. 5 → ECI Indicator – Secure Electronic Commerce Transaction: designates a transaction between a cardholder and a merchant consummated via the Internet where the transaction was successfully authenticated and includes the management of a cardholder certificate. (e.g. 3-D Secure Transactions). All original wallet transactions from ApplePay and GooglePay are an ECI of 5 EXCEPT VISA for ApplePay which is a 7. Note this value is supplied by GooglePay and ApplePay. 6 → ECI Indicator – Non-Authenticated Electronic Commerce Transaction: designates a transaction consummated via the Internet at a 3-D Secure capable merchant that attempted to authenticate the cardholder using 3-D Secure. (e.g. 3-D Secure includes Verified by Visa and MasterCard SecureCode) Attempts occur with Verified by Visa and MasterCard SecureCode transactions in the event of: a. A non-participating Issuer b. A non-participating cardholder of a participating Issuer c. A participating Issuer, but the authentication server is not available 7 → ECI Indicator – Channel Encrypted Transaction: designates a transaction between a cardholder and a merchant consummated via the Internet where the transaction includes the use of transaction encryption such as SSL, but authentication was not performed. The cardholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. Generally, the first initial B2C transaction. 8 → ECI Indicator – Non-Secure Electronic Commerce Transaction: designates a transaction between a cardholder and a merchant consummated via the Internet where the transaction does not include the use of any transaction encryption such as SSL, no authentication performed, no management of a cardholder certificate. R → Retail Indicator – designates a transaction where the cardholder was present at a merchant location. If an “R” is sent for a transaction with a MOTO Merchant Category Code (MCC), the transaction will downgrade. Required. |
|
| processorSoftDescriptor | Optional value, doing business as (DBA) description. Some merchant configurations must be pre-enabled for soft descriptors. Contact payway support for more information. Settlements will fail if this value is sent and the customer’s merchant is not configured to accept soft descriptors. This value will display on the consumer’s card statement. Required for a recurring subscription transaction that is part of a discounted offer or package per VISA regulations. |
|
| transactionNotes1 | Transaction notes fields are optional, these can contain notes regarding the transaction, or an order or customer number to be used for tracking on Payway. Notes fields are searchable on Payway. Maximum length 64 bytes. | |
| transactionNotes2 | Transaction notes fields are optional. These can contain notes regarding the transaction, or an order or customer number to be used for tracking on Payway. Notes fields are searchable on Payway. Maximum length 32 bytes. | |
| transactionNotes3 | Transaction notes fields are optional, these can contain notes regarding the transaction, or an order or customer number to be used for tracking on Payway. Notes fields are searchable on Payway. Maximum length 32 bytes. | |
| testResultAvs | For Testing only. This value will be set as the AVS Results upon return. | |
| testResultFsv | For Testing only. This value will be set as the FSV Results upon return. |