---
title: "An action is required to process a payment"
method: POST
path: "payment_requires_action"
---

# An action is required to process a payment

`POST payment_requires_action` (webhook)

An action is required to process a payment

## Headers

- `X-Lago-Signature` string, required
- `X-Lago-Signature-Algorithm` 'jwt' | 'hmac', required
- `X-Lago-Unique-Key` string, uuid, required

## Payload

- object
  - `webhook_type` 'payment.requires_action', required
  - `object_type` 'payment', required
  - `organization_id` string, uuid, required: Unique identifier of the organization, created by Lago.
  - `payment` PaymentObject, required
    - `lago_id` string, uuid, required: The unique identifier of the payment, created by Lago.
    - `lago_customer_id` string, uuid, required: Unique identifier of the customer, created by Lago.
    - `external_customer_id` string, required: The customer external unique identifier (provided by your own application).
    - `invoice_ids` string[], required: List of invoice IDs associated with the payment.
    - `invoice_numbers` string[], required: List of invoice numbers associated with the payment.
    - `lago_payable_id` string, uuid, required: The unique identifier of the paid resource, created by Lago.
    - `payable_type` 'Invoice' | 'PaymentRequest', required: The type of the paid resource, associated with the `lago_payable_id`.
    - `amount_cents` integer, required: The amount of the payment in cents.
    - `amount_currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW', required
    - `status` string, required: The status of the payment within the payment provider. It differs from one payment provider to another. It is always `succeeded` for a manual payment.
    - `payment_status` 'null' | 'succeeded' | 'failed' | 'pending' | 'processing', nullable, required: The payment status, normalized by Lago so that it is the same for every payment provider. It is `null` when Lago has not recorded a normalized status for the payment.
    - `type` 'manual' | 'provider', required: The type of payment.
    - `reference` string, nullable, required: Reference for the payment. Set on manual payments only; it is always `null` for payments collected through a payment provider.
    - `payment_provider_code` string, nullable, required: Code of the payment provider. It is `null` for manual payments, which are not attached to a payment provider.
    - `payment_provider_type` 'null' | 'adyen' | 'cashfree' | 'gocardless' | 'stripe' | 'flutterwave' | 'moneyhash', nullable, required: The type of payment provider. It is `null` for manual payments, which are not attached to a payment provider.
    - `external_payment_id` string, nullable, required: **Deprecated.** Use `provider_payment_id` instead. It holds the same value.
    - `provider_payment_id` string, nullable, required: Unique identifier of the payment within the payment provider (if applicable).
    - `provider_customer_id` string, nullable, required: Unique identifier of the customer within the payment provider. It is `null` for manual payments.
    - `next_action` object, required: The next action to be taken by the customer to complete the payment. Should usually be empty, except when receiving the `payment.requires_action` webhook.
    - `created_at` string, date-time, required: Timestamp of the payment in Lago's database, not on the payment provider. On a manual payment recorded with `paid_at`, it holds the `paid_at` value instead of the time the payment was recorded.
    - `payment_method` PaymentMethodObject
      - `lago_id` string, uuid, required: The unique identifier of the payment method, created by Lago.
      - `is_default` boolean, required: Indicates whether this payment method is the default one for the customer.
      - `payment_provider_code` string, nullable, required: Code of the payment provider associated with this payment method.
      - `payment_provider_name` string, nullable, required: Human-readable name of the payment provider.
      - `payment_provider_type` 'null' | 'adyen' | 'cashfree' | 'gocardless' | 'stripe' | 'flutterwave' | 'moneyhash', nullable, required: The type of the payment provider. It is `null` when the payment method is no longer attached to a payment provider.
      - `provider_method_id` string, required: Unique identifier of the payment method within the payment provider.
      - `created_at` string, date-time, required: Timestamp when the payment method was created in Lago's database.

## Acknowledgement `200`

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

---

[API](https://skmtc.dev/getlago/apis/lago-api-documentation.md) - [All operations](https://skmtc.dev/getlago/apis/lago-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/getlago/apis/lago-api-documentation/revisions/b216574b9612?raw)