Payments

El objeto `Payment`

Atributos

id string

Identificador único del objeto.

object string

Indica el tipo de objeto. Valor siempre será payment.

status enum

El estado del objeto.

Posibles valores	Descripción
`requires_authorization`	Estado inicial. El pago espera ser autorizado con un método de pago.
`requires_capture`	Autorizado pero no capturado (flujo en dos pasos, `capture: false`).
`succeeded`	Autorizado y capturado: el cobro se hizo efectivo.
`failed`	La autorización o captura falló.
`canceled`	El pago fue cancelado.

status_reason string

Motivo del estado actual (por ejemplo, la razón de un fallo).

amount integer

Un número entero positivo que representa el monto a cobrar en la moneda de presentación, en la unidad monetaria más pequeña (por ejemplo, 100 para CLP $100).

original_amount integer

Monto al momento de crearse el objeto, antes de modificaciones.

currency string

Código de moneda ISO de tres letras. Corresponde a la moneda de presentación.

authorized boolean

Indica si el pago fue autorizado por el método de pago.

authorized_at datetime

Fecha de autorización en formato ISO 8601. En huso horario UTC.

captured boolean

Indica si los fondos fueron capturados.

captured_at datetime

Fecha de captura en formato ISO 8601. En huso horario UTC.

capture boolean

Si es false, el pago se autoriza pero no se captura automáticamente (captura manual). Default es true.

fee integer

Comisión de procesamiento cobrada por VentiPay al comercio, en la unidad monetaria más pequeña de la moneda de settlement.

settlement_amount integer

Un número entero positivo que representa el monto a liquidar al comercio en su moneda de settlement.

settlement_currency string

Código de moneda ISO de tres letras. Corresponde a la moneda de settlement del comercio.

charge_amount integer

Monto efectivamente cobrado en la moneda del cargo (tras la conversión), en la unidad monetaria más pequeña.

charge_currency string

Código de moneda ISO de tres letras en que se ejecutó el cargo.

charge_exchange_rate_at datetime

Fecha de referencia del tipo de cambio del cargo en formato ISO 8601. En huso horario UTC.

available_for_refund integer

Monto disponible para reembolsar (amount menos refunded_amount), en la unidad monetaria más pequeña.

refunded boolean

Indica si el pago fue reembolsado total o parcialmente.

refunded_amount integer

Monto reembolsado en la moneda de presentación, en la unidad monetaria más pequeña.

refunded_at datetime

Fecha del último reembolso en formato ISO 8601. En huso horario UTC.

surcharge_amount integer

Recargo cobrado al cliente en la moneda de presentación, en la unidad monetaria más pequeña.

surcharge_tax integer

Impuesto sobre el recargo, en la unidad monetaria más pequeña.

acquirer string

Adquirente o pasarela que procesó el cargo.

category string

Categoría del pago.

originator enum

Indica quién inició el pago.

Posibles valores
`merchant`
`customer`

automatic boolean

Indica si el pago se generó automáticamente (por ejemplo, por una suscripción o nota de venta).

customer_id string

ID objeto Customer relacionado.

customer object expandible

Objeto Customer relacionado.

payment_method_id string

ID objeto PaymentMethod relacionado.

payment_method object expandible

Objeto PaymentMethod relacionado.

checkout_id string

ID objeto Checkout que originó el pago.

invoice_id string

ID objeto Invoice relacionado.

subscription_id string

ID objeto Subscription que originó el pago.

payment_button_id string

ID objeto PaymentButton que originó el pago.

payout_id string

ID objeto Payout en el que se liquidó el pago.

successful_charge_id string

ID objeto Charge que se cobró exitosamente.

installment_program string

Programa de cuotas seleccionado.

installments_plan object

Detalle del plan de pago en cuotas aplicado.

discount_amounts array of objects

Desglose de los descuentos aplicados.

custom_fields array of objects

Campos adicionales solicitados al cliente.

custom_fields_data object

Valores entregados por el cliente para los campos adicionales.

session_email string

Email entregado por el cliente en la sesión de pago.

session_taxid string

Identificador tributario entregado en la sesión de pago.

authorization_session object

Datos de la sesión y antifraude capturados al momento de la autorización.

disputed boolean

Indica si el pago está en disputa.

disputed_at datetime

Fecha en que se inició la disputa en formato ISO 8601. En huso horario UTC.

description string

Un texto arbitrario asociado al objeto.

source enum

Indica qué sistema o plataforma originó el objeto.

Posibles valores
`shopify`
`vtex`
`woocommerce`
`jumpseller`
`adobe_commerce`

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 de la página de pago alojada por VentiPay.

metadata object

Conjunto de pares llave-valor que puedes asociar a un objeto.

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.

El objeto Payment

Atributos

El objeto `Payment`