DripPay API Documentation

Postman collection → OpenAPI spec →

Introduction

API for managing your account programmatically.

Welcome to the DripPay API documentation. This API allows you to programmatically create, retrieve, list, and cancel invoices.

## Authentication

This API uses **Bearer Access Tokens** for authentication. You need to generate an API token from the web dashboard at `/api-keys`.

### Token Format

Tokens are in the format: `{tokenId}|{plainTextToken}`

Example: `1|AbCdEfGhIjKlMnOpQrStUvWxYz1234567890`

### Using Your Token

Include your token in the `Authorization` header of each request:

```
Authorization: Bearer {tokenId}|{plainTextToken}
```

### Token Abilities

Each token has specific abilities that control what actions it can perform:

- **`list-invoice`**: List all your invoices
- **`view-invoice`**: View details of a specific invoice
- **`create-invoice`**: Create new invoices
- **`cancel-invoice`**: Cancel existing invoices

You can assign multiple abilities to a single token. Attempting to access an endpoint without the required ability will result in a `403 Forbidden` response.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your API token by visiting the web dashboard at /api-keys page and creating a new token with the appropriate abilities.

Default API Rate Limit is 60 Requests per Minute, however the "View invoice status" endpoint allows up to max 600 request per minute.

Invoice Management

APIs for managing invoices. All endpoints require authentication via Sanctum bearer token and specific token abilities as noted on each endpoint.

List all invoices

GET
https://drippay-dev.com
/api/v1/invoices
requires authentication

Returns a paginated list of all invoices belonging to the authenticated user.

Headers

Authorization
Example:
Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

page
integer

Page number for pagination.

Example:
1
per_page
integer

Number of items per page (default: 15, max: 100).

Example:
15
Example request: 
curl --request GET \
    --get "https://drippay-dev.com/api/v1/invoices?page=1&per_page=15" \
    --header "Authorization: Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "reference": "453ac6e9-19d9-4a1a-b904-6bb52c85c306",
            "provider": "strike",
            "provider_account_username": "accountusername",
            "provider_invoice_id": "0604cf8d-b22f-4d07-b30b-baf7d205e197",
            "machine_id": "VVM-005",
            "trade_no": "TRADE-UEI560RJIX5ZV1TYFHOK",
            "currency": "USD",
            "total": "1.00",
            "status": "paid",
            "status_label": "Paid",
            "qr_code_image_url": "https://domain.com/qr_codes/0604cf8d-b22f-4d07-b30b-baf7d205e197.webp",
            "items": [
                {
                    "reference": "7f6914a8-4809-4050-86cf-cd966a40faf9",
                    "description": "Soda",
                    "amount": "1.00000000",
                    "created_at": "2025-10-27T20:12:23+00:00"
                }
            ],
            "payment": {
                "amount": "0.00001534",
                "currency": "BTC",
                "status": "PAID",
                "status_label": "Paid",
                "completed_at": "2025-10-31T04:24:43+00:00"
            },
            "created_at": "2025-10-27T20:12:23+00:00",
            "updated_at": "2025-10-27T20:13:10+00:00"
        }
    ],
    "links": {
        "first": "http://example.com/api/v1/invoices?page=1",
        "last": "http://example.com/api/v1/invoices?page=3",
        "prev": null,
        "next": "http://example.com/api/v1/invoices?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "per_page": 15,
        "to": 15,
        "total": 42
    }
}
{
    "message": "Unauthenticated."
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Too many requests. Please try again later.",
    "retry_after_seconds": 53
}

Create a new invoice

POST
https://drippay-dev.com
/api/v1/invoices
requires authentication

Creates a new invoice with the provided items. The total is automatically calculated from the sum of all item amounts.

Headers

Authorization
Example:
Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://drippay-dev.com/api/v1/invoices" \
    --header "Authorization: Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"machine_id\": \"MACHINE-001\",
    \"trade_no\": \"TRADE-20251024-001\",
    \"currency\": \"USD\",
    \"items\": [
        {
            \"description\": \"Small Coke Can\",
            \"amount\": 1
        }
    ]
}"
Example response:
{
    "data": {
        "reference": "453ac6e9-19d9-4a1a-b904-6bb52c85c306",
        "provider": "strike",
        "provider_account_username": "accountusername",
        "provider_invoice_id": "0604cf8d-b22f-4d07-b30b-baf7d205e197",
        "machine_id": "VVM-005",
        "trade_no": "TRADE-UEI560RJIX5ZV1TYFHOK",
        "currency": "USD",
        "total": "1.00",
        "status": "pending",
        "status_label": "Pending",
        "qr_code_image_url": "https://domain.com/qr_codes/0604cf8d-b22f-4d07-b30b-baf7d205e197.webp",
        "items": [
            {
                "reference": "7f6914a8-4809-4050-86cf-cd966a40faf9",
                "description": "Soda",
                "amount": "1.00000000",
                "created_at": "2025-10-27T20:12:23+00:00"
            }
        ],
        "payment": null,
        "created_at": "2025-10-27T20:12:23+00:00",
        "updated_at": "2025-10-27T20:13:10+00:00"
    }
}
{
    "message": "Unauthenticated."
}
{
    "message": "This action is unauthorized."
}
{
    "message": "The machine ID is required. (and 3 more errors)",
    "errors": {
        "machine_id": [
            "The machine ID is required."
        ],
        "trade_no": [
            "The trade number is required."
        ],
        "currency": [
            "The currency is required."
        ],
        "items": [
            "At least one invoice item is required."
        ]
    }
}
{
    "message": "Too many requests. Please try again later.",
    "retry_after_seconds": 53
}

