Detalle de campos y tipos de datos API Payments

A continuación se detallan todos los tipos de datos y valores posibles que puede tomar cada key. Existen campos que pueden en un futuro agregar valores o ser modificados. Particularmente, los providers, las card_brands, los tipos de descuentos, entre otros. A continuación, se detalla la actualización a Julio 2019.

• Todas las fechas(dates) son un string con formato aaaa-mm-dd, los created at, son timestamps pero llegan como strings con formato ISO 8601 2019-03-15T14:47:10-03:00

• Los IDS son de tipo UUID. Se aconseja fuertemente guardarlos como tales, y no como strings.

• El orden de los campos en el json puede variar, ya que es propio de esta tecnología.

Payments API

Ten en cuenta que excepto que envíes como parámetro "hide_movements=true" también obtendrás en el resultado el detalle de movimientos, con los campos indicados aquí

Campo	Tipo	Descripción
id	UUID	ID de Increase que identifica la liquidación
payment_date	DATE	Fecha de pago de la liquidación
presentation_date	DATE	Fecha de presentación de la liquidación
card_brand	STRING o NULL	Marca de la tarjeta. Ver Valores posibles por país
number	STRING	Número de liquidación otorgado por la procesadora
provider	STRING	Proveedor de la tarjeta. Ver Valores posibles por país
establishment	STRING	Número de establecimiento
version	STRING	Versión de la liquidación en Increase. Versión inicial de un payment siempre es 1.
Created_at	STRING	Fecha de creación del payment en Increase
shop_name	STRING	Nombre de la sucursal (shop) configurado en Increase
Balanced	OBJECT	Objeto que detalla si la liquidación está balanceada o no.
is_balanced	BOOLEAN	En true, la liquidación cumple con los 3 criterios de balanceo
Total_movements_difference	DECIMAL	Indica la diferencia entre la Suma de los movimientos y el monto Bruto de la liquidación.
Total_earn_difference	DECIMAL	Indica la diferencia entre el neto calculado (Total - descuentos) y el neto de la liquidación.
Total_deduction_difference	DECIMAL	Indica la diferencia entre la suma de los descuentos y el descuento total de la liquidación
total_amount	OBJECT	Objeto referido al monto
Amount	DECIMAL	Monto total
currency	STRING	Moneda del monto total
total_deduction	OBJECT	Objeto referido a las deducciones
Amount	DECIMAL	Monto total de las deducciones
currency	STRING	Moneda del monto total de las deducciones
total_earn	OBJECT	Objeto que refiere al neto a cobrar
Amount	DECIMAL	Monto neto
currency	STRING	Moneda del monto neto
Opening_balance	OBJECT	Saldo anterior pendiente de pago
Amount	DECIMAL	Monto pendiente de pago
currency	STRING	Moneda del monto pendiente de pago
closing_balance	OBJECT	Saldo pendiente de cobro
Amount	DECIMAL	monto pendiente de cobro
currency	STRING	moneda del monto pendiente de cobro
discounts	OBJECT	Objeto de descuentos que se le aplicaron a la liquidación
type	STRING	Concatenación que indica el tipo de descuento. Ver Valores posibles por país
amount	DECIMAL	Monto del descuento
currency	STRING o NULL	moneda del descuento
description	STRING o NULL	Descripción del descuento indicado en la liquidación
rate	DECIMAL o NULL	Porcentaje del descuento
region	STRING	La región correspondiente al descuento. Ver Valores posibles por país
acquiring_Bank	OBJECT	Objeto con información del banco adquirente
id	UUID	Id del banco en Increase
name	STRING	Nombre del banco

Movements API

