{"info":{"_postman_id":"1a9638d3-b6dd-4d5c-8cfd-17e95e59aa48","name":"Eupago SOAP API","description":"<html><head></head><body><p>This guide provides information regarding our SOAP API.</p>\n<p>On the top of this page you can choose the language of the Example Requests provided for each payment method.</p>\n<p>Paths (wsdl):</p>\n<ul>\n<li>Sandbox: <a href=\"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl\">https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl</a></li>\n<li>Production: <a href=\"https://clientes.eupago.pt/clientes/api/api.php?wsdl=eupagov20.wsdl\">https://clientes.eupago.pt/clientes/api/api.php?wsdl=eupagov20.wsdl</a></li>\n</ul>\n<p>All requests use the same path.</p>\n<p>In order to authenticate in our API, your API Key is sent in each request on it's body.</p>\n<p>You may find your Eupago's API Key on your backoffice on <em>Channels</em> -&gt; <em>Channel Listing</em> menu. Please <a href=\"https://eupago.atlassian.net/servicedesk/customer/portal/2/article/224297034\">check our guide</a> if you are having trouble finding your API Key.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11252987","collectionId":"1a9638d3-b6dd-4d5c-8cfd-17e95e59aa48","publishedId":"UVXgKwTw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00aa6d"},"publishDate":"2022-06-06T10:41:09.000Z"},"item":[{"name":"Multibanco without Deadline","id":"27476e33-915b-4416-95ed-eb15abd4bab8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n    <soapenv:Header/>\r\n    <soapenv:Body>\r\n        <api:gerarReferenciaMB>\r\n            <valor>amount</valor>\r\n            <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n            <per_dup>0 to allow only 1 payment / 1 to allow multiple payments</per_dup>\r\n             <!--Params below are optional:-->\r\n            <id>example</id>\r\n            <admin_callback>https://www.eupago.pt</admin_callback>\r\n            <campos_extra>\r\n                <id>name of the field</id>\r\n                <valor>value of the field</valor>\r\n            </campos_extra>\r\n        </api:gerarReferenciaMB>\r\n    </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method is one of the two methods that allows you to create Multibanco payment references. In this method you may have references:</p>\n<ul>\n<li>without payment deadline</li>\n<li>in a specific amount</li>\n<li>which allow only 1 or more that 1 payment (<em>per_dup</em> param)</li>\n<li>with checkdigit</li>\n</ul>\n<p><strong>Maximum amount: 99999€ | Minimum Amount: 1€</strong></p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"27476e33-915b-4416-95ed-eb15abd4bab8"},{"name":"Multibanco with Deadline","id":"e69b85d1-78a0-4b73-bbfd-7f845cac9b2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n    <soapenv:Header/>\r\n    <soapenv:Body>\r\n        <api:gerarReferenciaMBDL>\r\n            <valor>amount</valor>\r\n            <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n            <data_inicio>YYYY-MM-DD</data_inicio>\r\n            <data_fim>YYYY-MM-DD</data_fim>\r\n            <per_dup>0 to allow only 1 payment / 1 to allow multiple payments</per_dup>\r\n             <!--Params below are optional:-->\r\n            <id>example</id>\r\n            <valor_minimo>minimum amount</valor_minimo>\r\n            <valor_maximo>maximum amount</valor_maximo>\r\n            <failOver>0/1</failOver>\r\n            <!--email and contacto params are only mandatory if param failOver = 1-->\r\n            <email>exemplo@exemplo.pt</email>\r\n            <contacto>phone number to send sms</contacto>\r\n        </api:gerarReferenciaMBDL>\r\n    </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method is one of the two methods that allows you to create Multibanco payment references. In this method you may have references:</p>\n<ul>\n<li>with or without payment deadline</li>\n<li>with a specific amount or payments between a interval of amounts</li>\n<li>which allow only 1 or more that 1 payment (<em>per_dup</em> param)</li>\n<li>without checkdigit</li>\n</ul>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"e69b85d1-78a0-4b73-bbfd-7f845cac9b2a"},{"name":"MB WAY","id":"3442d98a-5a41-4656-af0b-ae7aefc6bee5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n    <soapenv:Header/>\r\n    <soapenv:Body>\r\n        <api:pedidoMBW>\r\n            <valor>amount</valor>\r\n            <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n            <alias>phone number to send the request</alias>\r\n            <!--Params below are optional:-->\r\n            <id>example</id>\r\n            <descricao>additional text to show on the payment request</descricao>\r\n            <admin_callback>https://www.eupago.pt</admin_callback>\r\n            <campos_extra>\r\n                <id>name of the extra field</id>\r\n                <valor>value of the extra field</valor>\r\n            </campos_extra>\r\n            <failOver>0/1</failOver>\r\n            <!--email and contacto params are only mandatory if param failOver = 1-->\r\n            <email>example@example.pt</email>\r\n            <contacto>phone number to send sms</contacto>\r\n        </api:pedidoMBW>\r\n    </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method creates MB WAY payment requests.</p>\n<p><strong>Additional Information:</strong> MB WAY requests are only valid during 4 minutes. This time is defined by the payment provider.</p>\n<p><strong>Maximum amount: 99999€ | Minimum Amount: 0,50€</strong></p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"3442d98a-5a41-4656-af0b-ae7aefc6bee5"},{"name":"Payshop","id":"661895ce-4e3a-44ee-aa9c-a731ebfa8d75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n    <soapenv:Header/>\r\n    <soapenv:Body>\r\n        <api:gerarReferenciaPS>\r\n            <valor>amount</valor>\r\n            <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n            <!--Params below are optional-->\r\n            <id>example</id>\r\n            <admin_callback>https://www.eupago.pt</admin_callback>\r\n            <campos_extra>\r\n                <id>name of the extra field</id>\r\n                <valor>value of the extra field</valor>\r\n            </campos_extra>\r\n        </api:gerarReferenciaPS>\r\n    </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method creates Payshop payment references.</p>\n<p>These references are paid in cash on a large Portuguese network.</p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"661895ce-4e3a-44ee-aa9c-a731ebfa8d75"},{"name":"Paysafecard","id":"e18621f5-0bc5-4621-9a1d-93dd41c08908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n   <soapenv:Header/>\r\n   <soapenv:Body>\r\n      <api:pedidoPF>\r\n         <valor>amount</valor>\r\n         <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n         <id>example</id>\r\n         <!--Params below are optional-->\r\n         <admin_callback>https://www.eupago.pt</admin_callback>\r\n         <url_retorno>https://www.eupago.pt</url_retorno>\r\n         <comentario>This is a comment</comentario>\r\n      </api:pedidoPF>\r\n   </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method creates Paysafecard payment references.</p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"e18621f5-0bc5-4621-9a1d-93dd41c08908"},{"name":"Transactions Between Dates","id":"fff9cb23-a74c-4602-b4cf-12b83df6d5bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n   <soapenv:Header/>\r\n   <soapenv:Body>\r\n      <api:getTransactionsBetweenDates>\r\n         <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n         <dtHrInicio>YYYY-MM-DD hh:mm:ss</dtHrInicio>\r\n         <dtHrFim>YYYY-MM-DD hh:mm:ss</dtHrFim>\r\n      </api:getTransactionsBetweenDates>\r\n   </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method returns all transactions on your account between two dates.</p>\n<p>In case you need the information of only one day, please insert the same data on both params.</p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"fff9cb23-a74c-4602-b4cf-12b83df6d5bd"},{"name":"Transactions Between Movements Dates","id":"219f25fa-aad4-45dc-9796-c94c63114efc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n   <soapenv:Header/>\r\n   <soapenv:Body>\r\n      <api:getTransactionsBetweenMovementsDates>\r\n         <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n         <dtHrInicio>YYYY-MM-DD hh:mm:ss</dtHrInicio>\r\n         <dtHrFim>YYYY-MM-DD hh:mm:ss</dtHrFim>\r\n      </api:getTransactionsBetweenMovementsDates>\r\n   </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method returns all your account movements between two dates.</p>\n<p>In case you need the information of only one day, please insert the same data on both params.</p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"219f25fa-aad4-45dc-9796-c94c63114efc"},{"name":"Settlements","id":"6ce5e318-930f-4fce-a71b-fdec4cdce265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n   <soapenv:Header/>\r\n   <soapenv:Body>\r\n      <api:getSettlements>\r\n         <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n         <dtInicio0>YYYY-MM-DD hh:mm:ss</dtInicio>\r\n         <dtFim>YYYY-MM-DD hh:mm:ss</dtFim>\r\n      </api:getTransactionsBetweenMovementsDates>\r\n   </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method return information of all settlements of your account between two dates.</p>\n<p>In case you need the information of only one day, please insert the same data on both params.</p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"6ce5e318-930f-4fce-a71b-fdec4cdce265"},{"name":"Reference Information - Simple","id":"42e04a32-a069-4d21-a64a-0ee74ad5826d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n    <soapenv:Header/>\r\n    <soapenv:Body>\r\n        <api:informacaoReferencia>\r\n            <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n            <referencia>reference</referencia>\r\n            <!--Optional:-->\r\n            <entidade>entity</entidade>\r\n            <trid>transaction id</trid>\r\n        </api:informacaoReferencia>\r\n    </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method allows you to check the status of a reference of your account.</p>\n<p>If the reference has multiple payments the response will:</p>\n<ul>\n<li>inform you <strong>all Transactions ID (TRID)</strong> of that reference.</li>\n<li>give you <strong>detailed information of the most recent payment</strong></li>\n</ul>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"42e04a32-a069-4d21-a64a-0ee74ad5826d"},{"name":"Reference Information  - Detailed","id":"6329fe37-0b4a-4462-9123-2f5ecb23f1f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:api=\"API_Library\">\r\n   <soapenv:Header/>\r\n   <soapenv:Body>\r\n      <api:infoReferencia>\r\n         <chave>xxxx-xxxx-xxxx-xxxx-xxxx</chave>\r\n         <referencia>reference</referencia>\r\n       <!--Params below are optional-->\r\n         <entidade>entity</entidade>\r\n         <trid>transaction ID</trid>\r\n         <identificador>identifier</identificador>\r\n      </api:infoReferencia>\r\n   </soapenv:Body>\r\n</soapenv:Envelope>","options":{"raw":{"language":"xml"}}},"url":"https://sandbox.eupago.pt/clientes/api/api.php?wsdl=replica.eupagov20.wsdl","description":"<p>This method allows you to check the detailed information of a reference of your account.</p>\n<p>If the reference has multiple payments the response will return <strong>detailed information of all transactions</strong> on it.</p>\n","urlObject":{"protocol":"https","path":["clientes","api","api.php"],"host":["sandbox","eupago","pt"],"query":[{"key":"wsdl","value":"replica.eupagov20.wsdl"}],"variable":[]}},"response":[],"_postman_id":"6329fe37-0b4a-4462-9123-2f5ecb23f1f0"}]}