Skip to main content
​
lago_id
string<uuid>
required

The unique identifier of the payment, created by Lago.

Example:

"4cf085a7-c196-4f07-a543-97c50ec6e8b2"

​
lago_customer_id
string<uuid>
required

Unique identifier of the customer, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
external_customer_id
string
required

The customer external unique identifier (provided by your own application)

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
invoice_ids
string<uuid>[]
required

List of invoice IDs associated with the payment.

​
lago_payable_id
string<uuid>
required

The unique identifier of the paid resource, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
payable_type
enum<string>
required

The type of the paid resource, associated with the lago_payable_id.

Available options:
Invoice,
PaymentRequest
Example:

"Invoice"

​
amount_cents
integer
required

The amount of the payment in cents.

Example:

1099

​
amount_currency
enum<string>
required

The currency of the payment amount.

Available options:
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,
SZL,
THB,
TJS,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
Example:

"USD"

​
status
string
required

The status of the payment within the payment provider. This can be very different from a payment provider to another.

Example:

"Completed"

​
payment_status
enum<string>
required

The normalized payment status by Lago.

Available options:
succeeded,
failed,
pending,
processing
Example:

"succeeded"

​
type
enum<string>
required

The type of payment.

Available options:
manual,
provider
Example:

"manual"

​
reference
string
required

Reference for the payment.

Example:

"ref1"

​
payment_provider_code
string
required

Code of the payment provider

Example:

"stripe_prod"

​
payment_provider_type
enum<string>
required

The type of payment provider

Available options:
adyen,
cashfree,
gocardless,
stripe,
flutterwave,
moneyhash
Example:

"stripe"

​
external_payment_id
string | null
required

DEPRECATED: use provider_payment_id

​
provider_payment_id
string | null
required

Unique identifier of the payment within the payment provider (if applicable).

Example:

"pi_5eb0285741bc6ba"

​
provider_customer_id
string
required

Unique identifier of the customer within the payment provider

Example:

"cus_5eb0285bcf941bc6ba"

​
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.

Example:
{
  "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
string<date-time>
required

Timestamp when the payment was created in Lago's database, not on the payment provider.

Example:

"2025-01-21T00:10:29Z"

⌘I