GEgetlago
payment_receipts

List all payment receipts

Changed on

This endpoint is used to list all existing payment receipts.

get/payment_receipts

Request

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

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

Filter payment receipts by invoice. It returns the receipts of the payments made on this invoice, including the payments made through a payment request that covers it.

Response

Payment receipts

Example response

{
  "payment_receipts": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "created_at": "2022-04-29T08:59:51Z",
      "number": "LAG-1234-001-002",
      "file_url": "https://getlago.com/payment_receipt/file",
      "xml_url": "https://getlago.com/payment_receipt/xml",
      "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",
        "external_payment_id": "pi_5eb0285741bc6ba",
        "provider_payment_id": "pi_5eb0285741bc6ba",
        "provider_customer_id": "cus_5eb0285bcf941bc6ba",
        "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",
        "payment_method": {
          "lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
          "is_default": true,
          "payment_provider_code": "stripe_prod",
          "payment_provider_name": "Stripe",
          "payment_provider_type": "stripe",
          "provider_method_id": "pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ",
          "created_at": "2025-01-21T00:10:29Z"
        }
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

Changes

  • b216574b9612Revision changes
    • breaking

      the response property /// became nullable for the status

    • warning

      added the new undefined enum value to the /// response property for the response status

  • 5d26657495a3Revision changes
    • breaking

      for the query request parameter invoice_id, the format changed from no format to uuid

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new SYP enum value to the /// response property for the response status

    • warning

      added the new TND enum value to the /// response property for the response status

    • warning

      added the new undefined enum value to the /// response property for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      the response property /// became required for the status

    • info

      response property payment_receipts/items/payment/external_payment_id deprecated

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status