v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
payment_receipts

List all payment receipts

This endpoint is used to list all existing payment receipts.

get/payment_receipts

Query parameters

pageinteger
Example:1

Page number.

per_pageinteger
Example:20

Number of records per page.

invoice_idstring
Example:1a901a90-1a90-1a90-1a90-1a901a901a90

Filter payment receipts by invoice id.

Response

PaymentReceipts

Example response

{
  "payment_receipts": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2022-04-29T08:59:51Z",
      "number": "LAG-1234-001-002",
      "payment": {
        "lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
        "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
        "invoice_ids": [
          "486b147a-02a1-4ccf-8603-f3541fc25e7a"
        ],
        "invoice_numbers": [
          "HOO-202D-005-001"
        ],
        "lago_payable_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "payable_type": "Invoice",
        "amount_cents": 1099,
        "amount_currency": "USD",
        "status": "Completed",
        "payment_status": "succeeded",
        "type": "manual",
        "reference": "ref1",
        "payment_provider_code": "stripe_prod",
        "payment_provider_type": "stripe",
        "provider_payment_id": "pi_5eb0285741bc6ba",
        "provider_customer_id": "cus_5eb0285bcf941bc6ba",
        "payment_method_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "next_action": {
          "type": "redirect_to_url",
          "redirect_to_url": {
            "url": "https://hooks.stripe.com/3d_secure_2/hosted?merchant=acct_AAA&payment_intent=pi_BBB&payment_intent_client_secret=pi_BBB&publishable_key=pk_test_CCC",
            "return_url": "https://app.example.com"
          }
        },
        "created_at": "2025-01-21T00:10:29Z"
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}