Show Card
This endpoint provide information of one virtual card. We expect that you send the id (uuid) in your request.
GET https://vcard-api.paycertify.com/api/vcards/{vcard_id}
Field | Type | Description | Example |
---|---|---|---|
id |
uuid |
The vcard ID | 42e012cf-d007-4b15-bd44-8a1806bcaf6e |
Field | Type | Description | Example | |
---|---|---|---|---|
id |
uuid |
The vcard ID | 42e012cf-d007-4b15-bd44-8a1806bcaf6e | |
type |
string |
Card type | single_use | |
meta |
object |
optional | A object that contains metadata. | { ‘your_attribute_name’: ‘value’ } |
provider_id |
uuid |
Provider ID | 89bfc6e4-931a-42ff-b8d6-945e28b5dc80 | |
merchant_id |
uuid |
Merchant ID | 98e2c511-bf77-4893-a16c-23d593a530ad | |
first_name |
string |
Person’s name | John | |
last_name |
string |
Person’s last name | Doe | |
street_address1 |
string |
Address 1 | 17770 Daves Ave | |
street_address2 |
string |
Address 2 | 17771 Daves Ave | |
zip |
string |
Zip code | 91343 | |
city |
string |
City name | Los Gatos | |
state |
string |
Alpha-2 state code | CA | |
country |
string |
Alpha-2 country code | US | |
email |
string |
Person’s e-mail | [email protected] | |
phone |
string |
Person’s phone | 5555551234 | |
external_id |
uuid |
External ID | befb57e1-e042-335a-8516-73be1423bada | |
card_number |
string |
Vcard number | 5326137298354870 | |
card_expiry_month |
string |
Expiration month | 08 | |
card_expiry_year |
string |
Expiration year | 2020 | |
card_brand |
string |
Card brand | visa | |
amount |
float |
Card amount | 200.50 | |
status |
string |
Actual card status | active | |
available_amount |
float |
Available amount of the card | 100.50 | |
is_cancelable |
boolean |
If the card is cancelable | true | |
created_at |
date |
Card creation date | 2020-04-03T09:09:53+0000 |
curl --request GET \
--url https://vcard-api.paycertify.com/api/vcards/42e012cf-d007-4b15-bd44-8a1806bcaf6e \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
Responds with:
{
"vcards": {
"id": "1f636e5f-999a-4bfe-b2d9-3190f40f957a",
"type": "reload",
"meta": {
"your_attribute_name": "value"
},
"provider_id": "89bfc6e4-931a-42ff-b8d6-945e28b5dc80",
"merchant_id": "98e2c511-bf77-4893-a16c-23d593a530ad",
"first_name": "Mike",
"last_name": "Hill",
"street_address1": "Street 1",
"street_address2": "Street 2",
"zip": "1234654",
"city": "Los Gatos",
"state": "CA",
"country": "US",
"email": "[email protected]",
"phone": "112223333444",
"external_id": "ba756e55-71c3-429e-b28c-f2d9fd275a0e",
"card_number": "518002******9178",
"card_expiry_month": 01,
"card_expiry_year": 2024,
"card_brand": "master",
"amount": 500,
"status": "active",
"available_amount": 356.89,
"is_cancelable": true,
"created_at": "2020-04-03T09:09:53+0000"
}
}