API Reference

Authentication

All calls must be authenticated with the header Authorization: llamapay_sk_YOUR_API_KEY. You can obtain the required API Key in the Developer tab on LlamaPay's interface.

Create a new payment

Creates a new payment that users can then pay

post

/charges

Authorizations

Body

redirect_urlstring

Example: https://mypage.com/success

cancel_urlstring

Example: https://mypage.com/failure

pricing_typestring · enum

Options: fixed_price, no_price, subscription

local_priceobject

Example: {"amount":"10.00","currency":"USD"}

metadataobject

Example: {"userId":"0xngmi"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.llamapay.io/charges' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"redirect_url":"https://mypage.com/success","cancel_url":"https://mypage.com/failure","pricing_type":"fixed_price","local_price":{"amount":"10.00","currency":"USD"},"metadata":{"userId":"0xngmi"}}'

200

401

200

{
  "data": {
    "id": "3e66112f-e4ad-4d5d-acb2-332e18fe4e4f",
    "hosted_url": "https://checkout.llamapay.io/pay/3e66112f-e4ad-4d5d-acb2-332e18fe4e4f",
    "created_at": "2024-07-01T04:57:41.034Z",
    "pricing_type": "fixed_price",
    "metadata": {
      "userId": "0xngmi"
    }
  }
}

Successfully created a payment

Fetch a paginated list of payments

Pagination is handled by querying the urls returned in pagination.previous_uri and pagination.next_uri or by using the query parameters ending_before and starting_after directly with payment ids. In other words, to see all results keep querying pagination.next_uri until its null.

get

/charges

Authorizations

Query parameters

starting_afterstring

Optional and for pagination, filters results to those whose id parameters are higher than the id sent

ending_beforestring

Optional and for pagination, filters results to those whose id parameters are lower than the id sent

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.llamapay.io/charges' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "data": [
    {
      "id": "3e66112f-e4ad-4d5d-acb2-332e18fe4e4f",
      "hosted_url": "https://checkout.llamapay.io/pay/3e66112f-e4ad-4d5d-acb2-332e18fe4e4f",
      "created_at": "2024-07-01T04:57:41.034Z",
      "pricing_type": "fixed_price",
      "metadata": {
        "userId": "0xngmi"
      }
    }
  ],
  "pagination": {
    "previous_uri": "https://api.llamapay.io/charges?ending_before=fd533947-6889-4970-8fb9-6441342dc07d",
    "next_uri": "https://api.llamapay.io/charges?starting_after=082ac3c4-8c93-4c59-8e43-e4531640e264"
  }
}

Array of payments

Fetch a single payment

get

/charges/{payment_id}

Authorizations

Path parameters

payment_idstringrequired

id parameter obtained from /charges or webhook events

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.llamapay.io/charges/{payment_id}' \
  --header 'Authorization: YOUR_API_KEY'

200

404

200

{
  "data": {
    "id": "3e66112f-e4ad-4d5d-acb2-332e18fe4e4f",
    "hosted_url": "https://checkout.llamapay.io/pay/3e66112f-e4ad-4d5d-acb2-332e18fe4e4f",
    "created_at": "2024-07-01T04:57:41.034Z",
    "pricing_type": "fixed_price",
    "metadata": {
      "userId": "0xngmi"
    }
  }
}

Payment info