{
  "info": {
    "_postman_id": "80e45baa-80ab-4078-887d-538400cf260e",
    "name": "Koncili - Financial Integration API",
    "description": "## Important\n\nThis collection was created to speed up your integration process with us, serving as a quick guide with the main endpoints and parameters.\n\nFor detailed information, business rules, and complete guides, please refer to our official documentation:  \n[https://developers.koncili.com/](https://developers.koncili.com/)\n\n## Need help?\n\nFor technical support, please contact [suporte@koncili.com](https://mailto:suporte@koncili.com)\n\nContact Support:  \nName: Suporte Koncili  \nEmail: [suporte@koncili.com](https://mailto:suporte@koncili.com)",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_exporter_id": "53419482",
    "_collection_link": "https://go.postman.co/collection/53419482-80e45baa-80ab-4078-887d-538400cf260e?source=collection_link"
  },
  "item": [
    {
      "name": "Authentication",
      "item": [
        {
          "name": "Generate JWT access tokens",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"credentials\": \"email:senha(base64)\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/public/api/auth/token",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "public",
                "api",
                "auth",
                "token"
              ],
              "variable": [
                {
                  "key": "environment",
                  "value": "{{environment}}",
                  "description": " (This can only be one of production,prod)"
                }
              ]
            },
            "description": "Authenticates the user using Base64-encoded credentials and returns access and refresh tokens.  \nCredentials format: `Base64(email + \":\" + password)`"
          },
          "response": []
        },
        {
          "name": "Renews access tokens using a refresh token",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"refreshToken\": \"refresh_token\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/public/api/auth/refresh-token",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "public",
                "api",
                "auth",
                "refresh-token"
              ],
              "variable": [
                {
                  "key": "environment",
                  "value": "{{environment}}",
                  "description": " (This can only be one of production,prod)"
                }
              ]
            },
            "description": "Generates a new token pair (access and refresh) using a valid refresh token."
          },
          "response": []
        }
      ],
      "description": "StartFragment🔑 Prior to accessing any API resources, a valid authentication token (**gumgaToken**) must be obtained.  \nThis token must be included in the header of all subsequent requests.EndFragment"
    },
    {
      "name": "Registrations and Settings",
      "item": [
        {
          "name": "Retrieve Marketplace List",
          "request": {
            "auth": {
              "type": "noauth"
            },
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gungaToken>",
                "description": "Authentication Token (required)"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/channel/list",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "channel",
                "list"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Retrieve Settlement Types by Marketplace",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "gumgaToken",
                "value": "<gungaToken>",
                "description": "Authentication Token (required)",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/releasetype/:channelName",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "releasetype",
                ":channelName"
              ],
              "variable": [
                {
                  "key": "channelName",
                  "value": "MERCADOLIVRE",
                  "description": "Nome do marketplace\n\n"
                }
              ]
            }
          },
          "response": []
        }
      ],
      "description": "⚙️ These endpoints provide auxiliary data—such as marketplace lists and available settlement types—to facilitate ERP configuration and data mapping.\n\n📌 Implementation Note: The registration and settings endpoints are primarily used during the initial ERP integration phase (channel parameterization and disbursement type mapping).  \nIn daily financial integration operations, usage is less frequent; however, they may be consulted for auditing, validation, or when adding new marketplaces."
    },
    {
      "name": "Reconciliation Queries",
      "item": [
        {
          "name": "Retrieve Unresolved Reconciliations",
          "protocolProfileBehavior": {
            "disabledSystemHeaders": {}
          },
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/unresolveds?offset=1&limit=100&initDate=2026-01-01&endDate=2026-01-31",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "unresolveds"
              ],
              "query": [
                {
                  "key": "offset",
                  "value": "1"
                },
                {
                  "key": "limit",
                  "value": "100"
                },
                {
                  "key": "initDate",
                  "value": "2026-01-01"
                },
                {
                  "key": "endDate",
                  "value": "2026-01-31"
                },
                {
                  "key": "conciliationId",
                  "value": null,
                  "disabled": true
                },
                {
                  "key": "channelName",
                  "value": "",
                  "type": "text",
                  "disabled": true
                },
                {
                  "key": "onlyUnread",
                  "value": "false",
                  "type": "text",
                  "disabled": true
                },
                {
                  "key": "onlyAnalyzed",
                  "value": "true",
                  "type": "text",
                  "disabled": true
                },
                {
                  "key": "dateTypeToFilter",
                  "value": "ORDER_DATE",
                  "type": "text",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "name": "Retrieve Resolved Conciliations",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)",
                "type": "text"
              },
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/concilieds?offset=1&limit=100&initDate=2026-01-01&endDate=2026-01-01&conciliationId&channelName",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "concilieds"
              ],
              "query": [
                {
                  "key": "offset",
                  "value": "1"
                },
                {
                  "key": "limit",
                  "value": "100"
                },
                {
                  "key": "initDate",
                  "value": "2026-01-01"
                },
                {
                  "key": "endDate",
                  "value": "2026-01-01"
                },
                {
                  "key": "conciliationId",
                  "value": null
                },
                {
                  "key": "channelName",
                  "value": null
                }
              ]
            }
          },
          "response": []
        }
      ],
      "description": "📊 Use these endpoints to retrieve reconciliations generated in Koncili, covering both pending and resolved records. These resources are essential for monitoring the end-to-end reconciliation lifecycle."
    },
    {
      "name": "Authorized IP Access Control",
      "item": [
        {
          "name": "Returns the list of IPs authorized for the access token (gumgaToken)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/externalapi/ip-segmentation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "ip-segmentation"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Authorize an IP",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"ip\": \"ip\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/ip-segmentation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "ip-segmentation"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Remove an authorized IP",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"ip\": \"ip\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/ip-segmentation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "ip-segmentation"
              ]
            }
          },
          "response": []
        }
      ],
      "description": "🔒 The Koncili API features an additional **IP-based security** mechanism, ensuring that only previously authorized addresses can perform authenticated calls.\n\nEach gumgaToken is linked to an **allowlist of authorized IPs**, and only these addresses are permitted to consume resources from the /externalapi/ endpoint."
    },
    {
      "name": "Batch Actions",
      "item": [
        {
          "name": "Batch Resolve Payouts in Koncili",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "[0]\r\n",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/resolve/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "resolve",
                "batch"
              ]
            }
          },
          "response": []
        },
        {
          "name": "Batch Update Payouts in Koncili as Read",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              },
              {
                "key": "gumgaToken",
                "value": "<gumgaToken>",
                "description": "Authentication Token (required)"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "[0]",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/externalapi/orderextract/read/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "externalapi",
                "orderextract",
                "read",
                "batch"
              ]
            }
          },
          "response": []
        }
      ],
      "description": "⚡ These endpoints allow you to update multiple payouts at once, making the process more agile and scalable. They are especially recommended for ERPs that process high order volumes."
    }
  ],
  "variable": [
    {
      "key": "environment",
      "value": "production"
    },
    {
      "key": "baseUrl",
      "value": "https://api.koncili.com"
    }
  ]
}