Quickstart
This guide will get you all set up and ready to use the Digital Pay Works API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before you can make requests to the Digital Pay Works API, you will need to grab your API key from your dashboard. You find it under Dashboard » API Keys.
Making your first API request
After generating your API key, you are ready to make your first call to the Digital Pay Works API. Below, you can see how to send a POST request to the create_checkout_payment_intent endpoint to let the service know you are opening a checkout page for the user. In the cURL example, you see we are passing in the items that make up the checkout page. This allows us to build a checkout page and invoice.
curl -X POST "https://worker-payments-resolver.hunterwbevis.workers.dev/PUBLIC_KEY/create_checkout_payment_intent" \
-H "Authorization: Bearer PRIVATE_KEY" \
-H "Content-Type: application/json" \
-d '{
"customer": {
"name": "Tim Apple",
"email": "timapple@timapple.com",
"phone_number": "123-456-7890"
},
"total_amount": 19900,
"items": [
{
"item_id": "item_1",
"quantity": 2
},
{
"item_id": "item_2",
"quantity": 1
}
],
"currency_displayed": "USD",
"tax_percent": "10",
"tax_amount": 1990,
"crypto_amount_requested": "0.00025 SOL",
"exchange_rate": "1 SOL = $284.14",
"billing_address": {
"address": "123 Main St",
"city": "New York",
"state": "NY",
"country": "USA",
"postal_code": "10001"
},
"shipping_address": {
"address": "456 Elm St",
"city": "Brooklyn",
"state": "NY",
"country": "USA",
"postal_code": "11201"
}
}'
Why is the request so huge!?
Yes, this request is quite big—but intentionally so. Instead of hiding complexities behind abstractions, we require all necessary fields to be provided directly in the API call. This ensures complete transparency, giving users a clear understanding of what’s needed to generate a checkout. No need to deal with SDKs or layers of abstraction that obscure the essential details.
What's next?
Great, you now have a checkout stored in your database. You can navigate to your dashboard page, refresh and you will now see you have a user's checkout in your table. Next, you'll want to pull in checkout page from the /checkout endpoint.