NAV Navbar
shell

Introducción

Bienvenidos a la API de DATAPOS! Ponemos a disposición de todos nuestros clientes la posibilidad de acceder a toda su información de manera automática, integrándola con sus sistemas/plataformas de trabajo.

Todos los métodos requieren de autenticación, por lo que necesitarán solicitar al departamento de soporte técnico que les faciliten la API-KEY / API-SECRET de su cuenta.

Las rutas de nuestra API se conforman de la siguiente manera:

https://api.datapos.com.ar/[version]/[metodo]

Actualmente:

Parametro Valor
Version v1

Herramienta

Para empezar hacer pruebas con las API y ver su funcionamiento. Siempre es útil trabajar con alguna herramienta de comunicación donde puedas fácilmente parametrizar los datos que vas a enviar en el método y ver los resultados, antes de comenzar a implementarlo dentro de tu sistema.

La herramienta que recomendamos es Postman (Descargar), en la cual ya hemos preparado un paquete (Descargar) con todos los métodos y parámetros para que puedas importar y avanzar lo antes posible =).

Imagen Postman

Como se puede ver en la imagen de arriba, en la parte superior de la pantalla de Postman tenes la opción "Import" para importar los métodos de la API DATAPOS. Aprovechamos y en la misma imagen mostramos donde se debe completar las credenciales de seguridad que se utilizan en el método de autenticación que a continuación detallaremos.

Autenticación

Vas a poder acceder a la información de tu comercio como el calendario de cobros, las ventas, liquidaciones e impuestos.

Debemos asegurarnos que solamente pueda acceder a dicha información la persona con las credenciales autorizadas que son tu API-KEY y API-SECRET.

Obtener token

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
Authorization: "Basic" <base64(API-KEY + ":" + API-SECRET)>

# Body
{ "grant_type": "client_credentials" }

Para obtener el access_token por medio de OAuth, hay que enviar las credenciales de seguridad en el encabezado.

POST https://api.datapos.com.ar/oauth/access_token

Tener en cuenta que la credenciales de seguridad viajan en BASE64.

Resultado

El access_token obtenido, es la llave que te permitirá autorizar cada método donde vas a consultar la información de tu comercio.

{
    "access_token": "jssGCOGOuI9ObnH13ALToaLoXt2YTpZCoeHumzCmdNc.YLC_SzNNchw7QF5igo7E4zyyhBSuOWjzIrhTvrh2mAE",
    "expires_in": 3600,
    "token_type": "basic"
}
Demo
curl -X POST https://api.datapos.com.ar/oauth/access_token --header 'content-type: application/x-www-form-urlencoded' --data grant_type=client_credentials -u 'API-KEY:API-SECRET'

Remover token

# Header
X-Auth-Token: <TU_ACCESS_TOKEN>

El token te permite ser utilizado por una hora, y caduca automáticamente pasada la hora. Es recomendable una vez hayas finalizado de utilizar la API remuevas el token, como cuando cerras sessión al salir de cualquier plataforma.

Resultado

Devuelve un HTTP/1.1 200 OK, confirmando que se borro correctamente el token.

POST https://api.datapos.com.ar/oauth/revoke_token

Demo
curl -X POST http://api.datapos.com.ar/oauth/revoke_token --header 'X-Auth-Token: <TU_ACCESS_TOKEN>'

Métodos

Calendario de pagos

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

# Data
fecha=2019-12
comercios=140329,195392

Se devuelve todos los días del mes con el importe de ventas de cada día y el total acreditado en el banco.

GET https://api.datapos.com.ar/v1/calendario

Demo
curl -X GET http://api.datapos.com.ar/v1/calendario --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>' --data fecha=AÑO-MES --data comercios=<ID-COMERCIO-1>,<ID-COMERCIO-2>

Respuesta

