API de Pagos
Para consultas contactate a pay@increase.app
Recurso para obtener los pagos obtenidos en Increase Pay.
Cómo probar
Recuerda usar la Base URL de staging para hacer pruebas:
https://gateway.staging.increase.app/pay/public/v1/
Crear un pago
POST
https://gateway.increase.app/pay/public/v1/invoices/invoice_id/payments?customer_id=e488c220&invoice_id=9e1413e1&payment_method_id=7fe22a9a
Headers
Content-Type:application/json
Authorization: Bearer <access_token>
Parámetro | Tipo | Descripción |
---|---|---|
customer_id | String | Id del cliente pagador |
invoice_id | String | Id de la factura |
payment_method_id | String | Id del medio de pago |
Los parámetros con * son obligatorios
Body
{
"customer_id": "00000000-0000-0000-0000-000000000001",
"payment_method_id": "00000000-0000-0000-0000-000000000001"
}
Response
{
"id": "2e7c5c10-7e03-465c-810a-290ac6b1c9c0",
"status": "open",
"amount": "66.24",
"currency": "ARS",
"payment_method": {
"id": "00000000-0000-0000-0000-000000000001",
"external_id": null,
"data": {
"type": "cbu",
"country": "ARG",
"number": "19101134**4200"
},
"created_at": "2020-03-27T17:23:11-03:00"
},
"events": [],
"created_at": "2020-03-27T17:23:11-03:00",
"rejection_code": null,
"rejection_type": null,
"rejection_description": null,
"paid_at": null
}
Obtener todos los pagos
GET
https://gateway.increase.app/pay/public/v1/payments?page=3&per_page=15&customer_id=1f124a97&rejection_type=&paid_from=2020&paid_to=2020
Headers
Content-Type:application/json
Authorization: Bearer <access_token>
Parámetros
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). |
customer_id | String | Id del cliente pagador |
rejection_type | String | Tipo de rechazo |
paid_from | String (date) | Fecha de pago desde |
paid_to | String (date) | Fecha de pago hasta |
Success response
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000001",
"status": "processing",
"amount": "19.55",
"currency": "ARS",
"payment_method": {
"id": "00000000-0000-0000-0000-000000000001",
"external_id": null,
"data": {
"type": "cbu",
"country": "ARG",
"number": "19101134**4200"
},
"created_at": "2020-03-27T17:23:11-03:00"
},
"events": [],
"created_at": "2020-03-27T17:23:11-03:00",
"rejection_code": null,
"rejection_type": null,
"rejection_description": null,
"paid_at": null
}
],
"current_page": 1,
"per_page": 20,
"total_pages": 1,
"total_elements": 1
}
Obtener un pago específico
GET
https://gateway.increase.app/pay/public/v1/payments/id
Headers
Content-Type:application/json
Authorization: Bearer <access_token>
Obtener todos los pagos de un cliente específico
GET
https://gateway.increase.app/pay/public/v1/payments?page=1&per_page=12?customer_id=<customer_id>
Headers
Content-Type:application/json
Authorization: Bearer <access_token>
Reintentar un pago específico
POST
https://gateway.increase.app/pay/public/v1/payments/id/retry
Headers
Content-Type:application/json
Authorization: Bearer <access_token>
Generar un pago para una factura específica
POST
https://gateway.increase.app/pay/public/v1/invoices/<invoice_id>/payments?customer_id=e488c220&invoice_id=9e1413e1&payment_method_id=7fe22a9a
Headers
Content-Type:application/json
Authorization: Bearer <access_token>
Parámetro | Tipo | Descripción |
---|---|---|
customer_id | String | Id del cliente pagador |
invoice_id | String | Id de la factura |
payment_method_id | String | Id del medio de pago |