API Reference

Crear un pago

post
https://treli.co/wp-json/api/payments/create

Crea una un pago único o una solicitud de pago asociada a una factura

Body Params
string
required

Correo electrónico de tu cliente

billing_address
object
required

Dirección de facturación de tu cliente

boolean
required

Decide si el pago tiene asociado una dirección de envío

boolean

Decide si el pago debe ser completado por parte del cliente. Si el pago es manual (true), este request te retorna un link de pago para que redirecciones a tu cliente. Si el pago no es manual (false), debes enviar la información del método de pago.

string

Decide como quieres que Treli realice la cobranza del pago. "now" para crear un pago que debe ser pagado al instante y que Treli envie una notificación solicitando el pago. "template" para utilizar una plantilla de pago creada previamente. No aplica is "manual_payment" es true o false.

string

Si el "payment_collection" es "template", debes enviar el id de la plantilla que quieres utilizar. Puedes consultar tus plantillas con el endpoint listar plantillas. No aplica is "manual_payment" es true o false.

string

Fecha de vencimiento de la factura o solicitud de pago. Formato YYYY-MM-DD.

string

Decide si quieres asociar una factura a la solicitud de pago. "connect" para conectar una factura que ya tengas creada en tu proveedor de facturación contable y lo tengas integrado con Treli. "upload" para recaudar una factura de un proveedor contable que no tengas integrado a Treli. "create" para crear una factura en tu proveedor contable y asociarla a la solicitud de pago. Para crear una factura, debes tener integrado un proveedor contable en tu cuenta de Treli.

string

Si "invoicing" es "connect", ingresa el número de una factura que ya tengas creada en tu proveedor de facturación contable. Treli descargara la factura, la enviara a tu cliente en las notificaciones de solicitud de pago. Debes tener integrado un proveedor contable en tu cuenta de Treli.

string

Si "invoicing" es "upload", ingresa el número de una factura que ya tengas creada en tu proveedor de facturación contable. Usalo cuando NO tengas integrado un proveedor contable en tu cuenta de Treli y quieras recaudar una factura.

string

Si "invoicing" es "upload", ingresa la URL del PDF de la factura que estas recaudando. Usalo cuando NO tengas integrado un proveedor contable en tu cuenta de Treli y quieras recaudar una factura. No es necesario si ya estas enviando la cadena en base64 del PDF de la factura.

string

Si "invoicing" es "upload", ingresa la cadena en base64 de la factura que estas recaudando. Usalo cuando NO tengas integrado un proveedor contable en tu cuenta de Treli y quieras recaudar una factura. No es necesario si ya estas enviando la URL del PDF de la factura.

invoice_retentions
object

Si "invoicing" es "create", agrega retenciones en la factura

shipping_address
object

Dirección de envío de tu cliente

products
array of objects

Lista de productos asociados al pago. Requerido si estas creando un pago con productos existentes en tu cuenta de Treli.

products
integer

Ingresa el valor total a pagar. Solo es necesario y válido cuando estas creando un pago sin productos.

string

Ingresa la descripción del pago. Solo y válido cuando estas creando un pago sin productos.

payment
object

Información del método de pago

string

Código de la moneda en tres letras (ISO 4217). Debes tener la moneda habilitada en tu cuenta de Treli. Este campo es opcional, si envías este campo vacío, se utiliza la moneda base configurada en tu cuenta de Treli.

string

Cupón de descuento para el pago. Debes tener el cupón creado en tu cuenta de Treli.

string

Comentarios u observaciones de la factura. Solo aplica si tienes habilitada la opción de generar facturas en tu proveedor contable.

integer

Ingresa un saldo a favor que se debe aplicar a la solicitud de pago.

meta_data
array of objects

Lista de meta data asociada al pago

meta_data
Response

Updated about 1 year ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here!
Updated about 1 year ago