Payment Link object represents a shareable payment request in the Fintoc API.
{
"id": "plink_K2zwNNSxPyx8w3GZ",
"object": "payment_link",
"amount": 120900,
"business_profile": {
"category": "009613",
"name": "Merchant Name",
"tax_id": "774981120"
},
"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": "felipe@example.com",
"expires_at": "2024-08-02T21:28:13Z",
"metadata": {
"your_order_id": "10000"
},
"mode": "test",
"recipient_account": {
"holder_id": "771433855",
"institution_id": "cl_banco_de_chile",
"number": "1836027172",
"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 | Identifier for the type of object. Its value for Payment Link will always correspond to payment_link. |
amount | integer | The amount the customer needs to pay, represented as an integer. This value must always be greater than 0. |
business_profile | object | Enrolled merchant identifier for category-based billing. |
checkout | dictionary | Customize the checkout experience; currently supports custom descriptions. |
created_at | string | Payment Link’s creation date in ISO 8601 format. |
currency | string | Currency ISO code. Currently supports CLP and MXN only. |
customer_email | string | Email for refund notifications. Required for the refunds product. Will be null if not provided. |
expires_at | string | Payment Link’s expiration date in ISO 8601 format. If null, the link will not expire. |
metadata | hash | Set of key-value pairs for storing additional structured information. Will be null if not provided at creation. |
mode | string | Indicates whether the Payment Link is in live or test mode. |
recipient_account | object | Optional recipient account (Chile only); required for Direct Payments. |
status | string | Payment Link status. Can be active, expired, or canceled. |
url | string | The public URL that can be shared with customers. |
Recipient object
| Attribute | Type | Description |
|---|---|---|
holder_id | string | Account owner identifier (RUT in Chile, RFC or CURP in Mexico). |
institution_id | string | Account’s institution ID. |
number | string | Account number without hyphens or prefixed zeros. |
type | string | Account type: checking_account or sight_account. |
Business Profile object
| Attribute | Type | Description |
|---|---|---|
category | string | Merchant category identifier (6-character SII activity code in Chile). |
name | string | Enrolled merchant’s name. Displayed as “Recipient” on payment screens. |
tax_id | string | Enrolled merchant’s tax identifier (RUT in Chile). |