[
  {
    "dia": "1",
    "fecha": "2019-12-01",
    "vendido": "0.00",
    "acreditado": "0.00"
  },
  {
    "dia": "2",
    "fecha": "2019-12-02",
    "vendido": "66,104.00",
    "acreditado": "11,918.17"
  },
  {
    "dia": "3",
    "fecha": "2019-12-03",
    "vendido": "2,582.00",
    "acreditado": "36,808.08"
  },
  {
    "dia": "4",
    "fecha": "2019-12-04",
    "vendido": "19,487.00",
    "acreditado": "25,520.76"
  }, ...
]

Parametros

Nombre Obligatorio Description
fecha SI Formato AAAA-MM, fecha del mes que se desea ver
comercios NO Lista de ID de comercio.

Comercios

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

Devuelve todos los comercios asociados a la cuenta.

GET https://api.datapos.com.ar/v1/comercios

Demo
curl -X GET http://api.datapos.com.ar/v1/comercios --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>'

Resultado

{
  "comercios": [
    {
      "id": "140329",
      "nombre": "SUCURSAL COMERCIO #1",
      "razon_social": "RAZÓN SOCIAL COM #1",
      "cuit": "30-70201235-7",
      "direccion": "Avenida siempre viva 555",
      "codigo_postal": "1224",
      "provincia": "Buenos Aires",
      "localidad": "Berazategui",
      "rubro": "MUEBLES"
    },
    {
      "id": "195392",
      "nombre": "SUCURSAL COMERCIO #2",
      "razon_social": "RAZÓN SOCIAL COM #2",
      "cuit": "30-70201235-7",
      "direccion": "Avenida siempre viva 2180",
      "codigo_postal": "1280",
      "provincia": "Buenos Aires",
      "localidad": "Berazategui",
      "rubro": "MUEBLES"
    },...
  ],
  "total": 5
}

Operaciones

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

# Data
campo_fecha=fecha_venta
fecha_desde=2020-01-01
fecha_hasta=2020-01-31
reg_pagina=10
pagina=1
comercios=140329,195392
lote=419
comprobante=1390
tarjeta_nro=9341
importe=18521

Se obtienen todas las operaciones/cupones de ventas del comercio.

GET https://api.datapos.com.ar/v1/operaciones

Demo
curl -X GET http://api.datapos.com.ar/v1/operaciones --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>' --data campo_fecha=fecha_presentacion --data fecha_desde=2020-01-01 --data fecha_hasta=2020-01-31

Resultado

{
  "operaciones": [
    {
      "id": "8307695358",
      "fecha_venta": "2020-01-02",
      "fecha_presentacion": "2020-01-02",
      "tarjeta": "VISA",
      "marca": "FIRSTDATA",
      "establecimiento": "22494455",
      "terminal": "39020872",
      "lote": "367",
      "comprobante": "1152",
      "tarjeta_nro": "6610",
      "cuotas": "12",
      "importe": "1320",
      "comercio": "SUCURSAL COMERCIO #1",
      "fecha_pago": "2020-01-16"
    },
    {
      "id": "8307700395",
      "fecha_venta": "2020-01-02",
      "fecha_presentacion": "2020-01-02",
      "tarjeta": "VISA",
      "marca": "FIRSTDATA",
      "establecimiento": "22494455",
      "terminal": "39020872",
      "lote": "367",
      "comprobante": "1151",
      "tarjeta_nro": "4710",
      "cuotas": "1",
      "importe": "359",
      "comercio": "SUCURSAL COMERCIO #1",
      "fecha_pago": "2020-01-16"
    }, ...
  ],
  "total": 230
}

Parametros

Nombre Obligatorio Description
fecha_desde SI Formato AAAA-MM-DD, fecha desde la operación.
fecha_hasta SI Formato AAAA-MM-DD, fecha hasta la operación.
campo_fecha NO Por defecto se busca por "Fecha Venta". Opciones (fecha_venta, fecha_presentacion, fecha_pago).
reg_pagina NO Cantidad de registros por página, por defecto se devuelven 25 registros, máximo 100.
pagina NO El número de página de los resultados que desea obtener.
comercios NO Lista de ID de comercio.
lote NO Por número de lote
comprobante NO Por número de comprobante
tarjeta_nro NO Por número de tarjeta
importe NO Por importe de venta

