Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stellartools.dev/llms.txt

Use this file to discover all available pages before exploring further.

A payment is created automatically when a customer completes a checkout. Payments are confirmed on the Stellar ledger and carry a transaction hash.

​
The payment object

​
id
string
Unique identifier. Prefixed with pay_.
​
object
string
Always "payment".
​
checkout_id
string
The checkout this payment originated from.
​
customer_id
string
The customer who made the payment.
​
subscription_id
string
If this payment is a subscription renewal, the subscription ID.
​
amount
string
Amount and asset code, e.g. "50 XLM".
​
status
string
pending, confirmed, or failed.
​
transaction_hash
string
The Stellar transaction hash.
​
billing_details
object | null
Snapshot of the customer’s billing info at the time of payment. null if no customer was attached.
​
payment_method_details
object | null
The Stellar wallet used to make the payment. null if unavailable.
​
line_items
array
Refunds issued against this payment. Empty array if no refunds exist.
​
metadata
object
Arbitrary key-value data.
​
created_at
string
ISO 8601 timestamp.

​
Retrieve a payment

GET /payment/{id} Fetches a single payment by ID. Before returning, the Stellar network is queried for any pending payments and their status is updated accordingly. 
curl https://api.stellartools.dev/payment/pay_01jx... \
  -H "x-api-key: YOUR_API_KEY"
Returns a payment object.

​
List payments

GET /payment Returns a paginated list of payments for your account, ordered by creation date descending. 
curl https://api.stellartools.dev/payment \
  -H "x-api-key: YOUR_API_KEY"

​
Query parameters

​
customer
string
Filter payments by customer ID. Returns only payments made by this customer.
​
limit
number
Maximum number of payments to return. Defaults to 10.
​
starting_after
string
Return payments after this payment ID (exclusive). Use the last id in the previous page to paginate forward.
Returns a list object containing payment objects.