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[鈥渄iners鈥,鈥渕astercard鈥,鈥渧isa鈥, 鈥渄iscover鈥, 鈥渁mex鈥, 鈥渃abal鈥, 鈥渘aranja鈥, 鈥渓ider鈥, 鈥渕aestro鈥, 鈥渘ativa鈥, 鈥渘evada鈥, 鈥渃mr鈥, 鈥渁rgencard鈥, 鈥渃encosud鈥, 鈥渃entrocard鈥,鈥漨astercard_debit鈥,鈥漹isa_debit鈥,鈥漨ercadopago鈥,鈥漷icket_nacion鈥,鈥漥cb鈥漖
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"]