Skip to main content

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í

CampoTipoDescripción
idUUIDID de Increase que identifica la liquidación
payment_dateDATEFecha de pago de la liquidación
presentation_dateDATEFecha de presentación de la liquidación
card_brandSTRING o NULLMarca de la tarjeta. Ver Valores posibles por país
numberSTRINGNúmero de liquidación otorgado por la procesadora
providerSTRINGProveedor de la tarjeta. Ver Valores posibles por país
establishmentSTRINGNúmero de establecimiento
versionSTRINGVersión de la liquidación en Increase. Versión inicial de un payment siempre es 1.
Created_atSTRINGFecha de creación del payment en Increase
shop_nameSTRINGNombre de la sucursal (shop) configurado en Increase
BalancedOBJECTObjeto que detalla si la liquidación está balanceada o no.
       is_balancedBOOLEANEn true, la liquidación cumple con los 3 criterios de balanceo
       Total_movements_differenceDECIMALIndica la diferencia entre la Suma de los movimientos y el monto Bruto de la liquidación.
       Total_earn_differenceDECIMALIndica la diferencia entre el neto calculado (Total - descuentos) y el neto de la liquidación.
       Total_deduction_differenceDECIMALIndica la diferencia entre la suma de los descuentos y el descuento total de la liquidación
total_amountOBJECTObjeto referido al monto
       AmountDECIMALMonto total
       currencySTRINGMoneda del monto total
total_deductionOBJECTObjeto referido a las deducciones
       AmountDECIMALMonto total de las deducciones
       currencySTRINGMoneda del monto total de las deducciones
total_earnOBJECTObjeto que refiere al neto a cobrar
       AmountDECIMALMonto neto
       currencySTRINGMoneda del monto neto
Opening_balanceOBJECTSaldo anterior pendiente de pago
       AmountDECIMALMonto pendiente de pago
       currencySTRINGMoneda del monto pendiente de pago
closing_balanceOBJECTSaldo pendiente de cobro
       AmountDECIMALmonto pendiente de cobro
       currencySTRINGmoneda del monto pendiente de cobro
discountsOBJECTObjeto de descuentos que se le aplicaron a la liquidación
       typeSTRINGConcatenación que indica el tipo de descuento. Ver Valores posibles por país
       amountDECIMALMonto del descuento
       currencySTRING o NULLmoneda del descuento
       descriptionSTRING o NULLDescripción del descuento indicado en la liquidación
       rateDECIMAL o NULLPorcentaje del descuento
       regionSTRINGLa región correspondiente al descuento. Ver Valores posibles por país
acquiring_BankOBJECTObjeto con información del banco adquirente
       idUUIDId del banco en Increase
       nameSTRINGNombre del banco

Movements API

CampoTipoDescripción
idUUIDIdentificador de Increase del movimiento
payment_idUUIDIdentificador de increase del payment / liquidación
unique_movement_idSTRINGIdentificador unívoco del movimiento. No varía según la versión del payment.
presentation_dateSTRING o NULLFecha de presentación del movimiento
payment_dateSTRING o NULLFecha de pago del movimiento
origin_dateSTRING o NULLFecha de origen del movimiento
BatchSTRING o NULLNúmero de lote
coupon_numberSTRING o NULLNúmero de cupón
authorization_numberSTRING o NULLNúmero de autorización
terminal_numberSTRING o NULLNúmero de terminal
description_codeSTRING o NULLCódigo de descripción del movimiento
descriptionSTRING o NULLTexto descriptivo del movimiento
card_brandSTRINGMarca de la tarjeta con la que se hizo el movimiento. Ver Valores posibles por país
card_numberSTRING o NULLNúmero de tarjeta de tipo XXXXXX***XXXX
installmentsSTRING o NULLTotal de cuotas
installment_currentINTEGER o NULL.Cuota actual que se está pagando.
amountDECIMALMonto del movimiento
currencySTRINGMoneda del movimiento
typeSTRINGTipo de movimiento. Valores posibles:["adjustment", "chargeback", "refund", "rejection", "transaction"]
credit_typeSTRING/ NULLSubtipo de movimiento. Ver Valores posibles por país
consumption_amountDECIMAL o NULLMonto 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.
discountsOBJECTObjeto de descuentos que se le aplicaron al movimiento
       typeSTRINGConcatenación que te indica el tipo de descuento. Ver Valores posibles por país
       amountDECIMALMonto del descuento
       currencySTRING o NULLMoneda del descuento
       descriptionSTRING o NULLDescripción del descuento indicado en la liquidación
       rateDECIMAL o NULLPorcentaje del descuento
       regionSTRINGLa región correspondiente al descuento. Ver Valores posibles por país
issuing_bankSTRINGindica el banco emisor de la tarjeta

Taxes API

Campotipodescription
typeSTRINGConcatenación que indica el tipo de descuento. Ver Valores posibles por país
amountDECIMALMonto del impuesto
currencySTRINGMoneda del impuesto
descriptionSTRINGDescripción del impuesto
rateDECIMALPorcentaje del impuesto. Por ejemplo, 0.21 es 21%
regionSTRINGLa región correspondiente al impuesto. Ver Valores posibles por país

Países

PaísCampovalores posibles
Argentinacard_brand[“diners”,“mastercard”,“visa”, “discover”, “amex”, “cabal”, “naranja”, “lider”, “maestro”, “nativa”, “nevada”, “cmr”, “argencard”, “cencosud”, “centrocard”,”mastercard_debit”,”visa_debit”,”mercadopago”,”ticket_nacion”,”jcb”]
Argentinaprovider["amex","cabal","first_data","naranja","prisma","visa"]
Argentinaregion['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']
Argentinatype["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"]
Ecuadorcard_brand["diners", "discover", "visa", "mastercard", "visa_debit", "amex", "jcb", "maestro", "union_pay"]
Ecuadorprovider["interdin", "pacific"]
EcuadorRegion["not_informed"]
Ecuadortype["general_cost_arancel", "general_cost others valor_no_comisionable", "taxation withholding iva", "taxation taxation iva", "taxation taxation ice", "taxation withholding irf", "taxation withholding fuente"]