Liquidaciones

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

# Data
fecha_desde=2020-02-01
fecha_hasta=2020-02-29
reg_pagina=10
pagina=1
comercios=140329,195392
detalle=true
marca=FIRSTDATA
banco=29

Se obtienen el detalle de las liquidaciones de todas las marcas.

GET https://api.datapos.com.ar/v1/liquidaciones

Demo
curl -X GET http://api.datapos.com.ar/v1/liquidaciones --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>' --data fecha_desde=2020-01-01 --data fecha_hasta=2020-01-31

Resultado

{
  "liquidaciones": [
{
  "id": "403539255",
  "marca": "FIRSTDATA",
  "tarjeta": "MASTERCARD",
  "comercio": "SUCURSAL COMERCIO #1",
  "provincia": "Buenos Aires",
  "banco": "BANCO BBVA Francés",
  "establecimiento": "22494455",
  "tipo": "L",
  "numero": "40920",
  "fecha": "04/02/2020",
  "fecha_recupero_adelanto": null,
  "facturado_debito": "0.00",
  "facturado_credito": "1375.00",
  "facturado_credito_cuotas": "0.00",
  "facturado_descontado": "0.00",
  "facturado_otro": "0.00",
  "total_facturado": "1375.00",
  "descontado_arancel": "27.50",
  "descontado_promocion": "0.00",
  "descontado_impuesto": "46.21",
  "descontado_cuota": "0.00",
  "descontado_adelanto": "0.00",
  "descontado_otro": "0.00",
  "total_descontado": "73.71",
  "total_acreditado": "1301.29",
  "detalle": {
    "ventas": [
      {
        "descripcion": "Venta ctdo",
        "terminal": "495655",
        "lote": "10",
        "comprobante": "101",
        "transacciones": "",
        "tarjeta": "1042",
        "importe": "900.00",
        "motivo": "VENTA"
      },
      {
        "descripcion": "Venta ctdo",
        "terminal": "495655",
        "lote": "10",
        "comprobante": "107",
        "transacciones": "",
        "tarjeta": "1042",
        "importe": "475.00",
        "motivo": "VENTA"
      }
    ],
    "descuentos": [
      {
        "descripcion": "ARANCEL",
        "porcentaje": "",
        "cuotas": "",
        "importe": "27.50",
        "tipo": "",
        "motivo": "COSTO TARJETAS"
      },
      {
        "descripcion": "IVA CRED.FISC.COMERCIO S/ARANC 21,00%",
        "porcentaje": "21",
        "cuotas": "",
        "importe": "5.78",
        "tipo": "IMP",
        "motivo": "IVA"
      },
      {
        "descripcion": "RETENCION IVA",
        "porcentaje": "",
        "cuotas": "",
        "importe": "40.43",
        "tipo": "RET",
        "motivo": "IVA"
      }
    ]
  }
}, ...
],
"total": 45
}

Parametros

