Skip to content

Card API

atsanan edited this page Sep 16, 2020 · 4 revisions

2. Card

[x] 2.1 Get Card list

GET /api/v1/card/list?page=0&limit=10

Query parameters:

Field Description Optional Default Auth
page Current page of Card list Yes 0 Yes
limit Maximum page of Card list Yes 10 Yes

Returns:

{
    "data": {
        "card": [
            {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientCode":"card2u",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "cardKey":"-M5zbKvgf-QIbPGo6HL0",
                "cardName":"Card Global test",
                "cardType":"G",
                "expire": "2020-09-16T22:35:30Z",
                "limit":1000,
                "preload":false,
                "status":true,
                "V1":false,
                "V1T":"",
                "V2":false,
                "V2T":"",
                "V3":false,
                "V3T":"",  
                "V4":false,
                "V4T":"",  
                "V5":false,
                "V5T":"",  
                "address":false,
                "dateOfBirth":false,
                "gender":false,
                "email":false,
                "mobile":false,
                "nationalID":false,
                "updated_at": "2020-09-16T22:35:30Z"
            }
        ],
        "pageIndex": -1,
        "pageLimit": -1,
        "pages": 1,
        "paging": {
            "next": "",
            "previous": ""
        }
    },
    "isSuccess": true
}

[x] 2.2 Get Card Detail

GET /api/v1/card/{id:string}

Returns:

{
    "data": {
        "card": {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientCode":"card2u",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "cardKey":"-M5zbKvgf-QIbPGo6HL0",
                "cardName":"Card Global test",
                "cardType":"G",
                "expire": "2020-09-16T22:35:30Z",
                "limit":1000,
                "preload":false,
                "status":true,
                "V1":false,
                "V1T":"",
                "V2":false,
                "V2T":"",
                "V3":false,
                "V3T":"",  
                "V4":false,
                "V4T":"",  
                "V5":false,
                "V5T":"",  
                "address":false,
                "dateOfBirth":false,
                "gender":false,
                "email":false,
                "mobile":false,
                "nationalID":false,
                "updated_at": "2020-09-16T22:35:30Z"
            }
       
    },
    "isSuccess": true
}

[x] 2.3 Add Card

POST /api/v1/card/add

Form data:

Field Description Optional Auth
clientCode No
clientKey No
cardKey No
cardName No
cardType No
expire No
limit No
preload No
status No
V1 No
V1T No
V2 No
V2T No
V3 No
V3T No
V4 No
V4T No
V5 No
V5T No
address No
dateOfBirth No
gender No
email No
mobile No
nationalID No

Returns:

{
    "data": {
        "card": {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientCode":"card2u",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "cardKey":"-M5zbKvgf-QIbPGo6HL0",
                "cardName":"Card Global test",
                "cardType":"G",
                "expire": "2020-09-16T22:35:30Z",
                "limit":1000,
                "preload":false,
                "status":true,
                "V1":false,
                "V1T":"",
                "V2":false,
                "V2T":"",
                "V3":false,
                "V3T":"",  
                "V4":false,
                "V4T":"",  
                "V5":false,
                "V5T":"",  
                "address":false,
                "dateOfBirth":false,
                "gender":false,
                "email":false,
                "mobile":false,
                "nationalID":false,
                "updated_at": "2020-09-16T22:35:30Z"
            }
       
    },
    "isSuccess": true
}

[x] 2.4 Edit Card

POST /api/v1/card/{id}

Form data:

Field Description Optional Auth
clientCode No
clientKey No
cardKey No
cardName No
cardType No
expire No
limit No
preload No
status No
V1 No
V1T No
V2 No
V2T No
V3 No
V3T No
V4 No
V4T No
V5 No
V5T No
address No
dateOfBirth No
gender No
email No
mobile No
nationalID No

Returns:

{
    "data": {
        "card": {
                "_id": "5bb772fc68efd87103266963",
                "created_at": "2020-09-16T11:22:16.859Z",
                "clientCode":"card2u",
                "clientKey":"M4wJXSXEhIZJEAUDBLD",
                "cardKey":"-M5zbKvgf-QIbPGo6HL0",
                "cardName":"Card Global test",
                "cardType":"G",
                "expire": "2020-09-16T22:35:30Z",
                "limit":1000,
                "preload":false,
                "status":true,
                "V1":false,
                "V1T":"",
                "V2":false,
                "V2T":"",
                "V3":false,
                "V3T":"",  
                "V4":false,
                "V4T":"",  
                "V5":false,
                "V5T":"",  
                "address":false,
                "dateOfBirth":false,
                "gender":false,
                "email":false,
                "mobile":false,
                "nationalID":false,
                "updated_at": "2020-09-16T22:35:30Z"
            }
       
    },
    "isSuccess": true
}

[x] 2.5 Delete Card

DELETE /api/v1/card/{id:string}

Returns:

{
    "data": {
        "message": "Success Delete"
    },
    "isSuccess": true
}

Clone this wiki locally