{ "info": { "_postman_id": "28a722d8-be41-4f15-8a72-6394530ffb61", "name": "SIBS PAYMENT GATEWAY", "description": "# **Instruções de Utilização:**\n\n**Para utilizarem devem aceder ao pedido de checkout do método de pagamento que pretendem e colocar as vossas variáveis de teste:**\n\n\n\n**No caso das Referências Multibanco, se aplicável, também devem colocar a vossa entidade de testes.**\n\n**Se pretenderem efetuar alguma modificação ao pedido conforme as vossas necessidades, podem fazer um save (CTRL + S) e irão fazer um Fork desta collection para o vosso Postman, podendo assim fazer alterações conforme necessitarem.**\n\n**Recordo no Body dos pedidos foram colocados algumas descrições, no entanto, para uma melhor implementação devem sempre referir a nossa documentação online:**\n\n[API – Documentation](https://www.docs.pay.sibs.com/portugal/sibs-gateway/integrations/api/)\n\n# Fluxos de Pagamento:\n\n**Partilhamos do fluxo expectável para a implementação de cada um dos métodos de pagamento via form:**\n\n### **Fluxo de Pagamento MBWay**\n\n1. **Checkout**\n \n2. **Compra**\n \n - Deve chamar o `getStatus` após executar o `redirectURL`.\n \n - Se o `paymentStatus` devolver **“Declined”**, a transação deve ser marcada como **Recusada**.\n \n - Se o `paymentStatus` devolver **“Pending”**, deve aguardar a **notificação via webhook**.\n \n3. **Informação Apresentada ao Cliente:**\n \n - Apresentar um temporizador ou mensagem a indicar que o cliente tem **4 minutos** para efetuar o pagamento.\n \n - Informar o cliente quando o pagamento for **concluído com sucesso** ou **recusado**.\n \n - Se o pagamento expirar e não for recebida notificação via webhook, recomendamos chamar o `getStatus` **5 minutos após a expiração**.\n \n4. **Requisitos de Integração:**\n \n - Deve acompanhar e reportar o estado da transação no seu sistema como:\n \n - **Pendente**\n \n - **Pago**\n \n - **Recusado**\n \n\n---\n\n### **Fluxo de Pagamento Multibanco**\n\n1. **Checkout**\n \n2. **Geração**\n \n - Deve chamar o `getStatus` após executar o `redirectURL`.\n \n - Se o `paymentStatus` devolver **“Declined”**, a transação deve ser marcada como **Recusada**.\n \n - Se o `paymentStatus` devolver **“Pending”**, deve aguardar a **notificação via webhook**.\n \n3. **Informação Apresentada ao Cliente:**\n \n - Apresentar os seguintes dados de pagamento (obtidos através do `getStatus`):\n \n - **Entidade**\n \n - **Referência**\n \n - **Valor**\n \n - **Data de Expiração do Pagamento**\n \n - Garantir que esta informação está acessível ao cliente via **email** ou na **área de cliente**.\n \n - Informar o cliente quando o pagamento for **concluído com sucesso** ou **expirado**.\n \n - Se o pagamento expirar e não for recebida notificação via webhook, recomendamos chamar o `getStatus` **após a data de expiração**.\n \n4. **Requisitos de Integração:**\n \n - Deve acompanhar e reportar o estado da transação no seu sistema como:\n \n - **Pendente**\n \n - **Pago**\n \n - **Recusado**\n \n\n---\n\n### **Fluxo de Pagamento com Cartão**\n\n1. **Checkout**\n \n - Deve incluir o `CustomerInfo` no pedido.\n \n2. **Compra**\n \n - Deve chamar o `getStatus` após executar o `redirectURL`.\n \n - Se o `paymentStatus` devolver **“Declined”**, a transação deve ser marcada como **Recusada**.\n \n - Se o `paymentStatus` devolver **“Success”**, a transação deve ser marcada como **Paga**.\n \n3. **Informação Apresentada ao Cliente:**\n \n - Informar o cliente quando o pagamento for **concluído com sucesso** ou **recusado**.\n \n - O estado deve ser obtido através do `paymentStatus` na resposta do `getStatus`.\n \n4. **Requisitos de Integração:**\n \n - Deve acompanhar e reportar o estado da transação no seu sistema como:\n \n - **Pago**\n \n - **Recusado**", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "8286366", "_collection_link": "https://go.postman.co/collection/37428529-28a722d8-be41-4f15-8a72-6394530ffb61?source=collection_link" }, "item": [ { "name": "MB WAY", "item": [ { "name": "Checkout MB WAY", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = pm.response.json();", "pm.globals.set(\"transactionID\", jsonData.transactionID);", "pm.globals.set(\"transactionSignature\", jsonData.transactionSignature);", "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "// Get the current date and convert to ISO format\r", "const currentDate = new Date().toISOString();\r", "// Set this ISO string\r", "pm.environment.set('currentDate', currentDate);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "// checkout expires after 10 min \n{\n \"merchant\": {\n \"terminalId\": {{terminalId}},\n \"channel\": \"web\",\n \"merchantTransactionId\": \"teste 12345\" // string to be used with any value up to a max 35\n },\n \"transaction\": {\n \"transactionTimestamp\": \"{{currentDate}}\", // date in ISO format resolved with the script\n \"description\": \"Test Onboarding\",\n \"moto\": false,\n \"paymentType\": \"PURS\", // Change to \"AUTH\" for a Authorization Request\n \"amount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n },\n \"paymentMethod\": [\n \"MBWAY\"\n ]\n }\n //Uncomment below to use this method to pre-fill the number (editable) to be used in MB WAY\n /*,\"customer\": {\n \"extendedInfo\": {\n \"key\": \"PREFILL_MBWAY_ID\",\n \"value\": \"351#912628328\"\n }\n }*/\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments", "host": [ "{{host}}" ], "path": [ "payments" ] } }, "response": [] }, { "name": "Purchase MB WAY", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "Digest {{transactionSignature}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"customerPhone\": \"351#9123456789\" // Triggers a push notification to MB WAY QLY \r\n // Uncomment below to use CallInApp\r\n //,\"inAPP\":true \r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments/{{transactionID}}/mbway-id/purchase", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "mbway-id", "purchase" ] } }, "response": [] }, { "name": "getStatus", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "url": { "raw": "{{host}}/payments/{{transactionID}}/status", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "status" ] } }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "const credentials = {\r", " terminalId: pm.collectionVariables.get(\"terminalId\"),\r", " bearer: pm.collectionVariables.get(\"Bearer\"),\r", " clientId: pm.collectionVariables.get(\"ClientID\"),\r", "};\r", "\r", "const checkCredentials = Object.keys(credentials).filter(key => !credentials[key]);\r", "if (checkCredentials.length > 0) {\r", " console.warn(\"⚠️ Invalid Credentials.\");\r", " throw new Error(\"Missing Mandatory Variables (terminalID, ClientID or Bearer).\");\r", "};\r", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Multibanco", "item": [ { "name": "Checkout REFERENCE", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = pm.response.json();", "pm.globals.set(\"transactionID\", jsonData.transactionID);", "pm.globals.set(\"transactionSignature\", jsonData.transactionSignature);", "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "// Get the current date and convert to ISO format\r", "const currentDate = new Date().toISOString();\r", "// Set this ISO string\r", "pm.environment.set('currentDate', currentDate);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "// checkout expires after 10 min \n{\n \"merchant\": {\n \"terminalId\": {{terminalId}},\n \"channel\": \"web\",\n \"merchantTransactionId\": \"teste 123\" // string to be used with any value up to a max 35\n },\n \"transaction\": {\n \"transactionTimestamp\": \"{{currentDate}}\", // date in ISO format resolved with the script\n \"description\": \"My transactions own description\",\n \"moto\": false,\n \"paymentType\": \"PURS\",\n \"amount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n },\n \"paymentMethod\": [\n \"REFERENCE\"\n ],\n \"paymentReference\": {\n \"initialDatetime\": \"2025-01-01T18:41:56.971Z\",\n \"finalDatetime\": \"2025-12-30T18:41:56.971Z\", // expire date for the reference\n // maxAmount and minAmount must have the same value\n \"maxAmount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n },\n \"minAmount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n },\n \"entity\": \"{{entity}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments", "host": [ "{{host}}" ], "path": [ "payments" ] } }, "response": [] }, { "name": "Generate Reference", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "Digest {{transactionSignature}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments/{{transactionID}}/service-reference/generate", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "service-reference", "generate" ] } }, "response": [] }, { "name": "getStatus", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "url": { "raw": "{{host}}/payments/{{transactionID}}/status", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "status" ] } }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "const credentials = {\r", " terminalId: pm.collectionVariables.get(\"terminalId\"),\r", " bearer: pm.collectionVariables.get(\"Bearer\"),\r", " clientId: pm.collectionVariables.get(\"ClientID\"),\r", " entity: pm.collectionVariables.get(\"entity\"),\r", "};\r", "\r", "const checkCredentials = Object.keys(credentials).filter(key => !credentials[key]);\r", "if (checkCredentials.length > 0) {\r", " console.warn(\"⚠️ Invalid Credentials.\");\r", " throw new Error(\"Missing Mandatory Variables (terminalID, entity, ClientID, Bearer).\");\r", "};\r", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Card", "item": [ { "name": "Checkout Card", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = pm.response.json();", "pm.globals.set(\"transactionID\", jsonData.transactionID);", "pm.globals.set(\"transactionSignature\", jsonData.transactionSignature);", "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "// Get the current date and convert to ISO format\r", "const currentDate = new Date().toISOString();\r", "// Set this ISO string\r", "pm.environment.set('currentDate', currentDate);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "// checkout expires after 10 min \n{\n \"merchant\": {\n \"terminalId\": {{terminalId}},\n \"channel\": \"web\",\n \"merchantTransactionId\": \"teste 123\" // string to be used with any value up to a max 35\n },\n \"transaction\": {\n \"transactionTimestamp\": \"{{currentDate}}\", // date in ISO format resolved with the script\n \"description\": \"Teste\",\n \"moto\": false,\n \"paymentType\": \"PURS\", // Change to \"AUTH\" for a Authorization Request\n \"amount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n },\n \"paymentMethod\": [\n \"CARD\"\n ]\n },\n // Mandatory for the payment method \"Card\" \n \"customer\": {\n \"customerInfo\": {\n \"customerName\": \"Onboarding\",\n \"customerEmail\" : \"Onboarding@teste.com\",\n \"shippingAddress\": {\n \"street1\": \"Rua 123\",\n \"street2\": \"Porta 456\",\n \"city\": \"Lisboa\",\n \"postcode\": \"1200-999\",\n \"country\": \"PT\"\n },\n \"billingAddress\": {\n \"street1\": \"First street\",\n \"street2\": \"Menef Square\",\n \"city\": \"Lisbon\",\n \"postcode\": \"1700-123\",\n \"country\": \"PT\"\n }\n }\n }\n // Uncomment below to use Tokenization\n /*,\"tokenisation\": {\n \"tokenisationRequest\": {\n \"tokeniseCard\": true // boolean to generate token or not\n },\n \"paymentTokens\": [\n {\n \"tokenType\": \"Card\",\n \"value\": \"kZQEThD8hGIdBSyvlwCql0047tdrNaj21C5DPD02\" // Token generated after the first purchase with tokenization\n }\n ]\n }\n */\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments", "host": [ "{{host}}" ], "path": [ "payments" ] } }, "response": [] }, { "name": "getStatus", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "url": { "raw": "{{host}}/payments/{{transactionID}}/status", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "status" ] } }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "const credentials = {\r", " terminalId: pm.collectionVariables.get(\"terminalId\"),\r", " bearer: pm.collectionVariables.get(\"Bearer\"),\r", " clientId: pm.collectionVariables.get(\"ClientID\"),\r", "};\r", "\r", "const checkCredentials = Object.keys(credentials).filter(key => !credentials[key]);\r", "if (checkCredentials.length > 0) {\r", " console.warn(\"⚠️ Invalid Credentials.\");\r", " throw new Error(\"Missing Mandatory Variables (terminalID, ClientID, Bearer).\");\r", "};\r", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Backoffice Operations", "item": [ { "name": "Refund", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Get the current date and convert to ISO format\r", "const currentDate = new Date().toISOString();\r", "// Set this ISO string\r", "pm.environment.set('currentDate', currentDate);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"terminalId\": {{terminalId}},\n \"channel\": \"web\",\n \"merchantTransactionId\": \"teste 123456\"\n },\n \"transaction\": {\n \"transactionTimestamp\": \"{{currentDate}}\",\n \"description\": \"Transaction short description\",\n \"amount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments/{{transactionID}}/refund", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "refund" ] } }, "response": [] }, { "name": "Capture", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Get the current date and convert to ISO format\r", "const currentDate = new Date().toISOString();\r", "// Set this ISO string\r", "pm.environment.set('currentDate', currentDate);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"terminalId\": {{terminalId}},\n \"channel\": \"web\",\n \"merchantTransactionId\": \"5351136\"\n },\n \"transaction\": {\n \"transactionTimestamp\": \"{{currentDate}}\",\n \"description\": \"Transaction short description\",\n \"amount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments/{{transactionID}}/capture", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "capture" ] } }, "response": [] }, { "name": "Cancellation", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Get the current date and convert to ISO format\r", "const currentDate = new Date().toISOString();\r", "// Set this ISO string\r", "pm.environment.set('currentDate', currentDate);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"terminalId\": {{terminalId}},\n \"channel\": \"web\",\n \"merchantTransactionId\": \"5351136\"\n },\n \"transaction\": {\n \"transactionTimestamp\": \"{{currentDate}}\",\n \"description\": \"Transaction short description\",\n \"amount\": {\n \"value\": {{amount}},\n \"currency\": \"EUR\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/payments/{{transactionID}}/cancellation", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "cancellation" ] } }, "response": [] } ] }, { "name": "getStatus", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-IBM-Client-ID", "value": "{{ClientID}}", "type": "text" } ], "url": { "raw": "{{host}}/payments/{{transactionID}}/status", "host": [ "{{host}}" ], "path": [ "payments", "{{transactionID}}", "status" ] } }, "response": [] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{Bearer}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "terminalId", "value": "" }, { "key": "host", "value": "https://api.qly.sibspayments.com/sibs/spg/v2" }, { "key": "amount", "value": "2" }, { "key": "entity", "value": "" }, { "key": "Bearer", "value": "", "type": "string" }, { "key": "ClientID", "value": "", "type": "string" } ] }