Nombre Obligatorio Description
fecha_desde SI Formato AAAA-MM-DD, fecha desde la liquidación.
fecha_hasta SI Formato AAAA-MM-DD, fecha hasta la liquidación.
reg_pagina NO Cantidad de registros por página, por defecto se devuelven 10 registros, máximo 50.
pagina NO El número de página de los resultados que desea obtener.
detalle NO Por defecto es "false", para obtener el detalle de la liquidación (ventas/descuentos) "true".
comercios NO Lista de ID de comercio.
marca NO Marca. Opciones(PRISMA
banco NO ID del banco.

Liquidaciones Totales

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

# Data
fecha_desde=2020-02-01
fecha_hasta=2020-02-29
comercios=140329,195392
marca=PRISMA
banco=29

Se obtienen los totales de las liquidaciones de todas las marcas entre el periodo filtrado.

GET https://api.datapos.com.ar/v1/liquidaciones/totales

Demo
curl -X GET http://api.datapos.com.ar/v1/liquidaciones/totales --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>' --data fecha_desde=2020-01-01 --data fecha_hasta=2020-01-31

Resultado

[
  {
    "tarjeta": "MASTERCARD",
    "fac_debito": "853.00",
    "fac_credito": "10,493.00",
    "fac_credito_cuotas": "4,124.00",
    "fac_descontado": "0.00",
    "fac_otro": "0.00",
    "total_facturado": "15,470.00",
    "des_arancel": "300.02",
    "des_promocion": "0.00",
    "des_impuesto": "595.98",
    "des_cuota": "377.35",
    "des_adelanto": "0.00",
    "des_otro": "11.50",
    "total_descontado": "1,284.85",
    "total_acreditado": "14,185.15"
  },
  {
    "tarjeta": "VISA",
    "fac_debito": "12,941.20",
    "fac_credito": "8,797.50",
    "fac_credito_cuotas": "117,314.35",
    "fac_descontado": "0.00",
    "fac_otro": "0.00",
    "total_facturado": "139,053.05",
    "des_arancel": "2,638.72",
    "des_promocion": "0.00",
    "des_impuesto": "6,648.33",
    "des_cuota": "10,991.16",
    "des_adelanto": "0.00",
    "des_otro": "1,530.48",
    "total_descontado": "21,808.69",
    "total_acreditado": "117,244.36"
  }
]

Parametros

Nombre Obligatorio Description
fecha_desde SI Formato AAAA-MM-DD, fecha desde la liquidación.
fecha_hasta SI Formato AAAA-MM-DD, fecha hasta la liquidación.
comercios NO Lista de ID de comercio.
marca NO Marca. Opciones(PRISMA
banco NO ID del banco.

Impuestos

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

# Data
fecha_desde=2020-02-13
fecha_hasta=2020-02-29
reg_pagina=10
pagina=1
comercios=140329,195392
detalle=true
tarjetas=FIRSTDATA-VISA,FIRSTDATA-MASTERCARD,AMEX-AMEX

Se obtienen el detalle de los impuestos de todas las marcas.

GET https://api.datapos.com.ar/v1/impuestos

Demo
curl -X GET http://api.datapos.com.ar/v1/impuestos --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>' --data fecha_desde=2020-01-13 --data fecha_hasta=2020-01-31

Resultado

{
  "liquidaciones": [
    {
      "id": "409623951",
      "marca": "FIRSTDATA",
      "tarjeta": "VISA",
      "comercio": "SUCURSAL COMERCIO #1",
      "provincia": "Buenos Aires",
      "establecimiento": "22494455",
      "tipo": "L",
      "numero": "42511",
      "fecha": "13/02/2020",
      "impuesto_iva_105": "194.76",
      "impuesto_iva_21": "85.14",
      "imp_iva": "279.90",
      "impuesto_otros": "0.00",
      "total_impuestos": "279.90",
      "retencion_iva": "540.35",
      "retencion_iibb": "86.46",
      "retencion_ganancias": "180.12",
      "retencion_otros": "0.00",
      "total_retenciones": "806.93",
      "percepcion_iva": "0.00",
      "percepcion_iibb": "33.90",
      "percepcion_ganancias": "0.00",
      "percepcion_otros": "0.00",
      "total_percepciones": "33.90",
      "detalle": [
        {
          "tipo": "IMPUESTO",
          "motivo": "IVA",
          "descripcion": "IVA CRED.FISC.COMERCIO S/ARANC 21,00%",
          "porcentaje": "21",
          "importe": "85.14"
        },
        {
          "tipo": "PERCEPCION",
          "motivo": "IIBB",
          "descripcion": "PER B.A.I.BR.DN.01/04",
          "porcentaje": null,
          "importe": "33.90"
        },
        {
          "tipo": "RETENCIÓN",
          "motivo": "IIBB",
          "descripcion": "RETENCION ING.BRUTOS BUENOS AIRES",
          "porcentaje": null,
          "importe": "86.46"
        },
        {
          "tipo": "RETENCIÓN",
          "motivo": "IVA",
          "descripcion": "RETENCION IVA",
          "porcentaje": null,
          "importe": "540.35"
        },
        {
          "tipo": "RETENCIÓN",
          "motivo": "GANANCIAS",
          "descripcion": "RETENCION IMP.GANANCIAS",
          "porcentaje": null,
          "importe": "180.12"
        },
        {
          "tipo": "IMPUESTO",
          "motivo": "IVA",
          "descripcion": "IVA PROMO CUOTAS AHORA 12/18 - 10,50%",
          "porcentaje": "10.5",
          "importe": "194.76"
        }
      ]
    }, ...
],
"total": 25
}

Parametros

Nombre Obligatorio Description
fecha_desde SI Formato AAAA-MM-DD, fecha desde la liquidación.
fecha_hasta SI Formato AAAA-MM-DD, fecha hasta la liquidación.
reg_pagina NO Cantidad de registros por página, por defecto se devuelven 10 registros, máximo 50.
pagina NO El número de página de los resultados que desea obtener.
detalle NO Por defecto es "false", para obtener el detalle de la liquidación (ventas/descuentos) "true".
comercios NO Lista de ID de comercio.
tarjetas NO Lista de tarjetas. Ej.: PRISMA-VISA,FIRSTDATA-MASTERCARD,AMEX-AMEX (*)

(*) Lista de marcas y tarjetas

Marca Tarjeta
PRISMA VISA, CABAL, MASTERCARD
FIRSTDATA MASTERCARD, MASTERCARD DEBIT, MAESTRO, VISA, VISA DEBIT, DINERS
AMEX AMEX
CABAL CABAL
NARANJA NARANJA
BPN CONFIABLE BPN CONFIABLE

Impuestos Totales

# Header
Content-Type:application/x-www-form-urlencoded
Accept:application/json
X-Auth-Token: <TU_ACCESS_TOKEN>

# Data
fecha_desde=2020-02-13
fecha_hasta=2020-02-29
comercios=140329,195392
tarjetas=FIRSTDATA-VISA,FIRSTDATA-MASTERCARD,AMEX-AMEX

Se obtienen los totales de los impuestos de todas las marcas entre el periodo filtrado.

GET https://api.datapos.com.ar/v1/impuestos/totales

Demo
curl -X GET http://api.datapos.com.ar/v1/impuestos/totales --header 'Content-Type: application/x-www-form-urlencoded' --header 'X-Auth-Token: <TU_ACCESS_TOKEN>' --data fecha_desde=2020-01-13 --data fecha_hasta=2020-01-31

Resultado

{
  "imp_iva_105": "7,822.86",
  "imp_iva_21": "5,109.56",
  "imp_iva": "12,932.42",
  "imp_otros": "0.00",
  "tot_impuestos": "12,932.42",
  "ret_iva": "29,634.49",
  "ret_iibb": "6,496.21",
  "ret_ganancias": "7,335.86",
  "ret_otros": "0.00",
  "tot_retenciones": "43,466.56",
  "per_iva": "81.36",
  "per_iibb": "1,325.87",
  "per_ganancias": "0.00",
  "per_otros": "0.00",
  "tot_percepciones": "1,407.23"
}

Parametros

Nombre Obligatorio Description
fecha_desde SI Formato AAAA-MM-DD, fecha desde la liquidación.
fecha_hasta SI Formato AAAA-MM-DD, fecha hasta la liquidación.
comercios NO Lista de ID de comercio.
tarjetas NO Lista de tarjetas. Ej.: PRISMA-VISA,FIRSTDATA-MASTERCARD,AMEX-AMEX (*)

(*) Lista de marcas y tarjetas

Marca Tarjeta
PRISMA VISA, CABAL, MASTERCARD
FIRSTDATA MASTERCARD, MASTERCARD DEBIT, MAESTRO, VISA, VISA DEBIT, DINERS
AMEX AMEX
CABAL CABAL
NARANJA NARANJA
BPN CONFIABLE BPN CONFIABLE
shell