all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
getMerchantAccountSettings
Human Readable Name or Caption:
Get Merchant Account Settings
Page/Function Description:
This method will get the merchant account info for a single account setting.
Page/Function Output Type:
API - JSON or WDDX
Categories:
eComm,invoice
Extra Page/Function Notes:


Parameters
Scope Name Type Default Description Required Alternates Known Values
Arguments CORP_ID Numeric 0 Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. Yes
Arguments MERCHANT_SETTING_ID Numeric 0 Pass in the merchant account setting id number. This is an auto-id number through the Adilas system if merchant processing is being used. You might have to ask an administrator to get this number. Yes


Results
RET_STATUS RET_MAIN_MESSAGE RET_SECOND_MESSAGE Redirect Link Description
ok success This assumes that everything went well.
Name Type Description Notes
QRY_ACCOUNT_INFO_ARRAY Array This is an array populated with information about the account settings. It includes values like bank id, corp id, extra settings, account name, setting id numbers, corporation names, etc.
USE_AS_LAST_TRANSACTION_NUMBER String This is the actual transaction number. This is either set to the actual transaction number or defaults to "00001000".
USE_AS_LAST_TRANSACTION_DATE String This is recorded as the actual transaction date and time. This is formatted as "[m/d/yy] at [h:mm:ss tt]".
USE_AS_LAST_TRANSACTION_INVOICE String This is the invoice number from the last transaction. See description.
USE_MAX_INVOICE_NUMBER Numeric This is the highest recorded invoice number. See description.
dataIn Unable to get the merchant account settings and information requested. Missing some data. Use your back button and try again. This is returned if the required values (corp id or merchant setting id) were not entered.
zero Unable to find the merchant account settings and information requested. Use your back button and try again. This is returned if no records were returned for the queried values.
db Unable to connect to the database. Missing the merchant account settings and information requested. Use your back button and try again. This is a catch for errors in querying from the database.


Samples
Caption Text
JSON
{"API_CALL_FUNCTION_NAME":"getMerchantAccountSettings","CORP_ID":53,"MERCHANT_SETTING_ID":4,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}