The Payment Link object
The PaymentLink object represents a shareable url that lets a customer pay a fixed amount through a Fintoc-hosted page. It appears when you create a payment link, and its status field tracks the link as active, expired, or canceled.
{
"id": "plink_K2zwNNSxPyx8w3GZ",
"object": "payment_link",
"amount": 120900,
"checkout": {
"description": "Use this field to add a custom description of the product the customer is buying"
},
"created_at": "2024-08-02T20:28:13Z",
"currency": "MXN",
"customer_email": "[email protected]",
"expires_at": "2024-08-02T21:28:13Z",
"metadata": {
"your_order_id": "10000"
},
"mode": "test",
"recipient_account": {
"holder_id": "555555555",
"institution_id": "cl_banco_de_chile",
"number": "1234567890",
"type": "checking_account"
},
"status": "active",
"url": "https://pay.fintoc.com/plink_K2zwNNSxPyx8w3GZ"
}| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Payment Link. |
object | string | Type of the object. Always payment_link. |
amount | integer | Amount to charge, in the smallest currency unit. Must be greater than 0. |
checkout | object | Checkout customization shown to your customers. You can add a custom description alongside the buy button. |
created_at | string | Payment Link's creation date, as an ISO 8601 datetime in UTC. |
currency | string | Three-letter ISO 4217 currency code, in uppercase. One of CLP or MXN. |
customer_email | string | Email address used for refund notifications. If you create a payment without customer_email, this field is null and the customer does not receive refund notifications by email. |
expires_at | string | Payment Link's expiration date, as an ISO 8601 datetime in UTC. If null, the payment link does not expire. |
metadata | object | Set of key-value pairs you can attach to the object, useful for storing additional structured information. If you create a payment without metadata, this field is null when receiving notifications about the final status. |
mode | string | Indicates whether the Payment Link is in live mode or in test mode. |
recipient_account | object | Optional and only available in Chile. Include the recipient account object if your organization uses Direct Payments. See The Recipient object. |
status | string | Payment Link status. One of active, expired, or canceled. |
url | string | Public URL you can share with customers. |
The Recipient object (within the Payment Link object)
The Recipient object describes the bank account that receives the funds, returned in the recipient_account field when your organization uses Direct Payments in Chile.
| Attribute | Type | Description |
|---|---|---|
holder_id | string | Identifier of the account holder. In Chile, a Chilean tax ID (RUT); in Mexico, a Mexican tax ID (RFC) or unique population registry code (CURP). |
institution_id | string | Account's institution id. You can learn more about institutions and their ids here. |
number | string | Account number. Does not include hyphens or prefixed zeros. |
type | string | Account type. One of checking_account or sight_account. |