Payment Link Object

{
  "id": "plink_K2zwNNSxPyx8w3GZ",
  "object": "payment_link",
  "amount": 120900,
  "currency": "MXN",
  "status": "active",
  "created_at": "2024-08-02T20:28:13Z",
  "expires_at": null,
  "mode": "test",
  "url": "https://pay.fintoc.com/plink_K2zwNNSxPyx8w3GZ",
  "metadata": {},
  "customer_email": null,
  "checkout": {
    "description": null
  }
}

AttributeTypeDescription
idstringUnique identifier for the Payment Link
objectstringIdentifier for the type of object. Its value for Payment Link will always correspond to payment_link
amountintegerThe amount the customer needs to pay, represented as an integer. This value must always be greater than 0.
currencystringCurrency ISO code. For now, we only support CLP and MXN.
statusstringPayment Link status. Can be either active, expired or canceled.
created_atstringPayment Link's creation date, using ISO 8601
expires_atstringPayment Link's expiration date, using ISO 8601. If null, then the payment link will not expire.
modestringIndicates whether the Payment Link is in live mode or in test mode.
urlstringThe public url that can be shared with customers.
metadatahashSet of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

If you create a payment without providing metadata, this field will be null when receiving notifications about the final status.
customer_emailstringEmail used to notify the customer in case of a refund. If you plan on using the refunds product, you must include this field in your request

If you create a payment without providing a customer_email, this field will be null and the customer will not receive refund notifications by email.
checkoutdictionaryCustomize the checkout for your customers. For now, you can only add a custom description alongside the buy button.