API de Costos adicionales

Ver en POSTMAN

Recurso para obtener los costos adicionales 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 Costo adicional

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

Parámetro	Tipo	Descripción	Requerido	Permite update
cycle_unit	String	Unidad de la cantidad de ciclos ("monthly", "daily", "weekly", "yearly"). Default: monthly	si	no
country	String	País en ISO 3166-1 alpha-3. Ej: ARG	si	no
name	String	Nombre del costo adicional	si	si
type	String	Tipo de costo adicional ("flat" o "percentage")	si	no
currency	String	Moneda en formato ISO 4217. Ej: ARS	si	no
amount	String	Monto o porcentaje del descuento "1500.0" (\$1500) o "0.4" (40%)	si	si
duration	String	Tiempo de vigencia del descuento ("periodic", "forever"). Default: periodic	si	no
cycle_amount	Int	Cantidad de ciclos	no	no
description	String	Descripcion del Costo adicional (ej: "Costo adicional paquete premium 2023")	no	no
external_id	String	Id para tu aplicación.	no	si

Ejemplo

Request body

{
  "name": "30% Paquete premium Prueba",
  "type": "percentage",
  "amount": "0.3",
  "currency": "ARG",
  "country": "ARG",
  "duration": "periodic",
  "cycle_unit": "monthly",
  "cycle_amount": 6,
  "description": "",
  "external_id": ""
}

Response

{
  "id": "b5d36020-25e2-4a35-baac-c0a27567fae7",
  "external_id": null,
  "name": "30% Paquete premium Prueba",
  "type": "percentage",
  "amount": "0.3",
  "currency": "ARS",
  "duration": "periodic",
  "cycle_unit": "monthly",
  "cycle_amount": 6,
  "created_at": "2020-01-17T17:35:49-03:00",
}

Obtener todos los costos adicionales

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

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",
      "name": "30% Paquete premium Prueba",
      "type": "percentage",
      "amount": "0.3",
      "currency": "ARS",
      "duration": "periodic",
      "cycle_unit": "monthly",
      "cycle_amount": 6,
      "created_at": "2020-01-17T17:35:49-03:00",
    }
  ],
  "current_page": 1,
  "per_page": 20,
  "total_pages": 1,
  "total_elements": 1
}