The payment object
string
Unique identifier. Prefixed with
pay_.string
Always
"payment".string
The checkout this payment originated from.
string
The customer who made the payment.
string
If this payment is a subscription renewal, the subscription ID.
string
Amount and asset code, e.g.
"50 XLM".string
pending, confirmed, or failed.string
The Stellar transaction hash.
object | null
Snapshot of the customer’s billing info at the time of payment.
null if no customer was attached.object | null
The Stellar wallet used to make the payment.
null if unavailable.array
Refunds issued against this payment. Empty array if no refunds exist.
object
Arbitrary key-value data.
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.
List payments
GET /payment
Returns a paginated list of payments for your account, ordered by creation date descending.
Query parameters
string
Filter payments by customer ID. Returns only payments made by this customer.
number
Maximum number of payments to return. Defaults to
10.string
Return payments after this payment ID (exclusive). Use the last
id in the previous page to paginate forward.