{ "info": { "_postman_id": "164dda3ad18a3c70f2c191c0258f5c6d", "name": "Core (English)", "description": "Collection automatically generated from the OpenAPI definition published in Placetopay Docs. The base_url variable is already set with the testing environment address.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://test.placetopay.com/rest" } ], "item": [ { "name": "Merchant creation", "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": "This service allows creating a merchant. If the process is successful, the merchant identifier and its status are returned.", "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": "Edit a merchant", "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": "This service allows updating the data of an existing merchant. If the process is successful, the merchant identifier and its activation status are returned.", "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": "Merchant search", "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": "This service allows querying existing merchants by filtering by the parameters: identifier, name, brand and merchant status.\n\n> ### Note \n>\n> *It is not required to enter all the parameters for the filter.*\n\nIf you require custom pagination, you must send the 'pagination' parameter along with the search filters.", "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": "Delete a merchant", "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": "This service allows deleting an existing merchant. If the response is successful, it returns the identifier of the deleted merchant.", "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": "Document creation", "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": "This service allows creating a document for a merchant. If the process is successful, the document identifier and its status are returned." } }, { "name": "Edit a document", "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": "This service allows updating the data of an existing document. If the process is successful, the document identifier and its status are returned of activation. It is not possible to edit the file or the linked merchant.", "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": "Document search", "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": "This service allows querying existing documents by filtering by the parameters: merchant or site identifier, name, description and document type identifier.\n\n> ### Note \n>\n> *No it is not required to enter all the parameters for the filter.*\n\nIf you require custom pagination, you must send the 'pagination' parameter along with the search filters.", "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": "Delete a document", "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": "This service allows deleting an existing document. If the response is successful, it returns the identifier of the deleted document.", "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": "Download of a document file", "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": "This service allows downloading the file of an existing document. If the response is successful, it returns the file linked to the document.", "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": "Add a payment method to a merchant", "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": "This service allows adding an existing payment method to the merchant. If the response is successful, it returns the identifier of the added payment method.", "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": "Update a payment method associated with a merchant", "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": "This service allows updating a payment method associated with a merchant. If the response is successful, it returns the identifier of the payment method.", "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": "Remove a payment method associated with a merchant", "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": "This service allows removing a payment method from a merchant. If the process is successful, the payment method identifier is returned.", "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": "Search of a merchant's payment methods", "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": "This service allows querying the payment methods associated with a merchant. \nIt is possible to filter by the parameters: \"id\", \"name\", \"code\" y \"franchise\".\n\n\n> ### Note \n>\n> *It is not required enter all the parameters for the filter.*\n\nIf you require custom pagination pagination, you must send the 'pagination' parameter along with the search filters.", "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": "Create a site", "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": "This service allows creating a site with the supplied information. If the response is successful, it returns the identifier, status, login and transactional key of the site.", "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 \"token\": {\n \"notificationUrl\": \"https://www.token-notification-url.com\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a site", "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": "This service allows updating a site with the supplied information. If the response is successful, it returns the site identifier and its status.", "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 \"token\": {\n \"notificationUrl\": \"https://www.token-new-notification-url.com\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a site's branding", "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": "This service allows updating the branding and checkout version of a site with the supplied information. If the response is successful, it returns the site data", "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": "Update the site logo", "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": "This service allows updating a site logo, \neither uploading a new one, replacing an existing one, \nif the \"file\" parameter is null, the current logo is removed" } }, { "name": "Delete a site", "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": "This service allows deleting a site. If the response is successful, returns the identifier of the deleted site.", "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": "Site search", "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": "This service allows querying existing sites by filtering by the parameters: site identifier, merchant identifier, name, display name, test status indicator, and site status.\n\n> ### Note \n>\n> *It is not required to enter all the parameters for the filter.*\n\nIf you require custom pagination, you must send the 'pagination' parameter along with the search filters.", "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": "Add a payment method to a site", "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": "This service allows adding an existing payment method to a site. If the process is successful, the identifier of the associated payment method is returned.", "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": "Update a payment method associated with a site", "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": "This service allows updating a payment method associated with a site. If the process is successful, the identifier of the updated payment method.", "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": "Remove a payment method associated with a site", "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": "This service allows removing a payment method associated with a site. If the process is successful, the identifier of the removed payment method is returned.", "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": "Search payment methods associated with a site", "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": "This service allows querying the payment methods associated with a site. \nIt is possible to filter the results by the parameters: \"id\", \"name\", \"code\" y \"franchise\".\n\n> ### Note \n>\n> *It is not required enter all the parameters for the filter.*\n\nIf you require custom pagination pagination, you must send the 'pagination' parameter along with the the search.", "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": "Create a preferred list", "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": "This service allows creating a preferred list and associating it with an existing site. If the response is successful, it returns the identifier of the list.\n\n> ### Note \n>\n> *To correctly create the preferred list it is necessary to enter, along with the required fields, at least one of the following fields: card.Number, ipAddresses or person.document.*\n\n> *In the Person object, the email field is required. The name, surname, company, address and mobile are not necessary when sending the request.*", "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": "Update a preferred list", "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": "This service allows updating a preferred list associated with a site. If the response is successful, it returns the list identifier.", "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": "Delete a preferred list", "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": "This service allows deleting a preferred list associated with a site. If the response is successful, it returns the list identifier 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": "Preferred list search", "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": "This service allows querying existing preferred lists filtering by the parameters: siteId, id, cardDisplay, email, document and ipAddresses.\n\nIf you require custom pagination, you must send the 'pagination' parameter along with the search filters.\n\n> ### Note \n>\n> *It is not required to enter all the parameters for the filter.*", "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": "Document type search", "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": "This service allows querying the existing document types.\nIf the response is successful, an array of the regime types with their information. You can filter by the parameters: name and code of the document type.\n\n> ### Note \n>\n> *It is not required to enter all the parameters for the filter.*", "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": "Search departments or states by country", "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": "This service allows querying the states/departments of a Country. \nIf the response is successful, an array of the states with their information.\n\nYou can filter the query results using the 'country' parameter as a filter.\n\nIf you require custom pagination, you must send the 'pagination' parameter.", "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": "Regime type search", "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": "This service allows you to search the existing regime types. If the response is successful, an array of regime types with their information is returned. You can filter the search results using the 'country' parameter as a filter. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Tax regime search", "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": "This service allows you to search existing tax regimes. If the response is successful, an array of regimes with their information is returned. You can filter the search results using the 'country' parameter as a filter. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Corporation type search", "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": "This service allows you to search existing tax regimes. If the response is successful, an array of regimes with their information is returned. You can filter the search results using the 'country' parameter as a filter. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Search for Placetopay sales consultants.", "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": "This service allows you to search for enabled business consultants. If the response is successful, an array with information for each consultant is returned. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Payment facilitator search", "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": "This service allows you to search for the payment facilitators registered in the system. If the response is successful, an array with the information of each payment facilitator is returned. You can filter the search results using the 'id', 'name' and 'active' parameters as filters, as needed. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Acquiring bank search", "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": "This service allows you to search for enabled distributors. If the response is successful, an array with information for each distributor is returned. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Collection account type search.", "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": "This service allows you to search collection account types. If the response is successful, an array of collection account types with their corresponding information is returned. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Financial entity search.", "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": "This service allows you to search financial entities or collecting banks. If the response is successful, an array with information for each financial entity is returned. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Payment method search.", "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": "This service allows you to search for enabled payment methods. If the response is successful, an array with information for each payment method is returned. If you need custom pagination, you must send the 'pagination' parameter.", "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": "Group search", "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": "This service allows querying the existing groups.\nIf response is successful, an array with the identifier, name and group description. You can filter by the parameters: identifier and group code.\n\n> ### Note \n>\n> *It is not required to enter all parameters for the filter.*", "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\": \"Superuser\",\n \"description\": \"User with all privileges over the application, including security.\",\n \"pagination\": {\n \"perPage\": 15,\n \"currentPage\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Airline search", "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": "This service allows querying the existing airlines.\nIf the response is successful, an array with the identifier and name of the airline. You can filter by the parameters: identifier and airline name.\n\n> ### Note \n>\n> *It is not required to enter all the parameters for the filter.*", "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": "Filter search", "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": "This service allows querying the existing filters.\nIf the response is successful, an array with the identifier and code of the filter. You can filter by the parameters: identifier and filter code.\n\n> ### Note \n>\n> *It is not required to enter all parameters for the filter.*", "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": "Conglomerate search", "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": "This service allows querying the existing conglomerates.\nIf the response is successful, an array with the identifier and name of the conglomerate. You can filter by the parameters: identifier and conglomerate name.\n\n> ### Note \n>\n> *It is not required to enter all the parameters for the filter.*", "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": "User search.", "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": "This service allows querying existing users by filtering by the parameters: user identifier, email or username to access the system.\nIf the response is successful, an array is returned with user information. \n\n\n> ### Note \n>\n> It is not required to enter all the parameters for the filter.", "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": "User creation.", "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": "This service allows creating a user with the supplied information. If the response is successful, the identifier of the created user is returned.", "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": "Edit a user", "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": "This service allows updating a user with the supplied. If the response is successful, the identifier of the updated user.", "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": "Create a 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": "This service allows creating a plan. If the response is successful, returns the plan identifier.", "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": "Edit a 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": "This service allows editing a plan. If the response is successful, returns the plan identifier.", "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": "Plan search", "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": "This service allows querying all existing plans. You can filter by the plan identifier. If the response is successful, returns an array with the plans.", "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": "Delete a 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": "This service allows you to delete a 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": "Cancel a 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": "This service allows you to cancel a 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": "Create a plan range", "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": "This service allows creating a range and associating it with an existing plan. If the response is successful, it returns the identifier of the plan range.", "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": "Edit a plan range", "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": "This service allows editing a range of an existing plan. If the response is successful, it returns the identifier of the plan range.", "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": "Plan range search", "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": "This service allows querying all the ranges associated with a existing plan. If the response is successful, it returns an array with the ranges of the 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": "Delete ranges from a 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": "This service allows you to delete ranges associated with an existing 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 \"planRanges\": [\n 1,\n 3,\n 6,\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Associate a merchant with a 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": "This service allows you to associate a merchant with an existing 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 \"customerId\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Plan merchant search", "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": "This service allows querying the merchants associated with a plan existing plan. If the response is successful, it returns an array with the associations between plans and merchants.", "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": "Delete merchants from a 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": "This service allows removing the association between a merchant and a 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": "Create invoices", "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": "This service allows you to create multiple invoices. If an invoice is created with the same reference as an existing invoice, it will be replaced if it is not paid.", "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": "Delete an invoice", "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": "This service allows you to delete an invoice.", "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": "Block or release an invoice", "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": "This service allows you to block or release an invoice.", "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": "Delete expired invoices", "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": "This service allows you to delete all site invoices that are expired and are not paid or blocked.", "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": "Mark invoices as paid", "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": "This service allows you to mark one or more invoices as paid. This means that the corresponding payments have been received and the invoices have been closed.", "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": "Invoice search.", "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": "This service allows you to search the complete information of the invoices.", "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": "Add an integration to a merchant", "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": "This service allows adding an integration to the merchant. If the response is successful, it returns the identifier of the added integration." } }, { "name": "Update an integration associated with a merchant", "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": "This service allows updating an integration associated with a merchant. If the response is successful, it returns the identifier of the integration." } }, { "name": "Remove an integration associated with a merchant", "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": "This service allows removing an integration from a merchant. If the process is successful, the integration identifier is returned.", "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": "Query of merchant integrations", "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": "This service allows querying the integrations associated with a merchant. \nIt is possible to filter by the parameters: \"id\" y \"type\".\n\n\n> ### Note \n>\n> *It is not required enter all the parameters for the filter.*\n\nIf you require custom pagination pagination, you must send the 'pagination' parameter along with the search filters.", "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": "Add an integration to a site", "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": "This service allows adding an integration to the site. If the response is successful, it returns the identifier of the added integration." } }, { "name": "Update an integration associated with a site", "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": "This service allows updating an integration associated with a site. If the response is successful, it returns the identifier of the integration." } }, { "name": "Remove an integration associated with a site", "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": "This service allows removing an integration from a site. If the process is successful, the integration identifier is returned.", "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": "Query of site integrations", "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": "This service allows querying the integrations associated with a site. \nIt is possible to filter by the parameters: \"id\" y \"type\".\n\n\n> ### Note \n>\n> *It is not required enter all the parameters for the filter.*\n\nIf you require custom pagination pagination, you must send the 'pagination' parameter along with the search filters.", "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": "Keys resolution", "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": "This service allows resolving a key or alias registered in the Bre-B payment ecosystem through Credibanco to obtain the associated information of the merchant and its legal representative.\nThe `data` object must be sent specifying the key type (`type`) and its corresponding value (`value`).\n### Supported key types (`data.type`) * `PHONE`: Mobile number (e.g. `327723334`). * `MAIL`: Email address (e.g. `test@example.com`). * `IDENTIFICATION`: Identity document (e.g. `91234567`). * `ALPHANUMERIC`: Alphanumeric identifier (e.g. `@ID123456ABC`). * `MERCHANT_CODE`: Merchant code / NIT with verification digit (e.g. `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": "Ads search", "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": "This service allows querying the ads available for the site. Only active ads (where end_date is greater than or equal to the current date) are returned. Results are sorted by start_date in ascending order.\n\nIt is possible to use filtering through the parameters: \"type\".\n\n> ### Note\n>\n> **It is not required to enter all the parameters for the filter.**\n\nIf custom pagination is required, send the 'pagination' parameter in the request.", "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" } } } } } ] }