Un pago representa la intención de realizar un cargo a un método de pago de un cliente. Cada pago es único, es decir debes crear uno por cada intención de pago.
Una vez que se haya autorizado un pago, podrás reembolsarlo si el método de pago elegido lo permite.
El objeto payment
payment| Atributo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único del objeto. |
object | string | Indica el tipo de objeto. Valor siempre será payment. |
acquirer | string | Indica quién es el adquirente de la transacción y, usualmente, el responsable del abono. Si VentiPay es el adquirente (opción por defecto), el valor será default. |
amount | integer | Un número entero positivo que representa cuánto cobrar en la unidad monetaria más pequeña (por ejemplo, 100 centavos para cobrar USD $ 1,00 o 100 para cobrar CLP $ 100) |
automatic | boolean | Indica si el pago se ha creado mediante una suscripción de cargo automático. |
authorized | boolean | Indica si el pago ha sido autorizado o no. |
authorized_at | datetime | Fecha de autorización del pago. |
authorization_session | object | Dirección IP, navegador y ubicación geográfica del cliente al momento de autorizar el pago. |
cancel_url | string | Una URL a la cual el cliente será redirigido si la autorización del pago falla. |
cancel_url_method | string | El método HTTP a utilizar al redirigir al cliente en caso de un pago fallido. Uno de post, get.Default es post. |
capture | boolean | Indica si el pago se capturará inmediatamente después de la autorización. Default es true. |
captured | boolean | Indica si el pago ha sido capturado o no. |
captured_at | datetime | Fecha de captura del pago. |
checkout_id | string | ID checkout relacionado. |
currency | string | Código de moneda ISO de tres letras. Corresponde a la moneda de presentación. |
customer | objectexpandible | Objeto customer relacionado. |
customer_id | string | ID customer relacionado. |
custom_fields | array | Listado de datos personalizados que el cliente deberá llenar antes de poder autorizar el pago. Posibles valores: given-name, family-name, address, tel, taxid, bday. |
description | string | Un texto arbitrario asociado al objeto. |
disputed | boolean | Indica si el pago está en disputa (contracargo). |
disputed_at | datetime | Fecha de la disputa (contracargo). |
fee | integer | Un número entero positivo que representa el fee cobrado al comercio por el procesamiento del pago. Asociado a la moneda de settlement del comercio. |
invoice | objectexpandible | Objeto invoice relacionado |
invoice_id | string | ID invoice relacionado. |
live | boolean | Indica si el pago existe en modo live o modo test. |
metadata | object | Conjunto de pares llave-valor que puedes asociar a un objeto. Esto puede resultar útil para almacenar información adicional sobre el objeto en un formato estructurado. |
original_amount | integer | Monto del pago antes de aplicarse descuentos. |
originator | string | Un valor que se usa para identificar quién es el creador del pago, si el comercio o el cliente. Uno de merchant, customer. |
payment_button | objectexpandible | Objeto payment_button relacionado. |
payment_button_id | string | ID payment_button relacionado. |
payment_method | objectexpandible | Objeto payment_method relacionado. |
payment_method_id | string | ID payment_method relacionado. |
payout | objectexpandible | Objeto payout relacionado. |
payout_id | string | ID payout relacionado. |
refunded | boolean | Indica si el pago se ha reembolsado en su totalidad. Si el pago se reembolsa parcialmente, el valor será false. |
refunded_amount | integer | Monto reembolsado representado en la unidad monetaria más pequeña. Puede ser inferior a la cantidad si el pago se reembolsa parcialmente. |
refunded_at | datetime | Fecha de reembolso del pago. |
settlement_amount | integer | Un número entero positivo que representa el monto cobrado en la moneda de settlement del comercio. |
settlement_currency | string | Código de moneda ISO de tres letras. Corresponde a la moneda de settlement del comercio. |
source | string | Indica qué sistema o plataforma fue responsable de crear el pago. Uno de shopify, vtex, jumpseller. |
status | string | El estado del pago. Uno de requires_authorization, requires_capture, succeeded, failed, canceled. |
status_reason | string | Incluye detalles sobre un pago fallido o cancelado. |
subscription | objectexpandible | Objeto subscription relacionado. |
subscription_id | string | ID subscription relacionado. |
success_url | string | Una URL a la cual el cliente será redirigido si la autorización del pago es exitosa. |
success_url_method | string | El método HTTP a utilizar al redirigir al cliente en caso de un pago exitoso. Uno de post, get. Default es post. |
url | string | Una URL utilizada para identificar de forma exclusiva el objeto. Las URL se pueden usar para compartir un pago en aplicaciones de mensajería, códigos QR y otros canales. |
created_at | datetime | Fecha de creación del objeto en formato ISO 8601. Basado en UTC. |
updated_at | datetime | Fecha de actualización del objeto en formato ISO 8601. Basado en UTC. |
Estados
| Estado | Descripción |
|---|---|
requires_authorization | Estado inicial del pago. Significa que está listo para ser autorizado por el cliente. |
requires_capture | El pago fue autorizado, es decir los fondos ya están asegurados, y está a la espera de ser capturado. |
succeeded | El pago fue autorizado y capturado exitosamente. |
failed | El pago falló al intentar autorizarse. Solo los pagos autorizados de manera automática por una suscripción llegan a este estado si es que fallan, en cambio si fue el cliente quien intentó autorizar, el pago se mantendrá en su estado inicial para permitir que el cliente intente nuevamente. |
canceled | El pago fue cancelado y ya está no está disponible para ser autorizado. Solo los pagos que aun no hayan sido autorizados pueden ser cancelados. |