PaymentLink representa una url que puedes compartir para que un cliente pague un amount fijo a través de una página alojada por Fintoc. Aparece cuando creas un payment link, y su campo status indica si el enlace está active, expired o canceled.
JSON
{
"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": "customer@example.com",
"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": "0000000000",
"type": "checking_account"
},
"status": "active",
"url": "https://pay.fintoc.com/plink_K2zwNNSxPyx8w3GZ"
}
| Atributo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único del Payment Link |
object | string | Identificador del tipo de objeto. Su valor para Payment Link siempre corresponderá a payment_link |
amount | integer | El monto que el cliente debe pagar, representado como un entero. Este valor siempre debe ser mayor que 0. |
checkout | object | Personaliza el checkout para tus clientes. Por ahora, solo puedes agregar una descripción personalizada junto al botón de compra. |
created_at | string | Fecha de creación del Payment Link, usando ISO 8601 |
currency | string | Código ISO de la moneda. Por ahora, solo soportamos CLP y MXN. |
customer_email | string | null | Email usado para notificar al cliente en caso de un reembolso. Si planeas usar el producto de reembolsos, debes incluir este campo en tu solicitud Si creas un pago sin proporcionar un customer_email, este campo será null y el cliente no recibirá notificaciones de reembolso por email. |
expires_at | string | null | Fecha de expiración del Payment Link, usando ISO 8601. Si es null, entonces el payment link no expirará. |
metadata | object | null | Conjunto de pares clave-valor que puedes adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado. Si creas un pago sin proporcionar metadata, este campo será null al recibir notificaciones sobre el estado final. |
mode | string | Indica si el Payment Link está en modo live o en modo test. |
recipient_account | object | Opcional y solo disponible en Chile. Incluye el objeto recipient account si tu organización usa Direct Payments. Consulta el objeto Recipient más abajo. |
status | string | Estado del Payment Link. Puede ser active, expired o canceled. |
url | string | La URL pública que se puede compartir con los clientes. |
Objeto Recipient
| Atributo | Tipo | Descripción |
|---|---|---|
holder_id | string | Identificador del titular de la cuenta. En Chile, corresponde a un RUT; en México, a un RFC o CURP. |
institution_id | string | id de la institución de la cuenta. Puedes aprender más sobre las instituciones y sus id aquí |
number | string | Número de cuenta. No incluye guiones ni ceros al inicio |
type | string | Tipo de cuenta. Puede ser checking_account o sight_account |