A new payment receipt has been created

postWebhookpayment_receipt_created

Headers

X-Lago-Signaturestring required

Example:AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=

Signature of the webhook payload. The format depends on X-Lago-Signature-Algorithm: hmac is the Base64 encoding of an HMAC-SHA256 digest of the payload, jwt is an RS256 JSON Web Token (a string starting with eyJ).

X-Lago-Signature-Algorithm'jwt' | 'hmac' required

Example:hmac

Algorithm used to generate the signature

X-Lago-Unique-Keystring uuid required

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

Unique id of the webhook. It can be used for idempotency

Payload

webhook_type'payment_receipt.created' required

object_type'payment_receipt' required

organization_idstring uuid required

Unique identifier of the organization, created by Lago.

Example payload

{
  "organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "payment_receipt": {
    "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"
      }
    }
  }
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.