{
"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": "[email protected]",
"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 used for category-based billing. |
checkout | dictionary | Customize the checkout for your customers. For now, you can only add a custom description alongside the buy button. |
created_at | string | Payment Link's creation date, using ISO 8601 |
currency | string | Currency ISO code. For now, we only support CLP and MXN. |
customer_email | string | Email 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 requestIf you create a payment without providing a customer_email, this field will be null and the customer will not receive refund notifications by email. |
expires_at | string | Payment Link's expiration date, using ISO 8601. If null, then the payment link will not expire. |
metadata | hash | Set 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. |
mode | string | Indicates whether the Payment Link is in live mode or in test mode. |
recipient_account | object |
|
status | string | Payment Link status. Can be either active, expired or canceled. |
url | string | The public url that can be shared with customers. |
Recipient Object
| Attribute | Type | Description |
|---|---|---|
holder_id | string | Identifier of the owner of the account. In Chile, the value corresponds to a RUT and in Mexico it's either an RFC or CURP. The editable field indicates whether the user is allowed to change the preset username or not. |
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. It can be checking_account or sight_account |
Business Profile Object
| Attribute | Type | Description |
|---|---|---|
category | string | Identifier of the category of the enrolled merchant. In Chile, it corresponds to a 6 character SII activity code. |
name | string | Enrolled merchant´s name. If set, will be shown as the "Recipient" on the payment screens. |
tax_id | string | Enrolled merchant's tax identifier. In Chile, it corresponds to a RUT. |