Payment Link Object

{
  "id": "plink_K2zwNNSxPyx8w3GZ",
  "object": "payment_link",
  "amount": 120900,
  "currency": "MXN",
  "status": "active",
  "created_at": "2024-08-02T20:28:13Z",
  "expires_at": "2024-08-02T21:28:13Z",
  "mode": "test",
  "url": "https://pay.fintoc.com/plink_K2zwNNSxPyx8w3GZ",
  "customer_email": "[email protected]",
  "checkout": {
    "description": "Use this field to add a custom description of the product the customer is buying"
  },
  "metadata": {
    "your_order_id": "10000"
  },
  "recipient_account": {
    "holder_id": "771433855",
    "number": "1836027172",
    "type": "checking_account",
    "institution_id": "cl_banco_de_chile"
  },
	"business_profile": {
  	"name":"Merchant Name",
    "category": "009613",
    "tax_id": "774981120"
  }
}

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.
`currency`	`string`	Currency ISO code. For now, we only support CLP and MXN.
`status`	`string`	Payment Link status. Can be either `active`, `expired` or `canceled`.
`created_at`	`string`	Payment Link's creation date, using ISO 8601
`expires_at`	`string`	Payment Link's expiration date, using ISO 8601. If null, then the payment link will not expire.
`mode`	`string`	Indicates whether the Payment Link is in `live` mode or in `test` mode.
`url`	`string`	The public url that can be shared with customers.
`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.
`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 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.
`checkout`	`dictionary`	Customize the checkout for your customers. For now, you can only add a custom description alongside the buy button.
`recipient_account`	`object`	(Optional and only available in Chile)* The recipient account object must be included if your organization uses Direct Payments .
`business_profile`	`object`	Enrolled merchant identifier used for category-based billing.

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.
`number`	`string`	Account number. Does not include hyphens or prefixed zeros
`type`	`string`	Account type. It can be `checking_account` or `sight_account`
`institution_id`	`string`	Account's institution `id`. You can learn more about institutions and their `id`s here

Business Profile Object

Attribute	Type	Description
`name`	`string`	Enrolled merchant´s name. If set, will be shown as the "Recipient" on the payment screens.
`category`	`string`	Identifier of the category of the enrolled merchant. In Chile, it corresponds to a 6 character SII activity code.
`tax_id`	`string`	Enrolled merchant's tax identifier. In Chile, it corresponds to a RUT.