API de Pagos
Ver en POSTMAN
Recurso para obtener los pagos obtenidos 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 pago
POST
https://gateway.increase.app/pay/public/v1/invoices/<invoice_id>/payments
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
| customer_id | String | Id del cliente pagador | si |
| invoice_id | String | Id de la factura | si |
| payment_method_id | String | Id del medio de pago | si |
Ejemplo
- Request body
- Response
{
"customer_id": "00000000-0000-0000-0000-000000000001",
"payment_method_id": "00000000-0000-0000-0000-000000000001"
}
{
"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
Parámetros
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
| Page | Integer | Indica la página a obtener resultados. | no |
| per_page | Integer | Cantidad de resultados por página (Máximo 40). | no |
| customer_id | String | Id del cliente pagador | no |
| rejection_type | String | Tipo de rechazo | no |
| paid_from | String (date) | Fecha de pago desde | no |
| paid_to | String (date) | Fecha de pago hasta | no |
| status | String | Estado del pago (open, processing, approved, failed, reversed) | no |
| updated_at_from | String (date) | Fecha de actualizacion de pago desde | no |
| updated_at_to | String (date) | Fecha de actualizacion de pago hasta | no |
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 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>
Obtener un pago específico
GET
https://gateway.increase.app/pay/public/v1/payments/<id>
Response
{
"id": "ad4414be-68ff-4b36-96ea-2e494a596030",
"status": "open",
"refund_status": "unrequested",
"amount": "40.0",
"currency": "ARS",
"payment_method": {
"id": "ad8a00b5-74a1-46c3-bdce-f3d1625de131",
"external_id": "8999462605",
"data": {
"country": "ARG",
"number": "503175**0604",
"type": "card",
"cardholder_identification_type": "DNI",
"cardholder_identification_number": "221231231",
"expiration_month": 11,
"expiration_year": 2025,
"first_six_digits": "503175",
"last_four_digits": "0604",
"issuer_name": "Mastercard",
"cardholder_name": "APRO",
"card_brand_name": "Mastercard",
"card_brand_payment_type_id": "credit_card"
},
"created_at": "2021-09-30T17:40:06-03:00",
"collect_method_id": "d2a7fd90-a8da-4276-8fee-2b5f91edab61"
},
"events": [],
"created_at": "2021-10-01T10:57:40-03:00",
"invoice_id": "abee7fce-aac1-444b-9d73-c57f38dfe30d",
"rejection_code": null,
"rejection_type": null,
"updated_at": "2021-10-01T10:57:40.151-03:00",
"rejection_description": null,
"paid_at": null,
"invoice": {
"id": "abee7fce-aac1-444b-9d73-c57f38dfe30d",
"status": "open",
"amount": "40.0",
"external_id": "ae8487c3-b737-43cc-af66-f0d942c78c94",
"customer": {
"id": "4b214574-8870-49a0-a91e-3e9ac73fd333",
"email": "test@test.com",
"first_name": "Customer",
"last_name": "Test",
"external_id": "ID de su sistema"
},
"subscriptions": [],
"currency": "ARS",
"created_at": "2021-10-01T10:53:16-03:00",
"paid_at": null,
"checkout_link": "https://gateway.increase.app/pay-sandbox/checkout/v1/short_urls/4AqvJC",
"success_url": "https://increase.app/thanks?invoice_id=abee7fce-aac1-444b-9d73-c57f38dfe30d&customer_id=4b214574-8870-49a0-a91e-3e9ac73fd333",
"collect_methods": {
"cbu": [
{
"id": "a2bb722a-9d6d-4bdc-92ec-a8e329ec7358",
"name": "comafi",
"type": "comafi",
"status": "enabled",
"country": "ARG",
"max_payment_retries": 1,
"retry_period_time": 1,
"retry_period_unit": "hours",
"currencies": [
"ARS"
],
"payment_categories": [
"cbu"
],
"metadata": {
"company_code": "merch",
"cuit": "30710123388",
"account_number": "221312344565671",
"beneficiary": "merchantex",
"id_size": 1
}
}
],
"card": [
{
"id": "d2a7fd90-a8da-4276-8fee-2b5f91edab61",
"name": "Mercadopago Connect",
"type": "mercadopago_connect",
"status": "enabled",
"country": "ARG",
"max_payment_retries": 0,
"retry_period_time": 0,
"retry_period_unit": "days",
"currencies": [
"ARS"
],
"payment_categories": [
"card"
],
"public_key": "APP_USR-29d56597-5025-449c-883c-00b8a6c4c89c",
"metadata": {
"expiration_days": 30,
"offline_payments_enabled": false
}
}
],
"ticket": []
},
"invoice_items": [
{
"id": "00d9d5c4-a14c-4395-adb3-ce39910c74ef",
"invoice_id": "abee7fce-aac1-444b-9d73-c57f38dfe30d",
"description": "Item description",
"quantity": 2,
"unit_price": "20.0",
"amount": "40.0",
"currency": "ARS",
"item_number": 0,
"invoiceable_id": null,
"invoiceable_type": null,
"created_at": "2021-10-01T10:53:16.079-03:00",
"updated_at": "2021-10-01T10:53:16.079-03:00",
"product_id": null,
"denormalized_product_name": null,
"applicable_type": null,
"applicable_id": null
}
],
"payments": [
{
"id": "ad4414be-68ff-4b36-96ea-2e494a596030",
"invoice_id": "abee7fce-aac1-444b-9d73-c57f38dfe30d",
"payment_method_id": "ad8a00b5-74a1-46c3-bdce-f3d1625de131",
"status": "open",
"amount": "40.0",
"currency": "ARS",
"id_for_collect_provider": 1881,
"created_at": "2021-10-01T10:57:40.151-03:00",
"updated_at": "2021-10-01T10:57:40.151-03:00",
"denormalized_customer_email": "test@test.com",
"retry_count": 0,
"metadata": {},
"rejection_code": null,
"rejection_type": null,
"account_id": "59640063-5b68-403e-9ddc-948d582cf8f2",
"rejection_description": null,
"paid_at": null,
"processor_reference_id": null,
"denormalized_customer_first_name": "Customer",
"denormalized_customer_last_name": "Test",
"refund_status": "unrequested",
"refresh_date": null,
"stop_debit": false,
"sync": false
}
]
},
"processor_reference_id": null,
"external_resource_url": null,
"refundable": true
}
Reintentar un pago específico
POST
https://gateway.increase.app/pay/public/v1/payments/<id>/retry
Response
{
"id": "2262ed25-7079-4a46-b9a5-52fff9d3c1d4",
"status": "failed",
"refund_status": "unrequested",
"amount": "39.0",
"currency": "ARS",
"payment_method": {
"id": "ad8a00b5-74a1-46c3-bdce-f3d1625de131",
"external_id": "8999462605",
"data": {
"country": "ARG",
"number": "503175**0604",
"type": "card",
"cardholder_identification_type": "DNI",
"cardholder_identification_number": "221231231",
"expiration_month": 11,
"expiration_year": 2025,
"first_six_digits": "503175",
"last_four_digits": "0604",
"issuer_name": "Mastercard",
"cardholder_name": "APRO",
"card_brand_name": "Mastercard",
"card_brand_payment_type_id": "credit_card"
},
"created_at": "2021-09-30T17:40:06-03:00",
"collect_method_id": "d2a7fd90-a8da-4276-8fee-2b5f91edab61"
},
"events": [
{
"id": "a645518e-5907-4081-93b2-cfcbfccd354b",
"name": "processor_response",
"message": "La orden de pago ha sido rechazada.",
"status_from": "processing",
"status_to": "failed",
"created_at": "2021-10-01T11:05:09-03:00"
},
{
"id": "3d1fd4a9-48ff-4a9a-b93a-0522ed8b3d2c",
"name": "processor_response",
"message": "La orden de pago fue enviada a procesarse.",
"status_from": "open",
"status_to": "processing",
"created_at": "2021-10-01T11:05:08-03:00"
},
{
"id": "3a528c7e-6997-49c1-b23f-f5f76691530e",
"name": "payment_created",
"message": "La orden de pago ha sido creada.",
"status_from": "created",
"status_to": "open",
"created_at": "2021-10-01T11:02:57-03:00"
}
],
"created_at": "2021-10-01T11:02:57-03:00",
"invoice_id": "35f76fa9-6238-4ade-ac9d-352452cb1ad7",
"rejection_code": "cc_rejected_insufficient_amount",
"rejection_type": "retryable",
"updated_at": "2021-10-01T11:05:09.135-03:00",
"rejection_description": "Monto insuficiente",
"paid_at": null,
"invoice": {
"id": "35f76fa9-6238-4ade-ac9d-352452cb1ad7",
"status": "open",
"amount": "39.0",
"external_id": "ae8487c3-b737-43cc-af66-f0d942c78c94",
"customer": {
"id": "4b214574-8870-49a0-a91e-3e9ac73fd333",
"email": "test@test.com",
"first_name": "Customer",
"last_name": "Test"
},
"subscriptions": [],
"currency": "ARS",
"created_at": "2021-10-01T11:02:57-03:00",
"paid_at": null,
"checkout_link": "https://gateway.increase.app/pay-sandbox/checkout/v1/short_urls/osj-x7",
"success_url": "https://increase.app/thanks?invoice_id=35f76fa9-6238-4ade-ac9d-352452cb1ad7&customer_id=4b214574-8870-49a0-a91e-3e9ac73fd333",
"collect_methods": {
"cbu": [
{
"id": "a2bb722a-9d6d-4bdc-92ec-a8e329ec7358",
"name": "comafi",
"type": "comafi",
"status": "enabled",
"country": "ARG",
"max_payment_retries": 1,
"retry_period_time": 1,
"retry_period_unit": "hours",
"currencies": [
"ARS"
],
"payment_categories": [
"cbu"
],
"metadata": {
"company_code": "merch",
"cuit": "30710123388",
"account_number": "221312344565671",
"beneficiary": "merchantex",
"id_size": 1
}
}
],
"card": [
{
"id": "d2a7fd90-a8da-4276-8fee-2b5f91edab61",
"name": "Mercadopago Connect",
"type": "mercadopago_connect",
"status": "enabled",
"country": "ARG",
"max_payment_retries": 0,
"retry_period_time": 0,
"retry_period_unit": "days",
"currencies": [
"ARS"
],
"payment_categories": [
"card"
],
"public_key": "APP_USR-29d56597-5025-449c-883c-00b8a6c4c89c",
"metadata": {
"expiration_days": 30,
"offline_payments_enabled": false
}
}
],
"ticket": []
},
"invoice_items": [
{
"id": "cd5b406b-9d42-40a5-b6b4-09c8a6f89122",
"invoice_id": "35f76fa9-6238-4ade-ac9d-352452cb1ad7",
"description": "Item description",
"quantity": 1,
"unit_price": "39.0",
"amount": "39.0",
"currency": "ARS",
"item_number": 0,
"invoiceable_id": null,
"invoiceable_type": null,
"created_at": "2021-10-01T11:02:57.162-03:00",
"updated_at": "2021-10-01T11:02:57.162-03:00",
"product_id": null,
"denormalized_product_name": null,
"applicable_type": null,
"applicable_id": null
}
],
"payments": [
{
"id": "92b2920a-b28c-4bfe-9a70-10825cc42b72",
"invoice_id": "35f76fa9-6238-4ade-ac9d-352452cb1ad7",
"payment_method_id": "ad8a00b5-74a1-46c3-bdce-f3d1625de131",
"status": "open",
"amount": "39.0",
"currency": "ARS",
"id_for_collect_provider": 1883,
"created_at": "2021-10-01T11:07:04.930-03:00",
"updated_at": "2021-10-01T11:07:04.930-03:00",
"denormalized_customer_email": "test@test.com",
"retry_count": 1,
"metadata": {},
"rejection_code": null,
"rejection_type": null,
"account_id": "59640063-5b68-403e-9ddc-948d582cf8f2",
"rejection_description": null,
"paid_at": null,
"processor_reference_id": null,
"denormalized_customer_first_name": "Customer",
"denormalized_customer_last_name": "Test",
"refund_status": "unrequested",
"refresh_date": null,
"stop_debit": false,
"sync": false
},
{
"id": "2262ed25-7079-4a46-b9a5-52fff9d3c1d4",
"invoice_id": "35f76fa9-6238-4ade-ac9d-352452cb1ad7",
"payment_method_id": "ad8a00b5-74a1-46c3-bdce-f3d1625de131",
"status": "failed",
"amount": "39.0",
"currency": "ARS",
"id_for_collect_provider": 1882,
"created_at": "2021-10-01T11:02:57.184-03:00",
"updated_at": "2021-10-01T11:05:09.135-03:00",
"denormalized_customer_email": "test@test.com",
"retry_count": 0,
"metadata": {
"mercadopago_id": null,
"authorization_code": null,
"external_resource_url": null
},
"rejection_code": "cc_rejected_insufficient_amount",
"rejection_type": "retryable",
"account_id": "59640063-5b68-403e-9ddc-948d582cf8f2",
"rejection_description": "Monto insuficiente",
"paid_at": null,
"processor_reference_id": "14651014388",
"denormalized_customer_first_name": "Customer",
"denormalized_customer_last_name": "Test",
"refund_status": "unrequested",
"refresh_date": "2021-10-01T14:05:08.594-03:00",
"stop_debit": false,
"sync": false
}
]
},
"processor_reference_id": "14651014388",
"external_resource_url": null,
"refundable": true
}
Revertir un pago
POST
https://gateway.increase.app/pay/public/v1/payments/<id>/reverse
Response
{
"id": "022bc885-02ec-44e2-a5b9-22bec4868931",
"status": "reversed",
"refund_status": "approved",
"amount": "990.0",
"currency": "ARS",
"payment_method": {
"id": "86875c72-521c-492a-be3c-3724caf505c4",
"external_id": "CID-150a72c4-731f-46e6-b069-3a6196e559ac",
"data": {
"cardholder_name": "APPRO",
"expiration_month": 9,
"expiration_year": 2023,
"issuer_name": "MC",
"country": "ARG",
"number": "***6351",
"type": "dlocal",
"error": {
"rejection_code": "7000",
"rejection_type": "retryable",
"rejection_description": "No se pudo procesar la solicitud"
}
},
"created_at": "2023-06-28T18:10:12Z",
"collect_method_id": "f40cd192-7c82-4c60-904c-efd8ecf1e77b"
},
"events": [
{
"id": "041955d7-7306-4fb8-9ff9-ec90c9f15ee9",
"name": "processor_response",
"message": "Se envió la orden de devolución al procesador.",
"status_from": "refund_unrequested",
"status_to": "refund_processing",
"created_at": "2023-07-21T18:19:17Z"
},
{
"id": "7b33da12-aef7-49d7-9579-22973aa70484",
"name": "processor_response",
"message": "El pago ha sido aprobado.",
"status_from": "processing",
"status_to": "approved",
"created_at": "2023-07-21T09:11:35Z"
},
...
],
"created_at": "2023-07-21T09:02:16Z",
"invoice_id": "9d179870-ec82-40b5-b1d4-1f91530b64f5",
"rejection_code": null,
"rejection_type": null,
"updated_at": "2023-07-21T18:19:19.965Z",
"rejection_description": null,
"paid_at": "2023-07-21T09:09:29Z",
"invoice": {
"id": "9d179870-ec82-40b5-b1d4-1f91530b64f5",
"status": "paid",
"amount": "990.0",
"external_id": null,
"customer": {
...
},
"subscriptions": [
{
"id": "4ce53a5b-0f2a-48e8-816c-55da8679c076",
...
}
],
"currency": "ARS",
"created_at": "2023-07-21T09:02:15Z",
"paid_at": "2023-07-21T09:09:29Z",
"checkout_link": "https://gateway.staging.increase.app/pay/checkout/v1/short_urls/X1jnf1",
"success_url": null,
"collect_methods": {
"cbu": [],
"card": [],
"ticket": []
},
"invoice_items": [
...
],
"payments": [
...
]
},
"processor_reference_id": "T-161036-654da364-09fd-40ab-ae77-ec22bc1f8d00",
"external_resource_url": null,
"refundable": true
}