Quickstart

Launch a card issuing program in 5 minutes

This guide will help you get up and running making your first GiveCard API calls in just a few minutes!

This guide assumes your business has completed onboarding and a client secret was shared. If that is not the case please contact [email protected].

1. Order a Card

It’s time to order your first card! If you’ve been designated a superbusiness, you’ll need a program key. To get your program ID, call the Get Programs endpoint.

curl

curl --request GET  
--url <https://api.dev.givecard.dev/api/v1/business/programs>  
--header 'authorization: Bearer {superbusinessAPIKey}'

If not, go ahead by adding your API key to the authorization header and order your first card.

curl

curl --request POST  
--url <https://api.dev.givecard.dev/api/v1/cards/orderAndShip>  
--header 'accept: _/_'  
--header 'authorization: {key}'  
--header 'content-type: application/json'  
--data '

{  
"shipmentMethod": "USPS_PRIORITY",  
"shippingAddress": {  
"city": "Boston",  
"country": "USA",  
"firstName": "Ada",  
"lastName": "Lovelace",  
"postalCode": "02110",  
"state": "MA",  
"street": "1 Hard Drive"  
},  
"cardCount": 1,  
}

2. Load a Card

To load the card, grab either the card’s ID or external ID off the OrderAndShipCards response.

curl

curl --request POST  
--url <https://api.dev.givecard.dev/api/v1/cards/load>  
--header 'accept: _/_'  
--header 'authorization: {key}'  
--header 'content-type: application/json'  
--data '  
{  
"cardIds": [  
{uuid}  
],  
"amount": "10.10"  
}

What’s Next

Congratulations! You have successfully integrated with the GiveCard backend. 🥳 Honestly, take a break and give yourself a pat on the back. When you're ready, continue diving deeper.

Reading through the rest of the API reference will familiarize you with important GiveCard API conventions and with all of the functionality we offer to manage your business’ money movement. If your business is designated a ‘superbusiness’, a great next step is to read more about Superbusinesses and Program IDs. If you need help, see our FAQ or feel free to reach out to [email protected] (no question is too small!). Happy coding!