View a specific invoice

GET
https://drippay-dev.com
/api/v1/invoices/{reference}
requires authentication

Returns details of a specific invoice by its reference UUID.

Headers

Authorization
Example:
Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

reference
string
required

The invoice reference UUID.

Example:
9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a
Example request: 
curl --request GET \
    --get "https://drippay-dev.com/api/v1/invoices/9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a" \
    --header "Authorization: Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "reference": "453ac6e9-19d9-4a1a-b904-6bb52c85c306",
        "provider": "strike",
        "provider_account_username": "accountusername",
        "provider_invoice_id": "0604cf8d-b22f-4d07-b30b-baf7d205e197",
        "machine_id": "VVM-005",
        "trade_no": "TRADE-UEI560RJIX5ZV1TYFHOK",
        "currency": "USD",
        "total": "1.00",
        "status": "paid",
        "status_label": "Paid",
        "qr_code_image_url": "https://domain.com/qr_codes/0604cf8d-b22f-4d07-b30b-baf7d205e197.webp",
        "items": [
            {
                "reference": "7f6914a8-4809-4050-86cf-cd966a40faf9",
                "description": "Soda",
                "amount": "1.00000000",
                "created_at": "2025-10-27T20:12:23+00:00"
            }
        ],
        "payment": {
            "amount": "0.00001534",
            "currency": "BTC",
            "status": "PAID",
            "status_label": "Paid",
            "completed_at": "2025-10-31T04:24:43+00:00"
        },
        "created_at": "2025-10-27T20:12:23+00:00",
        "updated_at": "2025-10-27T20:13:10+00:00"
    }
}
{
    "message": "Unauthenticated."
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Invoice not found."
}
{
    "message": "Too many requests. Please try again later.",
    "retry_after_seconds": 53
}

Cancel an invoice

DELETE
https://drippay-dev.com
/api/v1/invoices/{reference}
requires authentication

Soft deletes an invoice and sets its status to cancelled. This action cannot be undone.

Headers

Authorization
Example:
Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

reference
string
required

The invoice reference UUID.

Example:
9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a
Example request: 
curl --request DELETE \
    "https://drippay-dev.com/api/v1/invoices/9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a" \
    --header "Authorization: Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "message": "Invoice cancelled successfully."
}
{
    "message": "Unauthenticated."
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Invoice not found."
}
{
    "message": "Too many requests. Please try again later.",
    "retry_after_seconds": 53
}

View invoice status

GET
https://drippay-dev.com
/api/v1/invoices/{invoice}/status
requires authentication

Returns status for a specific invoice by its reference UUID.

Headers

Authorization
Example:
Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

invoice
string
required

The invoice.

Example:
architecto
reference
string
required

The invoice reference UUID.

Example:
9d8e7f6a-5b4c-3d2e-1f0a-9b8c7d6e5f4a
Example request: 
curl --request GET \
    --get "https://drippay-dev.com/api/v1/invoices/architecto/status" \
    --header "Authorization: Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "status": "pending"
}
{
    "message": "Unauthenticated."
}
{
    "message": "This action is unauthorized."
}
{
    "message": "Invoice not found."
}
{
    "message": "Too many requests. Please try again later.",
    "retry_after_seconds": 53
}

System

System health and connectivity endpoints.

Ping the API

GET
https://drippay-dev.com
/api/v1/ping
requires authentication

Returns a simple pong response along with the authenticated token's abilities. Useful for testing API connectivity and token permissions.

Headers

Authorization
Example:
Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://drippay-dev.com/api/v1/ping" \
    --header "Authorization: Bearer {YOUR_TOKEN_ID}|{YOUR_TOKEN_SECRET}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "message": "pong",
    "abilities": [
        "View Invoice",
        "Create Invoice"
    ]
}
{
    "message": "Unauthenticated."
}