API de impuestos
Si ya estás gestionando tus suscripciones con Increase Pay contactate con soporte.pay@increase.app. Si queres sumarte, comunicate con pay@increase.app.
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
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Parámetro | Tipo | Descripción |
---|---|---|
type* | String | tipo de impuesto |
name* | String | nombre del impuesto |
amount* | String | Entre 0 y 1 para porcentajes,sino enviar el monto. |
external_id | String | Id para tu aplicación. |
description | String | Descripcion del tax |
country | String | País en ISO 3166-1 alpha-3 |
Los parámetros con * son obligatorios
Body
{
"type": "flat",
"name": "New tax",
"amount": 120,
"external_id": "9e8bc664-dd8f-4477-8336-0d2663536c85",
"description": "Tax description",
"country": "ARG"
}
Response
{
"id": "ead49527-7bf7-4ac6-b216-5fb87685c1a7",
"type": "flat",
"name": "test",
"amount": "100.0",
"region": null,
"created_at": "2020-01-17T17:35:49-03:00"
}
Obtener todos los impuestos
GET
https://gateway.increase.app/pay/public/v1/taxes
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
curl --include \
--header "Content-Type: application/json" \
--header "X-Auth-Token: <tu_access_token>" \
'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). |
Success 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>
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Actualizar un impuesto específico
PUT
https://gateway.increase.app/pay/public/v1/taxes/<id>
Headers
Content-Type: application/json
Authorization: Bearer <access_token>
Parámetro | Tipo | Descripción |
---|---|---|
name* | String | nombre del descuento |
amount* | String | monto del descuento |
region | String | region del impuesto |
external_id | String | Id para tu aplicación. |
description | String | Descripcion del tax |
country | String | País en ISO 3166-1 alpha-3 |
Body
{
"name": "test updated",
"amount": "200.0"
}
Response
{
"id": "ead49527-7bf7-4ac6-b216-5fb87685c1a7",
"type": "flat",
"name": "test updated",
"amount": "200.0",
"region": null,
"created_at": "2020-01-17T17:35:49-03:00"
}