{ "info": { "_postman_id": "c7a057c65e2bf2861b8cc0383a1571aa", "name": "Core (Español)", "description": "Colección generada automáticamente desde la definición OpenAPI publicada en Placetopay Docs. La variable base_url ya está configurada con la dirección del entorno de pruebas.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://test.placetopay.com/rest" } ], "item": [ { "name": "Creación de un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/create", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "create" ] }, "description": "Este servicio permite crear un comercio. Si el proceso es exitoso, se retorna el identificador del comercio y su estado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"data\": {\n \"name\": \"Merchant name\",\n \"brand\": \"Merchant brand\",\n \"mcc\": \"0742\",\n \"active\": true,\n \"timezone\": \"America/Bogota\",\n \"size\": \"XS\",\n \"url\": \"http://www.example.com\",\n \"incrementType\": \"IPC\",\n \"languages\": [\n \"ES\"\n ],\n \"currencies\": [\n \"COP\"\n ],\n \"document\": {\n \"type\": \"NIT\",\n \"number\": \"123456123\"\n },\n \"address\": {\n \"street\": \"Direccion del customer\",\n \"city\": \"Medellin\",\n \"state\": 1,\n \"country\": \"CO\",\n \"postalCode\": \"050031\",\n \"phone\": \"3111111111\"\n },\n \"legalRepresentative\": {\n \"name\": \"legal representative name\",\n \"surname\": \"legal representative surname\"\n },\n \"billing\": {\n \"contact\": \"billing contact name\",\n \"mail\": \"user_email@example.com\",\n \"registrationNumber\": \"123456789\",\n \"taxType\": 5,\n \"taxRegime\": 2,\n \"organizationType\": 1,\n \"ciiu\": \"1224\"\n },\n \"travelAgency\": {\n \"dispersion\": true,\n \"iata\": \"123456\"\n },\n \"control\": {\n \"seller\": 1,\n \"reseller\": 1,\n \"paymentFacilitator\": 1\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/update", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "update" ] }, "description": "Este servicio permite actualizar los datos de un comercio existente. Si el proceso es exitoso, se retorna el identificador del comercio y su estado de activación.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"data\": {\n \"name\": \"Merchant update name\",\n \"brand\": \"Merchant update brand\",\n \"mcc\": \"0763\",\n \"active\": false,\n \"timezone\": \"America/Costa_Rica\",\n \"size\": \"M\",\n \"document\": {\n \"type\": \"NIT\",\n \"number\": \"32145632\"\n },\n \"incrementType\": \"SMLMV\",\n \"languages\": [\n \"EN\"\n ],\n \"currencies\": [\n \"USD\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de comercios", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/search", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "search" ] }, "description": "Este servicio permite consultar comercios existentes filtrando por medio de los parámetros: identificador, nombre, marca y estado del comercio.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"name\": \"Merchant name\",\n \"brand\": \"Merchant brand\",\n \"active\": true,\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/delete", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "delete" ] }, "description": "Este servicio permite eliminar un comercio existente. Si la respuesta es exitosa, retorna el identificador del comercio eliminado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Creación de un documento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/document/create", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "document", "create" ] }, "description": "Este servicio permite crear un documento para un comercio. Si el proceso es exitoso, se retorna el identificador del documento y su estado." } }, { "name": "Editar un documento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/document/update", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "document", "update" ] }, "description": "Este servicio permite actualizar los datos de un documento existente. Si el proceso es exitoso, se retorna el identificador del documento y su estado de activación. No es posible editar el archivo o el comercio vinculado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"data\": {\n \"documentName\": \"My document name\",\n \"documentDescription\": \"My document description\",\n \"documentType\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de documentos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/document/search", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "document", "search" ] }, "description": "Este servicio permite consultar documentos existentes filtrando por medio de los parámetros: identificador del comercio o del sitio, nombre, descripción e identificador del tipo de documento.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"documentName\": \"name\",\n \"documentDescription\": \"description\",\n \"documentType\": 1,\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar un documento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/document/delete", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "document", "delete" ] }, "description": "Este servicio permite eliminar un documento existente. Si la respuesta es exitosa, retorna el identificador del documento eliminado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Descarga del archivo de un documento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/document/download", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "document", "download" ] }, "description": "Este servicio permite descargar el archivo de un documento existente. Si la respuesta es exitosa, retorna el archivo vinculado al documento.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Agregar un método de pago a un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/payment-methods/create", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "payment-methods", "create" ] }, "description": "Este servicio permite agregar un método de pago existente al comercio. Si la respuesta es exitosa, retorna el identificador del método de pago agregado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"data\": {\n \"customerId\": 1,\n \"code\": \"RM_MC\",\n \"commissionModel\": \"P\",\n \"commissionValue\": 1,\n \"accountType\": 1,\n \"accountNumber\": \"1234567890\",\n \"financialEntity\": 2,\n \"order\": 1,\n \"settings\": {\n \"username\": \"username\",\n \"terminalLocation\": \"Medellin\",\n \"serviceCode\": \"123456\",\n \"isEcommerce\": true,\n \"3DSVersion\": \"v2\",\n \"3DSApiKey\": \"468232\",\n \"selection_rules\": {\n \"strict\": false,\n \"bin\": {\n \"policy\": \"denies\",\n \"collection\": [\n \"511111\"\n ]\n }\n }\n },\n \"creditRules\": {\n \"RM_MC\": {\n \"C\": {\n \"1\": {\n \"minimum\": \"1\"\n },\n \"2\": {\n \"remove\": true\n },\n \"3\": {\n \"maximum\": \"10\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Actualizar un método de pago asociado a un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/payment-methods/update", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "payment-methods", "update" ] }, "description": "Este servicio permite actualizar un médio de pago asociado a un comercio. Si la respuesta es exitosa, retorna el identificador del medio de pago.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"data\": {\n \"commissionModel\": \"P\",\n \"commissionValue\": 0,\n \"accountType\": 1,\n \"accountNumber\": \"1234567890\",\n \"financialEntity\": 2,\n \"order\": 1,\n \"settings\": {\n \"username\": \"username\",\n \"terminalLocation\": \"Medellin\",\n \"serviceCode\": \"123456\",\n \"isEcommerce\": true,\n \"3DSVersion\": \"v2\",\n \"3DSApiKey\": \"468232\",\n \"selection_rules\": {\n \"strict\": false,\n \"bin\": {\n \"policy\": \"denies\",\n \"collection\": [\n \"511111\"\n ]\n }\n }\n },\n \"creditRules\": null\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remover un método de pago asociado a un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/payment-methods/delete", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "payment-methods", "delete" ] }, "description": "Este servicio permite remover un método de pago de un comercio. Si el proceso es exitoso, se retorna el identificador del medio de pago.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de métodos de pago de un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/payment-methods/search", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "payment-methods", "search" ] }, "description": "Este servicio permite consultar los médios de págo asociados a un comercio. \nEs posible emplear filtrado por medio de los parámetros: \"id\", \"name\", \"code\" y \"franchise\".\n\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"customerId\": 1,\n \"id\": 100,\n \"name\": \"masterCard\",\n \"code\": \"RM_MC\",\n \"franchise\": \"MASTERCARD\",\n \"pagination\": {\n \"perPage\": 10,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Crear un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/create", "host": [ "{{base_url}}" ], "path": [ "core", "site", "create" ] }, "description": "Este servicio permite crear un sitio con la información suministrada. Si la respuesta es exitosa, retorna el identificador, estado, login y llave transaccional del sitio.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"data\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"md5Hash\": \"e0xy799SGB3zj689\",\n \"name\": \"Site name\",\n \"displayName\": \"site display name\",\n \"customerId\": 1,\n \"type\": \"INT\",\n \"category\": \"ECOMMERCE\",\n \"email\": \"test@test.com\",\n \"currency\": \"COP\",\n \"language\": \"ES\",\n \"active\": true,\n \"customBatch\": 1235665,\n \" expiration\": \"2019-08-24T14:15:22Z\",\n \"onTest\": true,\n \"integration\": {\n \"allowPartial\": true,\n \"allowWallet\": true,\n \"checkoutAttemptsLimit\": null,\n \"connectionMethod\": \"REDIRECT\",\n \"notificationUrl\": \"www.urlexample.com\",\n \"checkoutVersion\": \"v4\",\n \"analyticsCode\": \"string\"\n },\n \"control\": {\n \"minAmount\": 0,\n \"maxAmount\": 100000000,\n \"allowedDays\": 127,\n \"allowedHours\": \"ffffffffffffffffffffffffffffffffffffffffff\",\n \"filterPse\": false,\n \"filterTuya\": false,\n \"filterSafetypay\": false,\n \"prechargeFilter\": 0,\n \"allowedBankCountries\": [\n \"CO\"\n ],\n \"filterByBin\": false,\n \"exceptionBinsList\": [\n 411111,\n 123456\n ],\n \"delegatedAuthorization\": \"ffffffffffffffffffffffffffffffffffffffffff\"\n },\n \"threeDS\": {\n \"setting\": \"VERY_LOW\",\n \"minAmount\": 0\n },\n \"historic\": {\n \"behaviour\": \"IGNORE\",\n \"lowerScore\": null,\n \"rejectionScore\": null\n },\n \"creditBureau\": {\n \"behaviours\": {\n \"onFailed\": \"REJECTED\",\n \"onNoMatch\": \"REJECTED\",\n \"onMatch\": \"PROCESS\"\n },\n \"paymentGroups\": [\n \"CASH\"\n ],\n \"minAmount\": 10\n },\n \"riskEngine\": {\n \"behaviours\": {\n \"onFailed\": \"REJECTED\",\n \"onLowRisk\": \"MANUAL\",\n \"onMediumRisk\": \"REJECTED\",\n \"onHighRisk\": \"REJECTED\"\n },\n \"paymentGroups\": [\n \"CASH\"\n ],\n \"minAmount\": 20,\n \"approvalScore\": 100,\n \"rejectionScore\": 250,\n \"onCalibration\": true\n },\n \"securityFilters\": {\n \"filterLockedByTries\": true,\n \"allowedIssuerCountries\": [\n \"CO\"\n ],\n \"forceIPMatch\": true,\n \"excludeIPCountry\": [\n \"CO\"\n ],\n \"onlyWhitelisted\": true,\n \"allowedIPCountries\": [\n \"CO\"\n ],\n \"allowedCardsDay\": 2,\n \"allowedCardsByIP\": 30,\n \"allowedCardsMonth\": 2,\n \"allowedCardsYear\": 5,\n \"dayMax\": 2,\n \"dayMaxAmount\": 100000000,\n \"monthMax\": 5,\n \"monthMaxAmount\": 100000000\n },\n \"operation\": {\n \"disableTax\": true,\n \"calculateTax\": true,\n \"taxPercentage\": 0,\n \"patternReference\": \"string\",\n \"mailCustomer\": true,\n \"mailMerchant\": true\n },\n \"subscriptionValidation\": {\n \"enable\": true,\n \"amount\": 0\n },\n \"branding\": {\n \"buttonColor\": \"#cc3fdd\",\n \"sidebarColor\": \"#ffebeb\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Actualizar un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/update-all", "host": [ "{{base_url}}" ], "path": [ "core", "site", "update-all" ] }, "description": "Este servicio permite actualizar un sitio con la información suministrada. Si la respuesta es exitosa, retorna el identificador del sitio y su estado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 15,\n \"data\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"md5Hash\": \"e0xy799SGB3zj689\",\n \"name\": \"Updated name\",\n \"displayName\": \"Update display name\",\n \"type\": \"INT\",\n \"category\": \"ECOMMERCE\",\n \"email\": \"test@test.com\",\n \"currency\": \"COP\",\n \"language\": \"ES\",\n \"active\": true,\n \"customBatch\": 1235665,\n \" expiration\": \"2019-08-24T14:15:22Z\",\n \"onTest\": true,\n \"productionDate\": \"2024-02-02\",\n \"integration\": {\n \"allowPartial\": true,\n \"allowWallet\": true,\n \"checkoutAttemptsLimit\": null,\n \"connectionMethod\": \"REDIRECT\",\n \"notificationUrl\": \"www.urlexample.com\",\n \"checkoutVersion\": \"v4\",\n \"analyticsCode\": \"string\",\n \"sourceRestriction\": \"ivr\"\n },\n \"control\": {\n \"minAmount\": 9999999.99,\n \"maxAmount\": 0,\n \"allowedDays\": 127,\n \"allowedHours\": \"ffffffffffffffffffffffffffffffffffffffffff\",\n \"filterPse\": false,\n \"filterTuya\": false,\n \"filterSafetypay\": false,\n \"prechargeFilter\": 0,\n \"allowedBankCountries\": [\n \"CO\"\n ],\n \"filterByBin\": false,\n \"exceptionBinsList\": [\n 411111\n ],\n \"delegatedAuthorization\": \"ffffffffffffffffffffffffffffffffffffffffff\"\n },\n \"securityFilters\": {\n \"filterLockedByTries\": true\n },\n \"branding\": {\n \"buttonColor\": \"#cc3fdd\",\n \"sidebarColor\": \"#ffebeb\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Actualizar branding de un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/update", "host": [ "{{base_url}}" ], "path": [ "core", "site", "update" ] }, "description": "Este servicio permite actualizar el branding y la versión de checkout de un sitio con la información suministrada. Si la respuesta es exitosa, retorna los datos del sitio", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 15,\n \"branding\": {\n \"buttonColor\": \"#000000\",\n \"sidebarColor\": \"#ffebeb\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Actualizar logo del sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/logo-update", "host": [ "{{base_url}}" ], "path": [ "core", "site", "logo-update" ] }, "description": "Este servicio permite actualizar el logo de un sitio, \nya sea subiendo uno nuevo, reemplazando uno existente, \nsi el parámetro \"file\" es nulo se elimina el logo actual" } }, { "name": "Eliminar un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/delete", "host": [ "{{base_url}}" ], "path": [ "core", "site", "delete" ] }, "description": "Este servicio permite eliminar un sitio. Si la respuesta es exitosa, retorna el identificador del sitio eliminado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 15\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de sitios", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/search", "host": [ "{{base_url}}" ], "path": [ "core", "site", "search" ] }, "description": "Este servicio permite consultar sitios existentes filtrando por medio de los parámetros: identificador del sitio, identificador del comercio, nombre, nombre a mostrar, indicador de estado en pruebas y estado del sitio.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"customerId\": 1,\n \"id\": 15,\n \"name\": \"name\",\n \"displayName\": \"dispĺayName\",\n \"onTest\": true,\n \"active\": true,\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Agregar un medio de pago a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/payment-methods/create", "host": [ "{{base_url}}" ], "path": [ "core", "site", "payment-methods", "create" ] }, "description": "Este servicio permite agregar un medio de pago existente a un sitio. Si el proceso el exitoso, se retorna el identificador del medio de pago asociado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"data\": {\n \"siteId\": 1,\n \"customerPaymentId\": 1,\n \"order\": 1,\n \"minAmount\": 1,\n \"maxAmount\": 99999999.99,\n \"accountType\": 1,\n \"accountNumber\": \"123456789900\",\n \"financialEntity\": 1,\n \"commissionModel\": \"P\",\n \"commissionValue\": 1,\n \"settings\": {\n \"merchantCode\": \"123456\",\n \"MID\": \"000468232\",\n \"RUC\": \"1234567890147\",\n \"terminalNumber\": \"01234567\",\n \"aggregatorModel\": false,\n \"selection_rules\": {\n \"strict\": false,\n \"bin\": {\n \"policy\": \"denies\",\n \"collection\": [\n \"511111\"\n ]\n }\n }\n },\n \"creditRules\": {\n \"RM_MC\": {\n \"C\": {\n \"1\": {\n \"minimum\": \"1\"\n },\n \"2\": {\n \"remove\": true\n },\n \"3\": {\n \"maximum\": \"10\"\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Actualizar un medio de pago asociado a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/payment-methods/update", "host": [ "{{base_url}}" ], "path": [ "core", "site", "payment-methods", "update" ] }, "description": "Este servicio permite actualizar un medio de pago asociado a un sitio. Si el proceso el exitoso, se retorna el identificador del medio de pago actualizado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"data\": {\n \"order\": 1,\n \"minAmount\": 1,\n \"maxAmount\": 99999999.99,\n \"accountType\": 1,\n \"accountNumber\": \"123456789900\",\n \"financialEntity\": 1,\n \"commissionModel\": \"P\",\n \"commissionValue\": 1,\n \"settings\": {\n \"merchantCode\": \"123456\",\n \"MID\": \"000468232\",\n \"RUC\": \"1234567890147\",\n \"terminalNumber\": \"01234567\",\n \"aggregatorModel\": false,\n \"selection_rules\": {\n \"strict\": false,\n \"bin\": {\n \"policy\": \"denies\",\n \"collection\": [\n \"511111\"\n ]\n }\n }\n },\n \"creditRules\": null\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remover un medio de pago asociado a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/payment-methods/delete", "host": [ "{{base_url}}" ], "path": [ "core", "site", "payment-methods", "delete" ] }, "description": "Este servicio permite remover un medio de pago asociado a un sitio. Si el proceso el exitoso, se retorna el identificador del medio de pago eliminado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de medios de pago asociados a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/payment-methods/search", "host": [ "{{base_url}}" ], "path": [ "core", "site", "payment-methods", "search" ] }, "description": "Este servicio permite consultar los médios de págo asociados a un sitio. \nEs posible filtrar los resultados por medio de los parámetros: \"id\", \"name\", \"code\" y \"franchise\".\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"siteId\": 1,\n \"id\": 1,\n \"name\": \"payment method name\",\n \"code\": \"ID_VS\",\n \"franchise\": \"VISA\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Crear una lista de preferidos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/prefer-list/create", "host": [ "{{base_url}}" ], "path": [ "core", "site", "prefer-list", "create" ] }, "description": "Este servicio permite crear una lista de preferidos y asociarla a un sitio existente. Si la respuesta es exitosa, retorna el identificador de la lista.\n\n> ### Nota \n>\n> *Para crear correctamente la lista de preferidos es necesario ingresar junto a los campos requeridos, por lo menos uno de los siguientes campos: card.Number, ipAddresses o person.document.*\n\n> *En el objeto Person, es requerido enviar el campo email. Los campos name, surname, company, address y mobile no son necesarios al enviar la solicitud.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"data\": {\n \"siteId\": 1,\n \"person\": {\n \"documentType\": \"CC\",\n \"Document\": \"1234567894\",\n \"email\": \"test@test.com\"\n },\n \"card\": {\n \"number\": 4111111111111111\n },\n \"ipAddresses\": [\n \"120.120.120.1\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Actualizar una lista de preferidos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/prefer-list/update", "host": [ "{{base_url}}" ], "path": [ "core", "site", "prefer-list", "update" ] }, "description": "Este servicio permite actualizar una lista de preferidos asociada a un sitio. Si la respuesta es exitosa, retorna el identificador de la lista.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"data\": {\n \"person\": {\n \"documentType\": \"CC\",\n \"Document\": \"987654321\",\n \"email\": \"tst@test.com\"\n },\n \"card\": {\n \"number\": 4111111111111111\n },\n \"ipAddresses\": [\n \"120.120.120.1\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar una lista de preferidos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/prefer-list/delete", "host": [ "{{base_url}}" ], "path": [ "core", "site", "prefer-list", "delete" ] }, "description": "Este servicio permite eliminar una lista de preferidos asociada a un sitio. Si la respuesta es exitosa, retorna el identificador de la lista eliminada.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de lista de preferidos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/prefer-list/search", "host": [ "{{base_url}}" ], "path": [ "core", "site", "prefer-list", "search" ] }, "description": "Este servicio permite consultar listas de preferidos existente filtrando por medio de los parámetros: siteId, id, cardDisplay, email, document e ipAddresses.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la busqueda.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"siteId\": 1,\n \"email\": \"email@test.com\",\n \"document\": \"CC 1236548123\",\n \"ipAddresses\": [\n \"120.120.120.1\"\n ],\n \"cardDisplay\": 4123123123111111,\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de tipos de documentos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/document-type/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "document-type", "search" ] }, "description": "Este servicio permite consultar los tipos de documentos existentes.\nSi la respuesta es exitosa, se retorna un arreglo de los tipos de regimenes con su información. Se puede filtrar por medio de los parámetros: nombre y código del tipo de documento.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"name\": \"string\",\n \"code\": \"string\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de departamentos o estados por país", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/province/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "province", "search" ] }, "description": "Este servicio permite consultar los estados /departamentos de un País. \nSi la respuesta es exitosa, se retorna un arreglo de los estados con su información.\n\nPuede filtrar los resultados de la consulta empleando el parámetro 'country' como filtro.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"country\": \"EC\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de tipos de régimen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/taxpayer/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "taxpayer", "search" ] }, "description": "Este servicio permite consultar los tipos de regimen existentes.\nSi la respuesta es exitosa, se retorna un arreglo de los tipos de regimenes con su información.\n\nPuede filtrar los resultados de la consulta empleando el parámetro 'country' como filtro.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"country\": \"CO\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de regímenes fiscales", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/tax-regime/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "tax-regime", "search" ] }, "description": "Este servicio permite consultar regímenes físcales existentes.\nSi la respuesta es exitosa, se retorna un arreglo de regímenes con su información.\n\nPuede filtrar los resultados de la consulta empleando el parámetro 'country' como filtro.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"country\": \"CO\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de tipos de corporación", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/corporation-type/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "corporation-type", "search" ] }, "description": "Este servicio permite consultar regímenes físcales existentes.\nSi la respuesta es exitosa, se retorna un arreglo de regímenes con su información.\n\nPuede filtrar los resultados de la consulta empleando el parámetro 'country' como filtro.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"country\": \"EC\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Busqueda de consultores comerciales de Placetopay.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/seller/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "seller", "search" ] }, "description": "Este servicio permite buscar consultores comerciales habilitados.\nSi la respuesta es exitosa, se retorna un arreglo con información de cada consultor.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de facilitadores de pago", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/payment-facilitator/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "payment-facilitator", "search" ] }, "description": "Este servicio permite buscar los facilitadores de pago registrados en el sistema.\n\nSi la respuesta es exitosa, se retorna un arreglo con la información de cada facilitador de pago.\n\nPuede filtrar los resultados de la consulta empleando el parámetro 'id', 'name' y 'active' como filtro, segun lo requiera.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"name\": \"Kyle Walker\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de banco adquiriente", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/reseller/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "reseller", "search" ] }, "description": "Este servicio permite consultar distribuidores habilitados.\nSi la respuesta es exitosa, se retorna un arreglo con información de cada distribuidor.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de tipos de cuenta de recaudo.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/account-type/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "account-type", "search" ] }, "description": "Este servicio permite consultar los tipos de cuenta de recaudo.\nSi la respuesta es exitosa, se retorna un arreglo de tipos de cuenta de recaudo con su información correspondiente.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de entidades financieras.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/financial-entity/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "financial-entity", "search" ] }, "description": "Este servicio permite consultar entidades financiera o banco recaudador.\nSi la respuesta es exitosa, se retorna un arreglo con información de cada entidad financiera.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de medios de pago.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/payment-method/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "payment-method", "search" ] }, "description": "Este servicio permite consultar medios de pago habilitados.\nSi la respuesta es exitosa, se retorna un arreglo con información de cada medio de pago.\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination'.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de grupos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/group/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "group", "search" ] }, "description": "Este servicio permite consultar los grupos existentes.\nSi la respuesta es exitosa, se retorna un arreglo con el identificador, nombre y descripción del grupo. Se puede filtrar por medio de los parámetros: identificador y código del grupo.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"code\": \"GROUP_ROOT\",\n \"name\": \"Superusuario\",\n \"description\": \"Usuario con todos los privilegios sobre la aplicación, incluyendo seguridad.\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de aerolíneas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/airline/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "airline", "search" ] }, "description": "Este servicio permite consultar los aerolíneas existentes.\nSi la respuesta es exitosa, se retorna un arreglo con el identificador y nombre de la aerolínea. Se puede filtrar por medio de los parámetros: identificador y nombre de la aerolínea.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"name\": \"AIR CANADA Nacional\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de filtros", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/filter/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "filter", "search" ] }, "description": "Este servicio permite consultar los filtros existentes.\nSi la respuesta es exitosa, se retorna un arreglo con el identificador y código del filtro. Se puede filtrar por medio de los parámetros: identificador y código del filtro.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"name\": \"AIR CANADA Nacional\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de conglomerados", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/conglomerate/search", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "conglomerate", "search" ] }, "description": "Este servicio permite consultar los conglomerados existentes.\nSi la respuesta es exitosa, se retorna un arreglo con el identificador y nombre del conglomerado. Se puede filtrar por medio de los parámetros: identificador y nombre del conglomerado.\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"name\": \"EGM CO\",\n \"brand\": \"EGM\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de usuarios.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/user/search", "host": [ "{{base_url}}" ], "path": [ "core", "user", "search" ] }, "description": "Este servicio permite consultar usuarios existentes filtrando por medio de los parámetros: identificador del usuario, email o usuario para acceder al sistema.\nSi la respuesta es exitosa, se retorna un arreglo con información de los usuarios. \n\n\n> ### Nota \n>\n> No es requerido ingresar todos los parámetros para el filtro.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"username\": \"testing_username\",\n \"email\": \"test@test.com\",\n \"pagination\": {\n \"perPage\": 10,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Creación de usuarios.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/user/create", "host": [ "{{base_url}}" ], "path": [ "core", "user", "create" ] }, "description": "Este servicio permite crear un usuario con la información suministrada. Si la respuesta es exitosa, se retorna el identificador del usuario creado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"fullName\": \"usuario\",\n \"username\": \"testing_username\",\n \"email\": \"test@test.com\",\n \"mobile\": \"+573111111111\",\n \"status\": \"ACTIVE\",\n \"language\": \"es\",\n \"timezone\": \"America/Bogota\",\n \"control\": {\n \"allowedIps\": [\n \"127.0.0.1\",\n \"191.103.33.21\"\n ],\n \"allowedDays\": [\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\",\n \"SATURDAY\",\n \"SUNDAY\"\n ],\n \"permissionMode\": \"INCLUDE\"\n },\n \"access\": {\n \"groups\": [\n \"GROUP_PLANS\"\n ],\n \"filters\": {\n \"client\": [\n 1,\n 2\n ],\n \"seller\": [\n 1,\n 2\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar un usuario", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/user/update", "host": [ "{{base_url}}" ], "path": [ "core", "user", "update" ] }, "description": "Este servicio permite actualizar un usuario con la información suministrada. Si la respuesta es exitosa, se retorna el identificador del usuario actualizado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"fullName\": \"usuario\",\n \"mobile\": \"+573111111111\",\n \"status\": \"ACTIVE\",\n \"language\": \"es\",\n \"timezone\": \"America/Bogota\",\n \"control\": {\n \"allowedIps\": [\n \"127.0.0.1\",\n \"191.103.33.21\"\n ],\n \"allowedDays\": [\n \"TUESDAY\",\n \"WEDNESDAY\",\n \"THURSDAY\",\n \"FRIDAY\"\n ],\n \"permissionMode\": \"INCLUDE\"\n },\n \"access\": {\n \"groups\": [\n \"GROUP_PLANS\"\n ],\n \"filters\": {\n \"client\": [\n 1,\n 2\n ],\n \"seller\": [\n 1,\n 2\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Crear un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/create", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "create" ] }, "description": "Este servicio permite crear un plan. Si la respuesta es exitosa, retorna el identificador del plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"invoiceTo\": 1,\n \"type\": \"ALL\",\n \"mode\": \"PERCENT\",\n \"frequence\": \"WEEKLY\",\n \"unbillThird\": false,\n \"aggregator\": false,\n \"validFrom\": \"2023-01-01\",\n \"validUntil\": \"2024-01-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/update", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "update" ] }, "description": "Este servicio permite editar un plan. Si la respuesta es exitosa, retorna el identificador del plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 2,\n \"type\": \"ALL\",\n \"mode\": \"PERCENT\",\n \"frequence\": \"WEEKLY\",\n \"validFrom\": \"2023-01-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de planes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/search", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "search" ] }, "description": "Este servicio permite consultar todos los planes existentes. Se puede filtrar por medio del identificador del plan. Si la respuesta es exitosa, retorna un arreglo con los planes.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"pagination\": {\n \"perPage\": 10,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/remove", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "remove" ] }, "description": "Este servicio permite eliminar un plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancelar un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/cancel", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "cancel" ] }, "description": "Este servicio permite cancelar un plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Crear un rango de plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/range/create", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "range", "create" ] }, "description": "Este servicio permite crear un rango y asociarlo a un plan existente. Si la respuesta es exitosa, retorna el identificador del rango del plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"planId\": 1,\n \"maxRange\": 123000,\n \"base\": 14760,\n \"included\": 0.12,\n \"additional\": 0.12,\n \"cifin\": 1120.5,\n \"emailage\": 1120.5,\n \"sarlaft\": 1120.5\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar un rango de plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/range/update", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "range", "update" ] }, "description": "Este servicio permite editar un rango de un plan existente. Si la respuesta es exitosa, retorna el identificador del rango del plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1,\n \"planId\": 1,\n \"maxRange\": 123000,\n \"base\": 14760,\n \"included\": 0.12,\n \"additional\": 0.12,\n \"cifin\": 1220.5,\n \"emailage\": 1220.5,\n \"sarlaft\": 1220.5\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de rangos de un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/range/search", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "range", "search" ] }, "description": "Este servicio permite consultar todos los rangos asociados a un plan existente. Si la respuesta es exitosa, retorna un arreglo con los rangos del plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"planId\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar rangos un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/range/remove", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "range", "remove" ] }, "description": "Este servicio permite eliminar rangos asociados a un plan existente.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"planId\": 1,\n \"planRanges\": [\n 1,\n 3,\n 6,\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Asociar un comercio a un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/customer/create", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "customer", "create" ] }, "description": "Este servicio permite asociar un comercio a un plan existente.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"planId\": 1,\n \"customerId\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de comercios de un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/customer/search", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "customer", "search" ] }, "description": "Este servicio permite consultar los comercios asociados a un plan existente. Si la respuesta es exitosa, retorna un arreglo con las asociaciones entre planes y comercios.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"planId\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar comercios de un plan", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/plans/customer/remove", "host": [ "{{base_url}}" ], "path": [ "core", "plans", "customer", "remove" ] }, "description": "Este servicio permite eliminar la asociación entre un comercio y un plan.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"planId\": 1,\n \"customerPlans\": [\n 1,\n 3,\n 6,\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Crear facturas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/invoice/create", "host": [ "{{base_url}}" ], "path": [ "core", "invoice", "create" ] }, "description": "Este servicio permite crear multiples facturas. Si una factura es creada con la misma referencia de una factura ya existente, la misma será sustituida si no está paga.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"site\": \"3,\",\n \"invoices\": [\n {\n \"payment\": {\n \"reference\": \"REFERENCE\",\n \"description\": \"DESCRIPTION\",\n \"amount\": {\n \"currency\": \"USD\",\n \"total\": 5\n }\n },\n \"altReference\": \"ALT_REFERENCE\",\n \"debtor\": {\n \"document\": \"1234567890\",\n \"documentType\": \"CC\"\n },\n \"expiration\": \"2026-07-25 10:14:24\",\n \"date\": \"2019-07-07\",\n \"dueDate\": \"2026-03-25 10:14:24\",\n \"secondDueDate\": \"2026-06-27 10:14:24\",\n \"serviceCode\": \"1234\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar una factura", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/invoice/remove", "host": [ "{{base_url}}" ], "path": [ "core", "invoice", "remove" ] }, "description": "Este servicio permite eliminar una factura.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"site\": 1,\n \"invoice\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Bloquear o liberar una factura", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/invoice/hold", "host": [ "{{base_url}}" ], "path": [ "core", "invoice", "hold" ] }, "description": "Este servicio permite realizar el bloqueo o la liberación de una factura.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"site\": 1,\n \"invoice\": 1,\n \"revoke\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Eliminar facturas vencidas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/invoice/flush", "host": [ "{{base_url}}" ], "path": [ "core", "invoice", "flush" ] }, "description": "Este servicio permite eliminar todas las facturas del sitio que estén expiradas y no estén pagas o bloqueadas.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"site\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Marcar facturas como pagadas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/invoice/settle", "host": [ "{{base_url}}" ], "path": [ "core", "invoice", "settle" ] }, "description": "Este servicio permite marcar una o múltiples facturas como pagadas. Esto significa que se han recibido los pagos correspondientes y las facturas se han cerrado.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"site\": 1,\n \"invoice\": 42,\n \"amount\": 200,\n \"authorization\": \"00000\",\n \"receipt\": \"12345\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de facturas.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/invoice/search", "host": [ "{{base_url}}" ], "path": [ "core", "invoice", "search" ] }, "description": "Este servicio permite consultar la información completa de las facturas.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"site\": 4,\n \"status\": [\n \"PAYED\",\n \"ACTIVE\"\n ],\n \"pagination\": {\n \"perPage\": 1,\n \"currentPage\": 2\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Agregar una integración a un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/integration/create", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "integration", "create" ] }, "description": "Este servicio permite agregar una integración al comercio. Si la respuesta es exitosa, retorna el identificador de la integración agregada." } }, { "name": "Actualizar una integración asociada a un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/integration/update", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "integration", "update" ] }, "description": "Este servicio permite actualizar una integración asociada a un comercio. Si la respuesta es exitosa, retorna el identificador de la integración." } }, { "name": "Remover una integración asociada a un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/integration/delete", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "integration", "delete" ] }, "description": "Este servicio permite remover una integración de un comercio. Si el proceso es exitoso, se retorna el identificador de la integración.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de integraciones de un comercio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/merchant/integration/search", "host": [ "{{base_url}}" ], "path": [ "core", "merchant", "integration", "search" ] }, "description": "Este servicio permite consultar las integraciones asociadas a un comercio. \nEs posible emplear filtrado por medio de los parámetros: \"id\" y \"type\".\n\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la búsqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"customerId\": 1,\n \"id\": 100,\n \"type\": \"paygate\",\n \"pagination\": {\n \"perPage\": 10,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Agregar una integración a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/integration/create", "host": [ "{{base_url}}" ], "path": [ "core", "site", "integration", "create" ] }, "description": "Este servicio permite agregar una integración al sitio. Si la respuesta es exitosa, retorna el identificador de la integración agregada." } }, { "name": "Actualizar una integración asociada a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/integration/update", "host": [ "{{base_url}}" ], "path": [ "core", "site", "integration", "update" ] }, "description": "Este servicio permite actualizar una integración asociada a un sitio. Si la respuesta es exitosa, retorna el identificador de la integración." } }, { "name": "Remover una integración asociada a un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/integration/delete", "host": [ "{{base_url}}" ], "path": [ "core", "site", "integration", "delete" ] }, "description": "Este servicio permite remover una integración de un sitio. Si el proceso es exitoso, se retorna el identificador de la integración.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de integraciones de un sitio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/site/integration/search", "host": [ "{{base_url}}" ], "path": [ "core", "site", "integration", "search" ] }, "description": "Este servicio permite consultar las integraciones asociadas a un sitio. \nEs posible emplear filtrado por medio de los parámetros: \"id\" y \"type\".\n\n\n> ### Nota \n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la búsqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"siteId\": 1,\n \"id\": 100,\n \"type\": \"paygate\",\n \"pagination\": {\n \"perPage\": 10,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resolución de llaves", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/tools/breb/credibanco/key-resolve", "host": [ "{{base_url}}" ], "path": [ "core", "tools", "breb", "credibanco", "key-resolve" ] }, "description": "Este servicio permite resolver una llave o alias registrado en el ecosistema de pagos Bre-B a través de Credibanco para obtener la información asociada del comercio y su representante legal.\nSe debe enviar el objeto `data` especificando el tipo de llave (`type`) y su correspondiente valor (`value`).\n### Tipos de llave soportados (`data.type`) * `PHONE`: Número móvil (ej. `327723334`). * `MAIL`: Correo electrónico (ej. `test@example.com`). * `IDENTIFICATION`: Documento de identidad (ej. `91234567`). * `ALPHANUMERIC`: Identificador alfanumérico (ej. `@ID123456ABC`). * `MERCHANT_CODE`: Código de comercio / NIT con dígito de verificación (ej. `900123456-1`).", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2026-09-03T12:00:00-05:00\"\n },\n \"data\": {\n \"type\": \"PHONE\",\n \"value\": \"327723334\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consulta de anuncios", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/core/ads/search", "host": [ "{{base_url}}" ], "path": [ "core", "ads", "search" ] }, "description": "Este servicio permite consultar los anuncios disponibles para el sitio. Solo se retornan anuncios activos (cuya fecha de fin sea mayor o igual a la fecha actual). Los resultados se ordenan por fecha de inicio (start_date) en orden ascendente.\n\nEs posible emplear filtrado por medio de los parámetros: \"type\".\n\n> ### Nota\n>\n> *No es requerido ingresar todos los parámetros para el filtro.*\n\nSi requiere el uso de paginación personalizada, debe enviar el parámetro 'pagination' junto a los filtros de la búsqueda.", "body": { "mode": "raw", "raw": "{\n \"auth\": {\n \"login\": \"aabbccdd1234567890aabbccdd123456\",\n \"tranKey\": \"ABC123example456trankey+789abc012def3456ABC=\",\n \"nonce\": \"NjE1MWQ4MDE5YWViMw==\",\n \"seed\": \"2021-09-27T09:41:05-05:00\"\n },\n \"pagination\": {\n \"perPage\": 10,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }