API de Costos fijos iniciales

Para consultas contactate a pay@increase.app

Recurso para obtener los costos fijos iniciales en Increase Pay o crear nuevos costos fijos iniciales

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 fijo#

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

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>
ParámetroTipoDescripción
name*StringNombre del costo fijo inicial
amount*StringMonto o porcentaje del costo fijo inicial "1500.0" (\$1500) o "0.4" (40%)
type*StringTipo de descuento ("flat" o "percentage")
currencyStringMoneda
external_idStringIdentificador del cliente en tu sistema.
descriptionStringDescripcion del costo fijo inicial
countryStringPaís en ISO 3166-1 alpha-3

Los par√°metros con * son obligatorios. El campo currecy es obligatorio si el type es "flat"

Body#

{
"external_id": "123",
"name": "Alta",
"description": "description",
"amount": "100.5",
"country": "ARG",
"type": "flat",
"currency": "ARS"
}

Response#

{
"id": "2909e32d-d28b-44a8-85c9-b4595076fa88",
"external_id": "123",
"type": "flat",
"name": "Alta",
"description": "description",
"amount": "100.5",
"country": "ARG",
"currency": "ARS"
}

Obtener todos los costos fijos iniciales#

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

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>

Par√°metros optativos#

ParámetroTipoDescripción
pageIntegerIndica la p√°gina a obtener resultados.
per_pageIntegerCantidad de resultados por p√°gina (M√°ximo 40).
countryIntegerPaís en ISO 3166-1 alpha-3.
currencyIntegerMoneda.

Response#

{
"data": [
{
"id": "2909e32d-d28b-44a8-85c9-b4595076fa88",
"external_id": "123",
"type": "flat",
"name": "Alta",
"description": "description",
"amount": "100.5",
"country": "ARG",
"currency": "ARS"
}
],
"current_page": 1,
"per_page": 20,
"total_pages": 1,
"total_elements": 1
}

Obtener un costo fijo inicial específico#

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

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>

Response#

{
"id": "2909e32d-d28b-44a8-85c9-b4595076fa88",
"external_id": "123",
"type": "flat",
"name": "Alta",
"description": "description",
"amount": "100.5",
"country": "ARG",
"currency": "ARS"
}

Actualizar un costo fijo inicial#

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

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>
ParámetroTipoDescripción
nameStringNombre del costo fijo inicial
amountStringMonto o porcentaje del costo fijo inicial "1500.0" (\$1500) o "0.4" (40%)
external_idStringIdentificador del cliente en tu sistema.
descriptionStringDescripcion del costo fijo inicial

Body#

{
"external_id": "123456",
"name": "Alta new",
"description": "description new",
"amount": "110.5"
}

Response#

{
"id": "2909e32d-d28b-44a8-85c9-b4595076fa88",
"external_id": "123456",
"type": "flat",
"name": "Alta new",
"description": "description new",
"amount": "110.5",
"country": "ARG",
"currency": "ARS"
}