Schemas Postman

Card. Description fields request GET

Get Card filter model

# ENDPOINT
/api/card/getItemData/cardSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		DEV-SKIP DEV-SKIP M
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M
Example DEV-SKIP
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: itemsForm
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object data of Response
attribute: data
Variable Name Type Format Description
id id string
fieldName fieldName string
fieldValue fieldValue string
fieldLabel fieldLabel string
fieldPosition fieldPosition string
fieldType fieldType string
fieldFormat fieldFormat string
fieldAction fieldAction string
fieldHelpBox fieldHelpBox string
fieldVisible fieldVisible boolean
fieldReadOnly fieldReadOnly boolean
fieldRestricted fieldRestricted boolean
fieldChanged fieldChanged boolean
fieldDefault fieldDefault string
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 4,
    "data": [
        {
            "id": 0,
            "fieldName": "card_code",
            "fieldValue": "",
            "fieldLabel": "Card code",
            "fieldPosition": 1000,
            "fieldType": "CHARACTER",
            "fieldFormat": "",
            "fieldAction": "EDIT",
            "fieldHelpBox": "",
            "fieldVisible": true,
            "fieldReadOnly": false,
            "fieldRestricted": false,
            "fieldMandatory": false,
            "fieldChanged": false,
            "fieldDefault": ""
        },
        {
            "id": 0,
            "fieldName": "account",
            "fieldValue": "",
            "fieldLabel": "Account",
            "fieldPosition": 2000,
            "fieldType": "CHARACTER",
            "fieldFormat": "",
            "fieldAction": "EDIT",
            "fieldHelpBox": "modules.account.HelpBoxes.accountHelpBox",
            "fieldVisible": true,
            "fieldReadOnly": false,
            "fieldRestricted": false,
            "fieldMandatory": false,
            "fieldChanged": false,
            "fieldDefault": ""
        },
        {
            "id": 0,
            "fieldName": "client_code",
            "fieldValue": "",
            "fieldLabel": "Code",
            "fieldPosition": 3000,
            "fieldType": "CHARACTER",
            "fieldFormat": "",
            "fieldAction": "EDIT",
            "fieldHelpBox": "modules.clients.HelpBoxes.clientHelpBox",
            "fieldVisible": true,
            "fieldReadOnly": false,
            "fieldRestricted": false,
            "fieldMandatory": false,
            "fieldChanged": false,
            "fieldDefault": ""
        },
        {
            "id": 0,
            "fieldName": "card_status",
            "fieldValue": "",
            "fieldLabel": "Card status",
            "fieldPosition": 4000,
            "fieldType": "CHARACTER",
            "fieldFormat": "",
            "fieldAction": "only_with_help",
            "fieldHelpBox": "enum://system.api.card.cardStatusEnum",
            "fieldVisible": true,
            "fieldReadOnly": false,
            "fieldRestricted": false,
            "fieldMandatory": false,
            "fieldChanged": false,
            "fieldDefault": ""
        }
    ]
}
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# Other endpoints
Name Endpoint
Card. Create /api/card/createCard/cardCreateRequest
Card. Activate /api/card/activateCard/cardRequest
Card. Suspend /api/card/suspendCard/cardActionRequest
Card. Close /api/card/closeCard/cardActionRequest
Card. Get PIN /api/card/getCardPin/cardRequest
Card. Reset PIN /api/card/resetCardPin/cardRequest
Card. Fetch temporary Image URL by card code /api/card/getCardTempImageUrl/cardRequest
Card. Fetch data by request /api/card/getData/cardSearchRequest
Card. Fetch card delivery address by card code /api/card/getCardDeliveryAddress/cardRequest
Card. Fetch data by card code /api/card/getCard/cardRequest
Card. Fetch sensitive data /api/card/getCardSensitiveData/cardRequest
Card. Fetch encrypted sensitive data /api/card/getCardEncryptedSensitiveData/cardEncryptionRequest