API de impuestos

Ver en POSTMAN

Recurso para obtener los impuestos dados de alta en Increase Pay.

Cómo probar

Recuerda usar la Base URL de Sandbox para hacer pruebas: https://gateway.increase.app/pay-sandbox/public/v1/

URL Producción: https://gateway.increase.app/pay/public/v1/

Recordar siempre enviar en los headers Content-Type: application/json

Crear un impuesto

POST https://gateway.increase.app/pay/public/v1/taxes

Parámetro	Tipo	Descripción	Requerido	Permite update
type	String	Tipo de impuesto ("Flat", "Percentage")	si	no
name	String	Nombre del impuesto	si	si
amount	String	Entre 0 y 1 para porcentajes,sino enviar el monto.	si	si
external_id	String	Id para tu aplicación.	no	si
description	String	Descripcion del tax	no	si
country	String	País en ISO 3166-1 alpha-3. Ej: ARG	no	si
currency	String	Moneda en formato ISO 4217. Ej: ARS	no	no
region	String	Region del impuesto	no	si

Ejemplo

Request body

{
  "type": "flat",
  "name": "New tax",
  "amount": 120,
  "external_id": "9e8bc664-dd8f-4477-8336-0d2663536c85",
  "description": "Tax description",
  "country": "ARG",
  "currency": "ARS"
}

Response

{
  "id": "c367a515-92d7-44dc-8087-90d9dc6ed06d",
  "type": "flat",
  "name": "New tax",
  "amount": "120.0",
  "region": null,
  "created_at": "2021-09-30T15:09:26-03:00",
  "country": "ARG",
  "description": "Tax description",
  "external_id": "9e8bc664-dd8f-4477-8336-0d2663536c85"
}

Obtener todos los impuestos

GET https://gateway.increase.app/pay/public/v1/taxes

Parámetros optativos

Parámetro	Tipo	Descripción
Page	Integer	Indica la página a obtener resultados.
per_page	Integer	Cantidad de resultados por página (Máximo 40).

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "type": "flat",
      "name": "sapiente fugit",
      "amount": "29753.49",
      "region": null,
      "created_at": "2020-01-17T17:35:49-03:00"
    }
  ],
  "current_page": 1,
  "per_page": 20,
  "total_pages": 1,
  "total_elements": 1
}

Obtener un impuesto específico

GET https://gateway.increase.app/pay/public/v1/taxes/<id>

Response

{
    "id": "9cacf4ba-080f-4120-a84e-6b824e92fe39",
    "type": "flat",
    "name": "New tax",
    "amount": "130.0",
    "region": null,
    "created_at": "2021-09-30T15:04:36-03:00",
    "country": "ARG",
    "description": "Tax description updated",
    "external_id": "9e8bc664-dd8f-4477-8336-0d2663536c86"
}

Actualizar un impuesto específico

PUT https://gateway.increase.app/pay/public/v1/taxes/<id>

Ejemplo

Request body

{
  "name": "New tax",
  "amount": "130.0",
  "external_id": "9e8bc664-dd8f-4477-8336-0d2663536c86",
  "description": "Tax description updated",
  "country": "ARG",
  "region": null
}

Response

{
  "id": "9cacf4ba-080f-4120-a84e-6b824e92fe39",
  "type": "flat",
  "name": "New tax",
  "amount": "130.0",
  "region": null,
  "created_at": "2021-09-30T15:04:36-03:00",
  "country": "ARG",
  "description": "Tax description updated",
  "external_id": "9e8bc664-dd8f-4477-8336-0d2663536c86"
}