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.

Los pagos pueden ser autorizados exclusivamente por un cliente y tu podrás cancelar un pago solo si el cliente no lo ha autorizado o rechazado primero. Una vez que se haya autorizado un pago, podrás reembolsarlo si el método de pago elegido lo permite.

Los pagos se pueden capturar automáticamente en un solo paso y tan pronto como el cliente los autorice, o que se requiera que tu mismo los captures en un flujo de dos pasos después de la autorización del cliente. Esto te permite realizar verificaciones del lado del servidor antes de confirmar el pago. Si un pago autorizado no se captura dentro de los 10 minutos posteriores a la autorización, se reembolsará automáticamente.

El objeto payment

AtributoTipoDescripción
idstringIdentificador único del objeto.
objectstringIndica el tipo de objeto. Valor siempre será payment.
acquirerstringIndica 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.
amountintegerUn 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)
automaticbooleanIndica si el pago se ha creado mediante una suscripción de cargo automático.
authorizedbooleanIndica si el pago ha sido autorizado o no.
authorized_atdatetimeFecha de autorización del pago.
authorization_sessionobjectDirección IP, navegador y ubicación geográfica del cliente al momento de autorizar el pago.
cancel_urlstringUna URL a la cual el cliente será redirigido si la autorización del pago falla.
cancel_url_methodstringEl método HTTP a utilizar al redirigir al cliente en caso de un pago fallido.

Uno de post, get.
Default es post.
capturebooleanIndica si el pago se capturará inmediatamente después de la autorización.

Default es false.
capturedbooleanIndica si el pago ha sido capturado o no.
captured_atdatetimeFecha de captura del pago.
categorystringIndica la categoría del pago.

Uno de entertainment, food_drinks, shopping, services, travel, transportation, health.
checkout_idstringID checkout relacionado.
currencystringCódigo de moneda ISO de tres letras. Corresponde a la moneda de presentación.
customerobject
ampliable
Objeto customer relacionado.
customer_idstringID customer relacionado.
custom_fieldsarrayListado de datos personalizados que el cliente deberá llenar antes de poder autorizar el pago.

Posibles valores: given-name, family-name, address, tel, taxid, bday.
descriptionstringUn texto arbitrario asociado al objeto.
disputedbooleanIndica si el pago está en disputa (contracargo).
disputed_atdatetimeFecha de la disputa (contracargo).
feeintegerUn número entero positivo que representa el fee cobrado al comercio por el procesamiento del pago. Asociado a la moneda de settlement del comercio.
invoiceobject
ampliable
Objeto invoice relacionado
invoice_idstringID invoice relacionado.
livebooleanIndica si el pago existe en modo live o modo test.
metadataobjectConjunto 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_amountintegerMonto del pago antes de aplicarse descuentos.
originatorstringUn valor que se usa para identificar quién es el creador del pago, si el comercio o el cliente.

Uno de merchant, customer.
payment_buttonobject
ampliable
Objeto payment_button relacionado.
payment_button_idstringID payment_button relacionado.
payment_methodobject
ampliable
Objeto payment_method relacionado.
payment_method_idstringID payment_method relacionado.
payoutobject
ampliable
Objeto payout relacionado.
payout_idstringID payout relacionado.
refundedbooleanIndica si el pago se ha reembolsado en su totalidad.
Si el pago se reembolsa parcialmente, el valor será false.
refunded_amountintegerMonto reembolsado representado en la unidad monetaria más pequeña. Puede ser inferior a la cantidad si el pago se reembolsa parcialmente.
refunded_atdatetimeFecha de reembolso del pago.
settlement_amountintegerUn número entero positivo que representa el monto cobrado en la moneda de settlement del comercio.
settlement_currencystringCódigo de moneda ISO de tres letras. Corresponde a la moneda de settlement del comercio.
sourcestringIndica qué sistema o plataforma fue responsable de crear el pago.

Uno de shopify, vtex, jumpseller.
statusstringEl estado del pago.

Uno de requires_authorization, requires_capture, succeeded, failed, canceled.
status_reasonstringIncluye detalles sobre un pago fallido o cancelado.
subscriptionobject
ampliable
Objeto subscription relacionado.
subscription_idstringID subscription relacionado.
success_urlstringUna URL a la cual el cliente será redirigido si la autorización del pago es exitosa.
success_url_methodstringEl método HTTP a utilizar al redirigir al cliente en caso de un pago exitoso.

Uno de post, get. Default es post.
urlstringUna 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_atdatetimeFecha de creación del objeto en formato ISO 8601. Basado en UTC.
updated_atdatetimeFecha de actualización del objeto en formato ISO 8601. Basado en UTC.

Estados

EstadoDescripción
requires_authorizationEstado inicial del pago. Significa que está listo para ser autorizado por el cliente.
requires_captureEl pago fue autorizado, es decir los fondos ya están asegurados, y está a la espera de ser capturado.
succeededEl pago fue autorizado y capturado exitosamente.
failedEl 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.
canceledEl pago fue cancelado y ya está no está disponible para ser autorizado. Solo los pagos que aun no hayan sido autorizados pueden ser cancelados.