API Docs. Elcoin Ltd

Card. Close POST

Close a Card

# ENDPOINT

/api/card/closeCard/cardActionRequest

# 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: cardActionRequest

Type: object

Variable	Name	Type	Format	Usage	Description
card_code	card_code	string			Card code
reason	reason	string			Reason

# REQUEST BODY EXAMPLE

							{
  "card_code": "CARD0000114",
  "reason": "close"
}

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: HeaderResponseStatusOk

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

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# 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": "error",
    "error_description": "[INCORRECT-CARD-STATUS : Card already is closed.]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}

# Other endpoints

Name	Endpoint
Card. Create	/api/card/createCard/cardCreateRequest
Card. Activate	/api/card/activateCard/cardRequest
Card. Suspend	/api/card/suspendCard/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. Description fields request	/api/card/getItemData/cardSearchRequest
Card. Fetch sensitive data	/api/card/getCardSensitiveData/cardRequest
Card. Fetch encrypted sensitive data	/api/card/getCardEncryptedSensitiveData/cardEncryptionRequest