Developer Portal
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. |