Query General

Methods related querying general information such as enum values

Query enumeration values

post

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

Querystring · enumoptional

The enumeration type to query.

Example: TXStatus

Options: ACHSttatus, ACHType, AConsentType, BatchSettleMode, BatchSettleStatus, ConsentType, IntAction, IntlAction, IntlResult, IntlStatus, Period, ReceiptType, Recipient, RecurSchedStatus, TxStatus, TxType

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/Query/Enum' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "Query": "TXStatus"
  }'

200

200

{
  "Enum_QueryResult": {
    "EnumItems": [
      {
        "EnumText": "ALL",
        "EnumValue": -1
      }
    ],
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successfully Returned Enum Records : 6"
  }
}

Successfully returned enum records