Campo	Tipo	Descripción
id	UUID	Identificador de Increase del movimiento
payment_id	UUID	Identificador de increase del payment / liquidación
unique_movement_id	STRING	Identificador unívoco del movimiento. No varía según la versión del payment.
presentation_date	STRING o NULL	Fecha de presentación del movimiento
payment_date	STRING o NULL	Fecha de pago del movimiento
origin_date	STRING o NULL	Fecha de origen del movimiento
Batch	STRING o NULL	Número de lote
coupon_number	STRING o NULL	Número de cupón
authorization_number	STRING o NULL	Número de autorización
terminal_number	STRING o NULL	Número de terminal
description_code	STRING o NULL	Código de descripción del movimiento
description	STRING o NULL	Texto descriptivo del movimiento
card_brand	STRING	Marca de la tarjeta con la que se hizo el movimiento. Ver Valores posibles por país
card_number	STRING o NULL	Número de tarjeta de tipo XXXXXX***XXXX
installments	STRING o NULL	Total de cuotas
installment_current	INTEGER o NULL.	Cuota actual que se está pagando.
amount	DECIMAL	Monto del movimiento
currency	STRING	Moneda del movimiento
type	STRING	Tipo de movimiento. Valores posibles:["adjustment", "chargeback", "refund", "rejection", "transaction"]
credit_type	STRING/ NULL	Subtipo de movimiento. Ver Valores posibles por país
consumption_amount	DECIMAL o NULL	Monto que figura en el recibo del comprador. En Argentina coincide con movement amount, pero en otros países como Ecuador o EEUU considera el IVA.
discounts	OBJECT	Objeto de descuentos que se le aplicaron al movimiento
type	STRING	Concatenación que te indica el tipo de descuento. Ver Valores posibles por país
amount	DECIMAL	Monto del descuento
currency	STRING o NULL	Moneda del descuento
description	STRING o NULL	Descripción del descuento indicado en la liquidación
rate	DECIMAL o NULL	Porcentaje del descuento
region	STRING	La región correspondiente al descuento. Ver Valores posibles por país
issuing_bank	STRING	indica el banco emisor de la tarjeta

Taxes API

Campo	tipo	description
type	STRING	Concatenación que indica el tipo de descuento. Ver Valores posibles por país
amount	DECIMAL	Monto del impuesto
currency	STRING	Moneda del impuesto
description	STRING	Descripción del impuesto
rate	DECIMAL	Porcentaje del impuesto. Por ejemplo, 0.21 es 21%
region	STRING	La región correspondiente al impuesto. Ver Valores posibles por país

Países

País	Campo	valores posibles
Argentina	card_brand	[“diners”,“mastercard”,“visa”, “discover”, “amex”, “cabal”, “naranja”, “lider”, “maestro”, “nativa”, “nevada”, “cmr”, “argencard”, “cencosud”, “centrocard”,”mastercard_debit”,”visa_debit”,”mercadopago”,”ticket_nacion”,”jcb”]
Argentina	provider	["amex","cabal","first_data","naranja","prisma","visa"]
Argentina	region	['Buenos Aires', 'C.A.B.A.', 'Catamarca', 'Chaco','Chubut', 'Córdoba', 'Corrientes','Entre Ríos','Formosa','Jujuy','La Pampa','La Rioja','Mendoza','Misiones','Neuquén','Río Negro','Salta','San Juan','San Luis','Santa Fe','Santa Cruz','Santiago del Estero','Tucumán','Tierra del Fuego','not_informed']
Argentina	type	["general_cost_arancel", "general_cost_sell_discount", "general_cost_financial_cost", "general_cost_others_others", "general_cost_others_additional_service_ecommerce_service", "general_cost_others_additional_service", "general_cost_others_additional_service_no_present_credit_card", "taxation_taxation_iva_21_00", "taxation_taxation_iva_10_50", "taxation_taxation_debit-credit", "taxation_taxation_stamp","taxation_taxation_others", "taxation_perception_iva","taxation_perception_others", "taxation_perception_earnings","taxation_perception_gross_income", "taxation_withholding_iva","taxation_withholding_earnings", "taxation_withholding_gross_income","taxation_withholding_others"]
Ecuador	card_brand	["diners", "discover", "visa", "mastercard", "visa_debit", "amex", "jcb", "maestro", "union_pay"]
Ecuador	provider	["interdin", "pacific"]
Ecuador	Region	["not_informed"]
Ecuador	type	["general_cost_arancel", "general_cost others valor_no_comisionable", "taxation withholding iva", "taxation taxation iva", "taxation taxation ice", "taxation withholding irf", "taxation withholding fuente"]