API Reference
- Getting started
- Add-ons
- Analytics
- Billable metrics
- Coupons
- Credit notes
- Customer usage
- Customers
- Events
- Fees
- Invoices
- Organizations
- Payments
- Payment receipts
- Payment requests
- Plans
- Resources
- Subscriptions
- Taxes
- Wallets
- Webhook endpoints
- Webhooks
Retrieve a payment receipt
This endpoint retrieves a specific payment receipt.
curl --request GET \
--url https://api.getlago.com/api/v1/payment_receipts/{lago_id} \
--header 'Authorization: Bearer <token>'{
"payment_receipt": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"created_at": "2022-04-29T08:59:51Z",
"number": "LAG-1234-001-002",
"payment": {
"lago_payable_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"status": "processing",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"provider_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"payment_provider_code": "Stripe Prod",
"payment_provider_type": "stripe",
"provider_payment_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"next_action": {}
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Payment receipt ID
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Response
Unique identifier of the payment receipt, created by Lago.
"1a901a90-1a90-1a90-1a90-1a901a901a90"
The date and time when the payment receipt was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the payment receipt was initially created.
"2022-04-29T08:59:51Z"
The unique number assigned to the payment receipt.
"LAG-1234-001-002"
The unique identifier of the paid resource, created by Lago.
"1a901a90-1a90-1a90-1a90-1a901a901a90"
Unique identifier of the customer, created by Lago.
"1a901a90-1a90-1a90-1a90-1a901a901a90"
The status of the payment within the payment provider
"processing"
The customer external unique identifier (provided by your own application)
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Unique identifier of the customer within the payment provider
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
The type of payment provider
adyen, cashfree, gocardless, stripe "stripe"
Unique identifier of the payment within the payment provider
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Code of the payment provider
"Stripe Prod"
Was this page helpful?
curl --request GET \
--url https://api.getlago.com/api/v1/payment_receipts/{lago_id} \
--header 'Authorization: Bearer <token>'{
"payment_receipt": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"created_at": "2022-04-29T08:59:51Z",
"number": "LAG-1234-001-002",
"payment": {
"lago_payable_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"status": "processing",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"provider_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"payment_provider_code": "Stripe Prod",
"payment_provider_type": "stripe",
"provider_payment_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"next_action": {}
}
}
}