Un objeto PaymentButton es un enlace de pago reutilizable que genera un cobro cada vez que un cliente lo abre, sin necesidad de integración técnica.
El objeto PaymentButton
PaymentButtonAtributos
id string
Identificador único del objeto.
object string
Indica el tipo de objeto. Valor siempre será payment_button.
button_type enum
Tipo de botón.
| Posibles valores |
|---|
pay default |
donate |
active boolean
Indica si el botón está activo. Un botón inactivo rechaza la creación de nuevos checkouts.
amount integer
Un número entero positivo que representa el monto que cobrará el checkout generado, en la unidad monetaria más pequeña (por ejemplo, 100 para CLP $100).
currency string
Código de moneda ISO de tres letras.
title string
Título o etiqueta del botón.
description string
Descripción del botón. Se utiliza como nombre del ítem del checkout generado.
custom_fields array of objects
Listado de campos adicionales solicitados al cliente en el checkout.
auto_refund boolean
Si es true, reembolsa automáticamente el pago generado.
success_url string
Una URL a la cual el cliente será redirigido si la autorización del cargo es exitosa.
success_url_method enum
El método HTTP a utilizar al redirigir al cliente si la autorización del cargo es exitosa.
| Posibles valores |
|---|
post default |
get |
cancel_url string
Una URL a la cual el cliente será redirigido si la autorización del cargo falla o es cancelada por el cliente.
cancel_url_method enum
El método HTTP a utilizar al redirigir al cliente en caso de una autorización fallida.
| Posibles valores |
|---|
post default |
get |
url string
URL del enlace de pago reutilizable. Se puede compartir en aplicaciones de mensajería, códigos QR y otros canales.
metadata object
Conjunto de pares llave-valor que puedes asociar a un objeto.
created_by_user_email string
Email del usuario que creó el botón.
created_by_user_id string
ID del usuario que creó el botón.
live boolean
Indica si el objeto existe en modo live o modo test.
created_at datetime
Fecha de creación del objeto en formato ISO 8601. En huso horario UTC.
updated_at datetime
Fecha de actualización del objeto en formato ISO 8601. En huso horario UTC.