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

POSThttps://api.llamapay.io/charges

Authorization

authorization

Body

application/json

pricing_typeenum

fixed_priceno_pricesubscription

local_priceobject

metadataobject

redirect_urlstring

Example: "https://mypage.com/success"

cancel_urlstring

Example: "https://mypage.com/failure"

Response

200401

Successfully created a payment

Body

application/json

dataPayment (object)

Request

JavaScriptCurl

const response = await fetch('https://api.llamapay.io/charges', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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",
    "metadata": {
      "userId": "0xngmi"
    },
    "pricing_type": "fixed_price"
  }
}

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.

GEThttps://api.llamapay.io/charges

Authorization

authorization

Query parameters

Response

200

Array of payments

Body

application/json

paginationobject

dataarray of Payment (object)

Request

JavaScriptCurl

const response = await fetch('https://api.llamapay.io/charges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  },
  "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",
      "metadata": {
        "userId": "0xngmi"
      },
      "pricing_type": "fixed_price"
    }
  ]
}

Fetch a single payment

GEThttps://api.llamapay.io/charges/{payment_id}

Authorization

authorization

Path parameters

payment_id*string

id parameter obtained from /charges or webhook events

Response

200404

Payment info

Body

application/json

dataPayment (object)

Request

JavaScriptCurl

const response = await fetch('https://api.llamapay.io/charges/{payment_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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",
    "metadata": {
      "userId": "0xngmi"
    },
    "pricing_type": "fixed_price"
  }
}