Create Card
It’s pretty simple to create a virtual card. Check the example in the box below for details.
POST https://vcard-api.paycertify.com/api/vcards
Parameter | Type | Presence | Description | Example |
---|---|---|---|---|
type |
string |
required | The vcard type | single_use |
meta |
object |
optional | A object to send metadata. It should be asked the configuration of these fields. | { ‘your_attribute_name’: ‘value’ } |
provider_id |
uuid |
optional | Provider ID | 89bfc6e4-931a-42ff-b8d6-945e28b5dc80 |
first_name |
string |
required | Person’s name | John |
last_name |
string |
required | Person’s last name | Doe |
street_address1 |
string |
required | Address 1 | 17770 Daves Ave |
street_address2 |
string |
present | Address 2 | 17771 Daves Ave |
zip |
string |
required | Zip code | 91343 |
city |
string |
required | City name | Los Gatos |
state |
string |
required | Alpha-2 state code | CA |
country |
string |
required | Alpha-2 country code | US |
email |
string |
required | Person’s e-mail | [email protected] |
phone |
string |
required | Person’s phone | 5555551234 |
amount |
float |
required | Card amount | 200.50 |
Field | Type | Description | Example |
---|---|---|---|
id |
uuid |
The vcard ID | 9d616a21-e85f-423a-90e2-e2dd52d7f2ff |
type |
string |
Card type | single_use |
meta |
object |
A object with 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_cvv |
string |
Vcard cvv | 123 |
amount |
float |
Card amount | 200.50 |
curl -X POST \
https://vcard-api.paycertify.com/api/vcards \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"vcard" : {
"type": "single_use",
"meta": {
"your_attribute_name": "value"
},
"provider_id": "89bfc6e4-931a-42ff-b8d6-945e28b5dc80",
"first_name" : "John",
"last_name" : "Doe",
"street_address1" : "17770 Daves Ave",
"street_address2" : "17771 Daves Ave",
"zip" : "91343",
"city" : "Los Gatos",
"state" : "CA",
"country" : "US",
"email" : "[email protected]",
"phone" : "5555551234",
"amount": 200.50
}
}'
Responds with:
{
"vcards": {
"id": "1f636e5f-999a-4bfe-b2d9-3190f40f957a",
"type": "single_use",
"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"
}
}