API Docs. Elcoin Ltd

Card. Fetch data by request POST

Get Card data by request

# ENDPOINT

/api/card/getData/cardSearchRequest

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0	DEV-SKIP	DEV-SKIP	M

# REQUEST BODY

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M
Example	DEV-SKIP

# REQUEST BODY

Schema: cardSearchRequest

Type: object

Variable	Name	Type	Format	Description
account	account	string		account
card_code	card_code	string		Card code
card_scheme	card_scheme	string		card scheme List of allowed values in field (value=>name): 0 CONNPAY 1 RAILSBANK
card_status	Card Status	string		Card Status List of allowed values in field (value=>name): 0 ACTIVATING 1 ACTIVE 2 AWAITING_ACTIVATION 3 CLOSED 4 CREATED 5 CREATING 6 FAILED 7 INTERNAL_ERROR 8 PENDING 9 REACTIVATING 10 SUSPENDED 11 SUSPENDING
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
holder_counterparty_code	Holder counterparty code	STRING
holder_counterparty_id	Holder counterparty id	INTEGER
limit	limit	integer	int64	Count records for part data to get
offset_version	Offset version	INTEGER
offsetid	Offsetid	integer
page	page	integer	int64	Part data with number of page
page_changes_version_offset	Page changes version offset	INTEGER
skip_total_records	Skip total records	boolean		List of allowed values in field (value=>name): 0 false 1 true

# REQUEST BODY EXAMPLE

							{
  "card_code": "CARD00000AM",
  "account": "",
  "client_code": "EN003GF4P",
  "card_status": ""
}

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: card

Type: application/json

Variable	Name	Type	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	array	data of Response

attribute: data

Variable	Name	Type	Format	Description
account	account	string		account
action	Action	string
activation_date	Activation Date	string	DATE	Activation date in the system
card_code	card_code	string		Card code
card_programme	Card programme	string
card_scheme	card_scheme	string		card scheme
card_status	Card Status	string		Card Status
card_type	card_type	string		Type of card
carrier_type	carrier_type	string		Type of carrier
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
close_date	Close Date	string	DATE	Client close date in the system
create_date	Create Date	string	DATETIME	The date entry was created on
create_user	Create User	string		The username of ABS user who has created an entry
delivery_method	delivery_method	string		Type of delivery method
delivery_name	delivery_name	string		Delivery name
design_code	design_code	string		Design code
email	email	string		Email address of a given user
error_description	Error Description	string		Description of error
expiry_date	Expiry date	string
external_id_in_scheme	External id in scheme	string
form_title	form_title	string		Service field
full_delivery_address	full_delivery_address	string		Full delivery address
full_name	full_name	string		Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
holder_counterparty_code	Holder counterparty code	STRING
holder_counterparty_id	Holder counterparty id	INTEGER
holder_full_name	Holder full name	STRING
id	id	integer	INT64	Record's sequence number generated in the system.
modify_date	Modify Date	string	DATETIME	The date entry was last modified on
modify_user	Modify User	string		The username of ABS user who has made last changes to the entry
name_on_card	name_on_card	string		Name on card
pan	Pan	string
state	state	integer	INT64	Record state for replication
telephone	Telephone	STRING
token	Token	string
truncated_pan	Truncated pan	string
uid	uid	string		Unique record identifier which is used to distinguish between existing records
version	version	integer	INT64	Record version for replication

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 1,
    "data": [
        {
            "id": 3,
            "uid": "cc618204-d391-5daa-7614-b04cd0be2b1e",
            "version": 514724256,
            "state": 0,
            "modify_date": "2020-12-21T17:54:19.221",
            "modify_user": "root",
            "create_date": "2020-12-11T01:41:53.777",
            "create_user": "root",
            "card_code": "CARD00000AM",
            "card_scheme": "RAILSBANK",
            "client_code": "EN003GF4P",
            "account": "60003GF4030EURP",
            "name_on_card": "OLEGS SMIRNOVS",
            "card_type": "physical",
            "carrier_type": "standard",
            "delivery_method": "dhl",
            "delivery_name": "",
            "design_code": "DESIGN1",
            "pan": "",
            "card_status": "CLOSED",
            "error_description": "",
            "truncated_pan": "8360",
            "external_card_status": ""
        }
    ]
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError

Type: application/json

Variable	Name	Type	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

# RESPONSE NEGATIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 0,
    "data": []
}

# 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 card delivery address by card code	/api/card/getCardDeliveryAddress/cardRequest
Card. Fetch data by card code	/api/card/getCard/cardRequest
Card. Description fields request	/api/card/getItemData/cardSearchRequest
Card. Fetch sensitive data	/api/card/getCardSensitiveData/cardRequest
Card. Fetch encrypted sensitive data	/api/card/getCardEncryptedSensitiveData/cardEncryptionRequest