Get Card
Request URL
GET /cards/:AFiCardId
Description
This endpoint returns a record for a single card belonging to this user. The card is identified by a path parameter.
Some fields may vary depending on the requirements of the back office. Also, some fields such as name
and pin
are stored by the back office only and are not saved by ampliFi.
Snippet Examples
javascript
const axios = require('axios');
const config = {
method: 'GET',
url: '${AMPLIFI_BASE_URL}/cards/:AFiCardId',
headers: {
'token': "A long random string token received from /token request"
},
};
let result;
try {
result = await axios.request(config);
if (result.status === 200) {
console.log(JSON.stringify(result.data));
}
} catch (err) {
console.log({
errCode: err.code,
responseStatus: err.response && err.response.status,
data: err.response && JSON.stringify(err.response.data)
});
}
cURL
curl --location "AMPLIFI_BASE_URL/cards/:AFiCardId" --header "token: A long random string token received from /token request"
Successful Response Examples
200 CARDS/:AFICARDID SUCCESSFUL RESPONSE RETRIEVING A SPECIFIC CARD FOR THE CURRENT USER
HEADERS
Header | Value |
---|---|
token | A long random string token received from /token request |
PARAMETERS
Parameter | Description | Value |
---|---|---|
AFiCardId | [required] | qwecdlgmgtddkabyzkuaibfraesqglomhadsmctvbzi |
REQUEST BODY
RESPONSE BODY
{
"card": {
"_id": "643ec1df30bdadc1e3441e06",
"AFiCardId": "qwecdlgmgtddkabyzkuaibfraesqglomhadsmctvbzi",
"AFiUserId": "qweaurl8kgtlv9pc",
"backOfficeId": "evolve"
},
"success": true,
"userId": "qweaurl8kgtlv9pc"
}
200 CARDS/:AFICARDID SUCCESSFUL RESPONSE RETRIEVING A SPECIFIC CARD FOR THE CURRENT USER
HEADERS
Header | Value |
---|---|
token | A long random string token received from /token request |
PARAMETERS
Parameter | Description | Value |
---|---|---|
AFiCardId | [required] | qwegalgnuyocdfoxg |
REQUEST BODY
RESPONSE BODY
{
"card": {
"_id": "64400ae79ccda06688170931",
"AFiCardId": "qwegalgnuyocdfoxg",
"backOfficeId": "evolve",
"AFiAccountId": "qwegalgnuyocdfoxg",
"AFiUserId": "qweaurl8kgtlv9pc",
"accountIdBO": "cd_5cws26xjxlfbb",
"backOfficeName": "evolve",
"cardIdBO": "cd_5cws26xjxlfbb",
"currency": "USD",
"dtsExpiry": "2026-05-01T03:59:59.999Z",
"dtsOpened": "2023-04-19T15:38:14.436Z",
"id": "qwegalgnuyocdfoxg",
"image": "images/card3.png",
"isActivated": false,
"isActive": false,
"isClosed": false,
"name_on_card": "JOHN TESTMAN",
"num": "123456******1234",
"status": "blocked",
"typeId": "virtual",
"cvv": "040",
"expiryMMYY": "046",
"fullPan": "1234561234561234",
"dtsUpdated": "2023-12-11T14:19:43.915Z"
},
"success": true,
"userId": "qweaurl8kgtlv9pc"
}