Make a Donation

{ "openapi": "3.0.0", "servers": [ { "url": "/api/v2/EuPago-SOAP-API", "description": "" } ], "components": { "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "basic" }, "BearerAuth": { "type": "http", "scheme": "bearer" }, "ApiKeyQuery": { "type": "apiKey", "in": "query", "name": "api_key" }, "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-DreamFactory-API-Key" }, "SessionTokenQuery": { "type": "apiKey", "in": "query", "name": "session_token" }, "SessionTokenHeader": { "type": "apiKey", "in": "header", "name": "X-DreamFactory-Session-Token" } }, "responses": { "Success": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Success" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Success" } } } }, "Error": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ResourceList": { "description": "Resource List Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ResourceList" } } } }, "SoapResponse": { "description": "SOAP Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SoapResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SoapResponse" } } } }, "autorizacaoDDResponse": { "description": "autorizacaoDDResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/autorizacaoDDResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/autorizacaoDDResponse" } } } }, "criarContaResponse": { "description": "criarContaResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarContaResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/criarContaResponse" } } } }, "criarTrancheResponse": { "description": "criarTrancheResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarTrancheResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/criarTrancheResponse" } } } }, "devolucaoMBWResponse": { "description": "devolucaoMBWResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/devolucaoMBWResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/devolucaoMBWResponse" } } } }, "gerarReferenciaMBResponse": { "description": "gerarReferenciaMBResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMBResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMBResponse" } } } }, "gerarReferenciaMBDLResponse": { "description": "gerarReferenciaMBDLResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMBDLResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMBDLResponse" } } } }, "gerarReferenciaPSResponse": { "description": "gerarReferenciaPSResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaPSResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaPSResponse" } } } }, "gerarReferenciaTrancheResponse": { "description": "gerarReferenciaTrancheResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaTrancheResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaTrancheResponse" } } } }, "informacaoMandatoADDResponse": { "description": "informacaoMandatoADDResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/informacaoMandatoADDResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/informacaoMandatoADDResponse" } } } }, "informacaoReferenciaResponse": { "description": "informacaoReferenciaResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/informacaoReferenciaResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/informacaoReferenciaResponse" } } } }, "pagamentoCCResponse": { "description": "pagamentoCCResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pagamentoCCResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pagamentoCCResponse" } } } }, "pagamentoCC_tdsResponse": { "description": "pagamentoCC_tdsResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pagamentoCC_tdsResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pagamentoCC_tdsResponse" } } } }, "pedidoCCResponse": { "description": "pedidoCCResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoCCResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoCCResponse" } } } }, "pedidoDDResponse": { "description": "pedidoDDResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoDDResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoDDResponse" } } } }, "pedidoMBWResponse": { "description": "pedidoMBWResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoMBWResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoMBWResponse" } } } }, "pedidoPFResponse": { "description": "pedidoPFResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoPFResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoPFResponse" } } } }, "pedidoPSCResponse": { "description": "pedidoPSCResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoPSCResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoPSCResponse" } } } }, "validaCCResponse": { "description": "validaCCResponse Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validaCCResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/validaCCResponse" } } } } }, "schemas": { "Success": { "type": "object", "properties": { "success": { "type": "boolean", "description": "True when API call was successful, false or error otherwise." } } }, "Error": { "type": "object", "properties": { "code": { "type": "int", "format": "", "description": "Error code." }, "message": { "type": "string", "description": "String description of the error." } } }, "ResourceList": { "type": "object", "properties": { "resource": { "type": "array", "description": "Array of accessible resources available to this service.", "items": { "type": "string" } } } }, "SoapResponse": { "type": "object", "properties": { "resource": { "type": "array", "description": "Array of system records.", "items": { "$ref": "#/components/schemas/SoapMethods" } } } }, "SoapMethods": { "type": "object", "properties": { "name": { "type": "string", "description": "A URL to the target host." }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL." }, "requestType": { "type": "string", "description": "An optional string describing the host designated by the URL." }, "requestFields": { "type": "object", "description": "An optional string describing the host designated by the URL." }, "responseType": { "type": "string", "description": "An optional string describing the host designated by the URL." }, "responseFields": { "type": "object", "description": "An optional string describing the host designated by the URL." }, "access": { "type": "array", "items": { "type": "string" }, "description": "An array of verbs allowed." } } }, "valor": { "type": "float", "description": "The amount of the Multibanco reference" }, "valor_mbw": { "type": "float", "format": "", "description": "The amount of the MB Way reference" }, "valor_pq": { "type": "float", "format": "", "description": "The amount of the Pagaqui reference" }, "valor_ps": { "type": "number", "format": "", "description": "The amount of the Payshop reference" }, "valor_cc": { "type": "float", "format": "", "description": "Amount to pay" }, "valor_maximo": { "type": "float", "description": "Maximum Amount to pay the reference" }, "valor_minimo": { "type": "float", "description": "Minimum Amount to pay the reference" }, "value": { "type": "number", "format": "float", "description": "float" }, "chave": { "type": "string", "format": "", "description": "API Channel’s Key (given by euPago)." }, "admin_callback": { "type": "string", "format": "", "description": "Field to report payment when successfully made to a specific URL." }, "alias": { "type": "string", "format": "", "description": "Associated phone number in MB Way." }, "comentario": { "type": "string", "format": "", "description": "Extra information that will be displayed on the payment form." }, "cripto": { "type": "string", "format": "string", "description": "Card validation number (CVV)." }, "data_inicio_mbr": { "type": "string", "format": "string", "description": "Initial date to pay the reference." }, "data_fim_mbr": { "type": "string", "format": "string", "description": "Deadline to pay the reference." }, "data_inicio_mbb": { "type": "string", "format": "string", "description": "Initial date to pay the batch." }, "data_fim_mbb": { "type": "string", "format": "string", "description": "Deadline to pay the batch." }, "id": { "type": "string", "format": "", "description": "Unique identifier of an order created by the user." }, "per_dup": { "type": "int", "description": "0 - Several payments for the same reference not allowed; 1 - Allows several payments to the same reference." }, "testa_pagamento": { "type": "int", "description": "Field to mark the ATM reference as paid (only for testing purposes)." }, "token": { "type": "string", "format": "", "description": "Token generated by Multibanco to validate the transaction." }, "trid": { "type": "string", "format": "string", "description": "Multibanco transaction identifier." }, "url_retorno": { "type": "string", "format": "", "description": "URL to which the customer must be redirected after completing the payment." }, "PedidoDevolucao": { "type": "object", "properties": { "chave": { "$ref": "#/components/schemas/chave" }, "trid": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "iban": { "type": "string", "description": "string" }, "motivo": { "type": "string", "description": "string" }, "valor": { "type": "number", "format": "double", "description": "double" } } }, "PedidoDevolucaoResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "pdmid": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "trid": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "valor": { "type": "number", "format": "double", "description": "double" }, "estado": { "type": "int", "description": "API response code" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state" } } }, "autorizacaoDD": { "type": "object", "properties": { "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "devedor": { "$ref": "#/components/schemas/devedor" }, "pagamento": { "$ref": "#/components/schemas/pagamento" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" } } }, "autorizacaoDDResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "mandato": { "type": "string", "description": "Mandate identifier" }, "valor": { "type": "string", "description": "Direct Debit payment value" }, "estado": { "type": "int", "format": "", "description": "API response Code on the action performed" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state" } } }, "campos_extra": { "type": "object", "description": "Additional information to associate the extra fields", "properties": { "id": { "type": "number", "format": "int32", "description": "Field identification number" }, "valor": { "type": "string", "description": "Field value" } } }, "criarConta": { "type": "object", "properties": { "nome_empresa": { "type": "string", "description": "string" }, "nome_responsavel": { "type": "string", "description": "string" }, "designacao": { "type": "string", "description": "string" }, "nif": { "type": "string", "description": "string" }, "nib": { "type": "string", "description": "string" }, "iban": { "type": "string", "description": "string" }, "email": { "type": "string", "description": "string" }, "morada": { "type": "string", "description": "string" }, "localidade": { "type": "string", "description": "string" }, "cod_postal": { "type": "string", "description": "string" }, "pais": { "type": "string", "description": "string" }, "chave_api_parceiro": { "type": "string", "description": "string" }, "site_id_afiliado": { "type": "string", "description": "string" } } }, "criarContaResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "chave_api": { "type": "string", "description": "string" }, "estado": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "resposta": { "type": "string", "description": "string" } } }, "criarTranche": { "type": "object", "properties": { "chave": { "$ref": "#/components/schemas/chave" }, "entidade": { "type": "string", "description": "string" }, "quantidade": { "type": "string", "description": "string" }, "data_inicio": { "type": "string", "description": "string" }, "data_fim": { "type": "string", "description": "string" } } }, "criarTrancheResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "tranche_id": { "type": "number", "format": "float", "description": "float" }, "entidade": { "type": "number", "format": "float", "description": "float" }, "quantidade": { "type": "number", "format": "float", "description": "float" }, "data_inicio": { "type": "string", "description": "string" }, "data_fim": { "type": "string", "description": "string" }, "id_ref_inicial": { "type": "number", "format": "float", "description": "float" }, "id_ref_final": { "type": "number", "format": "float", "description": "float" }, "estado": { "type": "number", "format": "float", "description": "float" }, "resposta": { "type": "string", "description": "string" } } }, "devedor": { "type": "object", "properties": { "nome": { "type": "string", "description": "Debtor’s name" }, "email": { "type": "string", "description": "Debtor’s email" }, "morada": { "type": "string", "description": "Debtor’s address" }, "cod_postal": { "type": "string", "description": "Debtor’s ZIP code" }, "cidade": { "type": "string", "description": "Debtor’s City" }, "pais": { "type": "string", "description": "Debtor’s Country" }, "iban": { "type": "string", "description": "Debtor’s IBAN" }, "swift": { "type": "string", "description": "Debtor’s SWIFT" } } }, "devolucaoMBW": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor_mbw" }, "chave": { "type": "string", "$ref": "#/components/schemas/chave" }, "trid": { "type": "string", "description": "MBWay request transaction identifier" }, "alias": { "$ref": "#/components/schemas/alias" }, "motivo": { "type": "string", "description": "Reason why the refund is being processed" } } }, "devolucaoMBWResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "referencia": { "type": "string", "description": "Reference generated for MB Way payment" }, "valor": { "type": "float", "format": "", "description": "The amount of the MB Way reference." }, "trid": { "type": "string", "description": "MBWay request transaction identifier" }, "devolucao_id": { "description": "any type" }, "estado": { "type": "int", "description": "API response code" }, "resposta": { "type": "string", "description": "Descriptive message explaining the state parameter number code" } } }, "gerarReferenciaMB": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "token": { "$ref": "#/components/schemas/token" }, "campos_extra": { "$ref": "#/components/schemas/campos_extra" }, "per_dup": { "$ref": "#/components/schemas/per_dup" }, "testa_pagamento": { "$ref": "#/components/schemas/testa_pagamento" } } }, "gerarReferenciaMBDL": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "data_inicio": { "type": "string (Y-m-d)", "description": "Initial date to pay the reference" }, "data_fim": { "type": "string (Y-m-d)", "description": "Deadline to pay the reference." }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "token": { "$ref": "#/components/schemas/token" }, "campos_extra": { "$ref": "#/components/schemas/campos_extra", "description": "Additional information to associate to extra fields" }, "valor_minimo": { "$ref": "#/components/schemas/valor_minimo" }, "valor_maximo": { "$ref": "#/components/schemas/valor_maximo" }, "testa_pagamento": { "$ref": "#/components/schemas/testa_pagamento" }, "per_dup": { "$ref": "#/components/schemas/per_dup" } } }, "gerarReferenciaMBDLResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "entidade": { "type": "string", "description": "Entity for payment" }, "referencia": { "type": "string", "description": "Reference generated for ATM payment" }, "data_inicio": { "type": "string", "description": "Deadline to pay the reference" }, "data_fim": { "type": "string", "description": "Initial date to pay the reference" }, "valor": { "type": "float", "description": "The amount of the Multibanco reference." }, "valor_minimo": { "type": "float", "description": "Minimum Amount to pay the reference" }, "valor_maximo": { "type": "float", "format": "", "description": "Maximum Amount to pay the reference" }, "estado": { "type": "int", "format": "", "description": "API response code." }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state" } } }, "gerarReferenciaMBResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "entidade": { "type": "string", "description": "Entity for payment." }, "referencia": { "type": "string", "description": "Reference generated for ATM payment" }, "valor": { "type": "float", "description": "The amount of the Multibanco reference." }, "estado": { "type": "int", "description": "API response code." }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state." } } }, "gerarReferenciaPQ": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor_pq" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "campos_extra": { "$ref": "#/components/schemas/campos_extra" } } }, "gerarReferenciaPQResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "referencia": { "type": "string", "description": "string" }, "valor": { "type": "number", "format": "float", "description": "float" }, "estado": { "type": "int", "format": "", "description": "API response code" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state" } } }, "gerarReferenciaPS": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor_ps" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "campos_extra": { "$ref": "#/components/schemas/campos_extra" } } }, "gerarReferenciaPSResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "referencia": { "type": "string", "description": "Reference generated for Pagaqui payment" }, "valor": { "type": "float", "format": "", "description": "The amount of the Pagaqui reference" }, "estado": { "type": "int", "format": "", "description": "API response code" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state." } } }, "gerarReferenciaTranche": { "type": "object", "properties": { "tranche_id": { "type": "string", "description": "string" }, "valor": { "$ref": "#/components/schemas/valor" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "token": { "$ref": "#/components/schemas/token" }, "campos_extra": { "$ref": "#/components/schemas/campos_extra" }, "testa_pagamento": { "$ref": "#/components/schemas/testa_pagamento" } } }, "gerarReferenciaTrancheResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "true or false" }, "entidade": { "type": "string", "description": "string" }, "referencia": { "type": "string", "description": "string" }, "valor": { "type": "number", "format": "float", "description": "float" }, "estado": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "resposta": { "type": "string", "description": "string" } } }, "informacaoMandatoADD": { "type": "object", "properties": { "chave": { "type": "string", "description": "API Channel’s Key (given by euPago)" }, "referencia": { "type": "string", "description": "Authorization number" } } }, "informacaoMandatoADDResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "valor": { "type": "float", "format": "", "description": "Direct Debit payment value" }, "estado": { "type": "string", "description": "API response Code on the action performed" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state" } } }, "informacaoReferencia": { "type": "object", "properties": { "chave": { "$ref": "#/components/schemas/chave" }, "referencia": { "type": "string", "description": "Reference to request information about" }, "entidade": { "type": "string", "description": "Entity (if applicable)" } } }, "informacaoReferenciaResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "data_pagamento": { "type": "string", "description": "Payment date (if any) of a reference" }, "hora_pagamento": { "type": "string", "description": "Time of payment (if any) of a reference" }, "local_pagamento": { "type": "string", "description": "Place of payment (if any) of a reference" }, "data_previsao_transferencia": { "type": "string", "description": "Scheduled date for settlement (if any)" }, "valor": { "type": "float", "format": "", "description": "Payment value" }, "comissao": { "type": "float", "format": "", "description": "Value of commission charged by euPago." }, "estado_referencia": { "type": "string", "description": "State of the reference" }, "estado": { "type": "string", "description": "API response Code on the action performed" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state." }, } }, "pagamento": { "type": "object", "properties": { "valor": { "type": "float", "description": "Direct Debit payment value" }, "tipo": { "type": "string", "description": "Payment type (Occasional: OOFF | Recurring: RCUR)" }, "auto_processar": { "type": "int", "format": "", "description": "0 - To not allow auto-processing; 1 - To allow auto-processing" }, "data": { "type": "string", "description": "Payment execution date" }, "periodicidade": { "$ref": "#/components/schemas/periodicidade" }, "data_final": { "type": "string", "description": "Payment execution deadline." } } }, "pagamentoCC": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor_cc" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "comentario": { "$ref": "#/components/schemas/comentario" }, "numero": { "type": "string", "description": "string" }, "cripto": { "type": "string", "description": "string" }, "validade": { "type": "string", "description": "string" }, "reserva": { "type": "string", "description": "string" }, "num_dias": { "type": "string", "description": "string" } } }, "pagamentoCCResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "true or false" }, "referencia": { "type": "string", "description": "string" }, "num_aut": { "type": "string", "description": "string" }, "valor": { "type": "string", "description": "string" }, "estado": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "resposta": { "type": "string", "description": "string" } } }, "pagamentoCC_tds": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor_cc" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "numero": { "type": "string", "description": "Credit card number." }, "cripto": { "type": "string", "description": "Card validation number (CVV)" }, "validade": { "type": "string", "description": "Validity of the format card: MM/YYYY. Example : 10/2019" }, "url_retorno": { "$ref": "#/components/schemas/url_retorno" } } }, "pagamentoCC_tdsResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "referencia": { "type": "string", "description": "Reference generated for credit card payment" }, "estado": { "type": "int", "format": "", "description": "API response code." }, "resposta": { "type": "string", "description": "API response code descriptive message" }, "tds_url": { "type": "string", "description": "URL to where the client should be redirected to make the payment" } } }, "pedidoCC": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor" }, "chave": { "$ref": "#/components/schemas/chave" }, "id": { "$ref": "#/components/schemas/id" }, "url_logotipo": { "type": "string", "description": "URL to the image that will be shown on the payment form." }, "url_retorno": { "$ref": "#/components/schemas/url_retorno" }, "comentario": { "$ref": "#/components/schemas/comentario" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "nome": { "type": "string", "description": "Customer name" }, "email": { "type": "string", "description": "Customer email" }, "lang": { "type": "string", "description": "Language in which the payment form will be displayed" }, "tds": { "type": "string", "description": "This field is to force the customer to use a card with active 3ds, it is very effective in preventing fraud by drastically reducing the number of chargebacks. You should use the value at 1. Accepts the value: 1 (3ds force)" } } }, "pedidoCCResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "url": { "type": "string", "description": "URL to where the client should be redirected to make the payment" }, "referencia": { "type": "string", "description": "Refund reference" }, "valor": { "type": "string", "description": "Amount to pay" }, "estado": { "type": "int", "format": "", "description": "API response code." }, "resposta": { "type": "string", "description": "API response code description" } } }, "pedidoDD": { "type": "object", "properties": { "chave": { "type": "string", "description": "API Channel’s Key (given by euPago)" }, "mandato": { "type": "string", "description": "Mandate identifier" }, "valor": { "$ref": "#/components/schemas/valor" }, "data": { "type": "string", "description": "Payment execution date" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" } } }, "pedidoDDResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "API Channel’s Key (given by euPago)" }, "mandato": { "type": "string", "description": "Mandate identifier" }, "referencia": { "type": "string", "description": "Direct Debit reference" }, "valor": { "type": "string", "description": "Direct Debit payment value" }, "estado": { "type": "int", "format": "", "description": "API response Code on the action performed." }, "resposta": { "type": "string", "description": "API response code descriptive message" } } }, "pedidoMBW": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor_mbw" }, "chave": { "type": "string", "description": "API Channel’s Key (given by euPago)" }, "id": { "type": "string", "description": "Unique identifier of an order created by the user" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "campos_extra": { "$ref": "#/components/schemas/campos_extra" }, "alias": { "$ref": "#/components/schemas/alias" }, "descricao": { "type": "string", "description": "Message to show in the MB Way App before payment confirmation" } } }, "pedidoMBWResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "referencia": { "type": "string", "description": "Reference generated for MB Way payment" }, "valor": { "type": "float", "format": "", "description": "The amount of the MB Way reference." }, "estado": { "type": "int", "format": "", "description": "API response code" }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state" }, "alias": { "$ref": "#/components/schemas/alias" } } }, "pedidoPF": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor" }, "chave": { "type": "string", "description": "API Channel’s Key (given by euPago)" }, "id": { "type": "string", "description": "Unique identifier of an order created by the user" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "url_retorno": { "$ref": "#/components/schemas/url_retorno" }, "comentario": { "$ref": "#/components/schemas/comentario" } } }, "pedidoPFResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "url": { "type": "string", "description": "URL to where the client should be redirected to make the payment." }, "url_paysafeCard": { "type": "string", "description": "URL to which the customer must be redirected after completing thepayment" }, "referencia": { "type": "string", "description": "Reference generated for paysafecard request" }, "estado": { "type": "int", "format": "", "description": "API response code." }, "resposta": { "type": "string", "description": "Descriptive message about the code that comes in the state." } } }, "pedidoPSC": { "type": "object", "properties": { "valor": { "$ref": "#/components/schemas/valor" }, "chave": { "type": "string", "description": "API Channel’s Key (given by euPago)" }, "id": { "type": "string", "description": "Unique identifier of an order created by the user" }, "url_retorno": { "$ref": "#/components/schemas/url_retorno" }, "comentario": { "$ref": "#/components/schemas/comentario" }, "admin_callback": { "$ref": "#/components/schemas/admin_callback" }, "nome": { "type": "string", "description": "Customer name" }, "email": { "type": "string", "description": "Customer email" }, "lang": { "type": "string", "description": "Language in which the payment form will be displayed" } } }, "pedidoPSCResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "True/false → indicates the success or failure of the operation" }, "url": { "type": "string", "description": "URL to where the client should be redirected to make the payment" }, "referencia": { "type": "string", "description": "Paysafe:cash reference generated from the request" }, "valor": { "type": "string", "description": "The amount of the Paysafe:cash reference" }, "estado": { "type": "int", "format": "", "description": "API response code" }, "resposta": { "type": "string", "description": "API response code descriptive message" } } }, "periodicidade": { "type": "string", "description": "Direct Debit Frequency [ semanal (weekly) | quinzenal (biweekly) | mensal (monthly) | anual (yearly)" }, "tipo": { "type": "string", "description": "string" }, "validaCCResponse": { "type": "object", "properties": { "sucesso": { "type": "boolean", "description": "true or false" }, "estado": { "type": "number", "format": "int32", "description": "signed 32-bit integer" }, "resposta": { "type": "string", "description": "string" } } }, }, "requestBodies": { "autorizacaoDD": { "description": "autorizacaoDD Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/autorizacaoDD" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/autorizacaoDD" } } } }, "criarConta": { "description": "criarConta Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarConta" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/criarConta" } } } }, "criarTranche": { "description": "criarTranche Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarTranche" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/criarTranche" } } } }, "devolucaoMBW": { "description": "devolucaoMBW Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/devolucaoMBW" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/devolucaoMBW" } } } }, "gerarReferenciaMB": { "description": "gerarReferenciaMB Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMB" }, "example": { "valor": "2" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMB" } } } }, "gerarReferenciaMBDL": { "description": "gerarReferenciaMBDL Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMBDL" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaMBDL" } } } }, "gerarReferenciaPS": { "description": "gerarReferenciaPS Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaPS" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaPS" } } } }, "gerarReferenciaTranche": { "description": "gerarReferenciaTranche Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gerarReferenciaTranche" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/gerarReferenciaTranche" } } } }, "informacaoMandatoADD": { "description": "informacaoMandatoADD Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/informacaoMandatoADD" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/informacaoMandatoADD" } } } }, "informacaoReferencia": { "description": "informacaoReferencia Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/informacaoReferencia" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/informacaoReferencia" } } } }, "pagamentoCC": { "description": "pagamentoCC Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pagamentoCC" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pagamentoCC" } } } }, "pagamentoCC_tds": { "description": "pagamentoCC_tds Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pagamentoCC_tds" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pagamentoCC_tds" } } } }, "pedidoCC": { "description": "pedidoCC Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoCC" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoCC" } } } }, "pedidoDD": { "description": "pedidoDD Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoDD" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoDD" } } } }, "pedidoMBW": { "description": "pedidoMBW Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoMBW" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoMBW" } } } }, "pedidoPF": { "description": "pedidoPF Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoPF" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoPF" } } } }, "pedidoPSC": { "description": "pedidoPSC Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pedidoPSC" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/pedidoPSC" } } } }, } }, "security": [ { "BasicAuth": [] }, { "BearerAuth": [] }, { "ApiKeyQuery": [] }, { "ApiKeyHeader": [] }, { "SessionTokenQuery": [] }, { "SessionTokenHeader": [] } ], "tags": [], "info": { "title": "EuPago SOAP API", "description": "EuPago SOAP API", "version": "2.0" }, "paths": { "/autorizacaoDD": { "post": { "summary": "Direct Debit Authorization", "description": "autorizacaoDD: Enables payments by Direct Debit off a Client’s Bank account", "operationId": "callEuPagoSOAPAPIautorizacaoDD", "requestBody": { "$ref": "#/components/requestBodies/autorizacaoDD" }, "responses": { "200": { "$ref": "#/components/responses/autorizacaoDDResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/devolucaoMBW": { "post": { "summary": "MB WAY Refund", "description": "devolucaoMBW: Method to refund the amount of a MB WAY request.", "operationId": "callEuPagoSOAPAPIdevolucaoMBW", "requestBody": { "$ref": "#/components/requestBodies/devolucaoMBW" }, "responses": { "200": { "$ref": "#/components/responses/devolucaoMBWResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/gerarReferenciaMB": { "post": { "summary": "Generate an ATM reference - Multibanco.", "description": "Method to generate ATM references", "operationId": "gerarReferenciaMB: callEuPagoSOAPAPIgerarReferenciaMB", "requestBody": { "$ref": "#/components/requestBodies/gerarReferenciaMB" }, "responses": { "200": { "$ref": "#/components/responses/gerarReferenciaMBResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/gerarReferenciaMBDL": { "post": { "summary": "Generate an ATM reference - Multibanco with deadline.", "description": "gerarReferenciaMBDL: Method to generate ATM references with deadline", "operationId": "callEuPagoSOAPAPIgerarReferenciaMBDL", "requestBody": { "$ref": "#/components/requestBodies/gerarReferenciaMBDL" }, "responses": { "200": { "$ref": "#/components/responses/gerarReferenciaMBDLResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/gerarReferenciaPS": { "post": { "summary": "Generate a Payshop reference.", "description": "gerarReferenciaPS: Method to generate Payshop references", "operationId": "callEuPagoSOAPAPIgerarReferenciaPS", "requestBody": { "$ref": "#/components/requestBodies/gerarReferenciaPS" }, "responses": { "200": { "$ref": "#/components/responses/gerarReferenciaPSResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/gerarReferenciaTranche": { "post": { "summary": "Generate an ATM reference - Multibanco batch reference.", "description": "gerarReferenciaTranche: Method to generate Multibanco batch reference", "operationId": "callEuPagoSOAPAPIgerarReferenciaTranche", "requestBody": { "$ref": "#/components/requestBodies/gerarReferenciaTranche" }, "responses": { "200": { "$ref": "#/components/responses/gerarReferenciaTrancheResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/informacaoMandatoADD": { "post": { "summary": "Get information about an ADD Mandate operation.", "description": "informacaoMandatoADD: It alows to know the State of a Direct Debit Authorization request", "operationId": "callEuPagoSOAPAPIinformacaoMandatoADD", "requestBody": { "$ref": "#/components/requestBodies/informacaoMandatoADD" }, "responses": { "200": { "$ref": "#/components/responses/informacaoMandatoADDResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/informacaoReferencia": { "post": { "summary": "Get Informations about a reference.", "description": "informacaoReferencia: Knowing the status and other information available for a reference.", "operationId": "callEuPagoSOAPAPIinformacaoReferencia", "requestBody": { "$ref": "#/components/requestBodies/informacaoReferencia" }, "responses": { "200": { "$ref": "#/components/responses/informacaoReferenciaResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/pagamentoCC_tds": { "post": { "summary": "Credit card 3DS Payment", "description": "PagamentoCC_tds: Method to make payments by credit card directly by api. This method forces the use of 3ds, allowing only payments for cards that support 3ds.", "operationId": "callEuPagoSOAPAPIpagamentoCC_tds", "requestBody": { "$ref": "#/components/requestBodies/pagamentoCC_tds" }, "responses": { "200": { "$ref": "#/components/responses/pagamentoCC_tdsResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/pedidoCC": { "post": { "summary": "Credit Card payment – (External form)", "description": "PedidoCC: Method to generate credit card payments", "operationId": "callEuPagoSOAPAPIpedidoCC", "requestBody": { "$ref": "#/components/requestBodies/pedidoCC" }, "responses": { "200": { "$ref": "#/components/responses/pedidoCCResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/pedidoDD": { "post": { "summary": "Direct Debit Update", "description": "pedidoDD: Given a recurring Direct Debit (DD), it permits to update the associated value for a certain month", "operationId": "callEuPagoSOAPAPIpedidoDD", "requestBody": { "$ref": "#/components/requestBodies/pedidoDD" }, "responses": { "200": { "$ref": "#/components/responses/pedidoDDResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/pedidoMBW": { "post": { "summary": "MB WAY Request.", "description": "pedidoMBW: Method to generate MB WAY request", "operationId": "callEuPagoSOAPAPIpedidoMBW", "requestBody": { "$ref": "#/components/requestBodies/pedidoMBW" }, "responses": { "200": { "$ref": "#/components/responses/pedidoMBWResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/pedidoPF": { "post": { "summary": "Paysafecard Request.", "description": "PedidoPF: Method to generate a Paysafecard request", "operationId": "callEuPagoSOAPAPIpedidoPF", "requestBody": { "$ref": "#/components/requestBodies/pedidoPF" }, "responses": { "200": { "$ref": "#/components/responses/pedidoPFResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, "/pedidoPSC": { "post": { "summary": "Paysafe:cash Request.", "description": "pedidoPSC: Method to generate a Paysafe:cash request", "operationId": "callEuPagoSOAPAPIpedidoPSC", "requestBody": { "$ref": "#/components/requestBodies/pedidoPSC" }, "responses": { "200": { "$ref": "#/components/responses/pedidoPSCResponse" }, "default": { "$ref": "#/components/responses/Error" } }, "tags": [ "EuPago-SOAP-API" ] } }, } }