From 2fa2a8d21c238d2dc034db3fa44134cdc3c846d8 Mon Sep 17 00:00:00 2001 From: Jacopo Carlini Date: Tue, 3 Sep 2024 15:52:07 +0200 Subject: [PATCH 1/4] new path paid notice disable --- openapi/openapi.json | 3480 ++++++++--------- openapi/openapi_ec.json | 1071 +++-- openapi/openapi_helpdesk.json | 1438 ++++--- openapi/openapi_io.json | 1618 ++++---- .../controller/IPaidNoticeController.java | 41 + .../controller/ITransactionController.java | 33 +- .../controller/impl/PaidNoticeController.java | 32 + .../controller/PaidNoticeControllerTest.java | 95 + .../receipts/getOrganizationReceipt.json | 2 +- 9 files changed, 3865 insertions(+), 3945 deletions(-) create mode 100644 src/main/java/it/gov/pagopa/bizeventsservice/controller/IPaidNoticeController.java create mode 100644 src/main/java/it/gov/pagopa/bizeventsservice/controller/impl/PaidNoticeController.java create mode 100644 src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java diff --git a/openapi/openapi.json b/openapi/openapi.json index c7082817..a0bea9e9 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -1,2430 +1,2372 @@ { - "openapi": "3.0.1", - "info": { - "title": "Biz-Events Service", - "description": "Microservice for exposing REST APIs about payment receipts.", - "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.1.48" + "openapi" : "3.0.1", + "info" : { + "title" : "Biz-Events Service", + "description" : "Microservice for exposing REST APIs about payment receipts.", + "termsOfService" : "https://www.pagopa.gov.it/", + "version" : "0.1.48" }, - "servers": [ - { - "url": "http://localhost", - "description": "Generated server url" - } - ], - "paths": { - "/events/organizations/{organization-fiscal-code}/iuvs/{iuv}": { - "get": { - "tags": [ - "Biz-Events Helpdesk" - ], - "summary": "Retrieve the biz-event given the organization fiscal code and IUV.", - "operationId": "getBizEventByOrganizationFiscalCodeAndIuv", - "parameters": [ - { - "name": "organization-fiscal-code", - "in": "path", - "description": "The fiscal code of the Organization.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iuv", - "in": "path", - "description": "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Obtained biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "servers" : [ { + "url" : "http://localhost", + "description" : "Generated server url" + } ], + "paths" : { + "/events/organizations/{organization-fiscal-code}/iuvs/{iuv}" : { + "get" : { + "tags" : [ "Biz-Events Helpdesk" ], + "summary" : "Retrieve the biz-event given the organization fiscal code and IUV.", + "operationId" : "getBizEventByOrganizationFiscalCodeAndIuv", + "parameters" : [ { + "name" : "organization-fiscal-code", + "in" : "path", + "description" : "The fiscal code of the Organization.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iuv", + "in" : "path", + "description" : "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BizEvent" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BizEvent" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/events/{biz-event-id}": { - "get": { - "tags": [ - "Biz-Events Helpdesk" - ], - "summary": "Retrieve the biz-event given its id.", - "operationId": "getBizEvent", - "parameters": [ - { - "name": "biz-event-id", - "in": "path", - "description": "The id of the biz-event.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Obtained biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/events/{biz-event-id}" : { + "get" : { + "tags" : [ "Biz-Events Helpdesk" ], + "summary" : "Retrieve the biz-event given its id.", + "operationId" : "getBizEvent", + "parameters" : [ { + "name" : "biz-event-id", + "in" : "path", + "description" : "The id of the biz-event.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BizEvent" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BizEvent" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/info": { - "get": { - "tags": [ - "Home" - ], - "summary": "health check", - "description": "Return OK if application is started", - "operationId": "healthCheck", - "responses": { - "200": { - "description": "OK", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/info" : { + "get" : { + "tags" : [ "Home" ], + "summary" : "health check", + "description" : "Return OK if application is started", + "operationId" : "healthCheck", + "responses" : { + "200" : { + "description" : "OK", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfo" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AppInfo" } } } }, - "400": { - "description": "Bad Request", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "400" : { + "description" : "Bad Request", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "401": { - "description": "Unauthorized", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Unauthorized", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "403": { - "description": "Forbidden", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "403" : { + "description" : "Forbidden", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "429": { - "description": "Too many requests", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/organizations/{organizationfiscalcode}/receipts/{iur}": { - "get": { - "tags": [ - "Payment Receipts REST APIs" - ], - "summary": "The organization get the receipt for the creditor institution using IUR.", - "operationId": "getOrganizationReceiptIur", - "parameters": [ - { - "name": "organizationfiscalcode", - "in": "path", - "description": "The fiscal code of the Organization.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iur", - "in": "path", - "description": "The unique reference of the operation assigned to the payment (Payment Token).", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Obtained receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/organizations/{organizationfiscalcode}/receipts/{iur}" : { + "get" : { + "tags" : [ "Payment Receipts REST APIs" ], + "summary" : "The organization get the receipt for the creditor institution using IUR.", + "operationId" : "getOrganizationReceiptIur", + "parameters" : [ { + "name" : "organizationfiscalcode", + "in" : "path", + "description" : "The fiscal code of the Organization.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iur", + "in" : "path", + "description" : "The unique reference of the operation assigned to the payment (Payment Token).", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CtReceiptModelResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CtReceiptModelResponse" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/organizations/{organizationfiscalcode}/receipts/{iur}/paymentoptions/{iuv}": { - "get": { - "tags": [ - "Payment Receipts REST APIs" - ], - "summary": "The organization get the receipt for the creditor institution using IUV and IUR.", - "operationId": "getOrganizationReceiptIuvIur", - "parameters": [ - { - "name": "organizationfiscalcode", - "in": "path", - "description": "The fiscal code of the Organization.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iur", - "in": "path", - "description": "The unique reference of the operation assigned to the payment (Payment Token).", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iuv", - "in": "path", - "description": "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Obtained receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/organizations/{organizationfiscalcode}/receipts/{iur}/paymentoptions/{iuv}" : { + "get" : { + "tags" : [ "Payment Receipts REST APIs" ], + "summary" : "The organization get the receipt for the creditor institution using IUV and IUR.", + "operationId" : "getOrganizationReceiptIuvIur", + "parameters" : [ { + "name" : "organizationfiscalcode", + "in" : "path", + "description" : "The fiscal code of the Organization.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iur", + "in" : "path", + "description" : "The unique reference of the operation assigned to the payment (Payment Token).", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iuv", + "in" : "path", + "description" : "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CtReceiptModelResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CtReceiptModelResponse" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" + } + } ] + }, + "/paids/{event-id}/disable" : { + "post" : { + "tags" : [ "Paid Notice REST APIs" ], + "summary" : "Disable the paid notice details given its id.", + "operationId" : "disablePaidNotice", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "event-id", + "in" : "path", + "description" : "The id of the paid event.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Event Disabled.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { } + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + } + }, + "404" : { + "description" : "Not found the paid event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" + } + } + } + }, + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" + } + } + } } + }, + "security" : [ { + "ApiKey" : [ ] + } ] + }, + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the paged transaction list from biz events.", - "operationId": "getTransactionList", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "is_payer", - "in": "query", - "description": "Filter by payer", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "is_debtor", - "in": "query", - "description": "Filter by debtor", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "x-continuation-token", - "in": "header", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "orderby", - "in": "query", - "description": "Order by TRANSACTION_DATE", - "required": false, - "schema": { - "type": "string", - "default": "TRANSACTION_DATE", - "enum": [ - "TRANSACTION_DATE" - ] - } - }, - { - "name": "ordering", - "in": "query", - "description": "Direction of ordering", - "required": false, - "schema": { - "type": "string", - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ] - } - } - ], - "responses": { - "200": { - "description": "Obtained transaction list.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/transactions" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the paged transaction list from biz events.", + "operationId" : "getTransactionList", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "is_payer", + "in" : "query", + "description" : "Filter by payer", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "is_debtor", + "in" : "query", + "description" : "Filter by debtor", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "x-continuation-token", + "in" : "header", + "required" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "size", + "in" : "query", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "orderby", + "in" : "query", + "description" : "Order by TRANSACTION_DATE", + "required" : false, + "schema" : { + "type" : "string", + "default" : "TRANSACTION_DATE", + "enum" : [ "TRANSACTION_DATE" ] + } + }, { + "name" : "ordering", + "in" : "query", + "description" : "Direction of ordering", + "required" : false, + "schema" : { + "type" : "string", + "default" : "DESC", + "enum" : [ "ASC", "DESC" ] + } + } ], + "responses" : { + "200" : { + "description" : "Obtained transaction list.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } }, - "x-continuation-token": { - "description": "continuation token for paginated query", - "style": "simple", - "schema": { - "type": "string" + "x-continuation-token" : { + "description" : "continuation token for paginated query", + "style" : "simple", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionListWrapResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionListWrapResponse" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/cached": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the paged transaction list from biz events.", - "operationId": "getTransactionList_1", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "is_payer", - "in": "query", - "description": "Filter by payer", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "is_debtor", - "in": "query", - "description": "Filter by debtor", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "page", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "orderby", - "in": "query", - "description": "Order by TRANSACTION_DATE", - "required": false, - "schema": { - "type": "string", - "default": "TRANSACTION_DATE", - "enum": [ - "TRANSACTION_DATE" - ] - } - }, - { - "name": "ordering", - "in": "query", - "description": "Direction of ordering", - "required": false, - "schema": { - "type": "string", - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ] - } - } - ], - "responses": { - "200": { - "description": "Obtained transaction list.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/transactions/cached" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the paged transaction list from biz events.", + "operationId" : "getTransactionList_1", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "is_payer", + "in" : "query", + "description" : "Filter by payer", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "is_debtor", + "in" : "query", + "description" : "Filter by debtor", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "page", + "in" : "query", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "size", + "in" : "query", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "orderby", + "in" : "query", + "description" : "Order by TRANSACTION_DATE", + "required" : false, + "schema" : { + "type" : "string", + "default" : "TRANSACTION_DATE", + "enum" : [ "TRANSACTION_DATE" ] + } + }, { + "name" : "ordering", + "in" : "query", + "description" : "Direction of ordering", + "required" : false, + "schema" : { + "type" : "string", + "default" : "DESC", + "enum" : [ "ASC", "DESC" ] + } + } ], + "responses" : { + "200" : { + "description" : "Obtained transaction list.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionListWrapResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionListWrapResponse" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/{event-id}/pdf": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the PDF receipt given event id.", - "operationId": "getPDFReceipt", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "event-id", - "in": "path", - "description": "The id of the event.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Obtained the PDF receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/transactions/{event-id}/pdf" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the PDF receipt given event id.", + "operationId" : "getPDFReceipt", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "event-id", + "in" : "path", + "description" : "The id of the event.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained the PDF receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/pdf": { - "schema": { - "type": "string", - "format": "binary" + "content" : { + "application/pdf" : { + "schema" : { + "type" : "string", + "format" : "binary" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unprocessable receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unprocessable receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/{transaction-id}": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the transaction details given its id.", - "operationId": "getTransactionDetails", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "transaction-id", - "in": "path", - "description": "The id of the transaction.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Obtained transaction details.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/transactions/{transaction-id}" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the transaction details given its id.", + "operationId" : "getTransactionDetails", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "transaction-id", + "in" : "path", + "description" : "The id of the transaction.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained transaction details.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionDetailResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionDetailResponse" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/{transaction-id}/disable": { - "post": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Disable the transaction details given its id.", - "operationId": "disableTransaction", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "transaction-id", - "in": "path", - "description": "The id of the transaction.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Disabled Transactions.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/transactions/{transaction-id}/disable" : { + "post" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Disable the transaction details given its id.", + "description" : "This service is deprecated. Use Paid Notice APIs instead", + "operationId" : "disableTransaction", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "transaction-id", + "in" : "path", + "description" : "The id of the transaction.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Disabled Transactions.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": {} + "content" : { + "application/json" : { } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "deprecated" : true, + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] } }, - "components": { - "schemas": { - "ProblemJson": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" - }, - "status": { - "maximum": 600, - "minimum": 100, - "type": "integer", - "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format": "int32", - "example": 200 - }, - "detail": { - "type": "string", - "description": "A human readable explanation specific to this occurrence of the problem.", - "example": "There was an error processing the request" + "components" : { + "schemas" : { + "ProblemJson" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + }, + "status" : { + "maximum" : 600, + "minimum" : 100, + "type" : "integer", + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format" : "int32", + "example" : 200 + }, + "detail" : { + "type" : "string", + "description" : "A human readable explanation specific to this occurrence of the problem.", + "example" : "There was an error processing the request" } } }, - "PageInfo": { - "required": [ - "items_found", - "limit", - "page", - "total_pages" - ], - "type": "object", - "properties": { - "page": { - "type": "integer", - "description": "Page number", - "format": "int32" - }, - "limit": { - "type": "integer", - "description": "Required number of items per page", - "format": "int32" - }, - "items_found": { - "type": "integer", - "description": "Number of items found. (The last page may have fewer elements than required)", - "format": "int32" - }, - "total_pages": { - "type": "integer", - "description": "Total number of pages", - "format": "int32" + "PageInfo" : { + "required" : [ "items_found", "limit", "page", "total_pages" ], + "type" : "object", + "properties" : { + "page" : { + "type" : "integer", + "description" : "Page number", + "format" : "int32" + }, + "limit" : { + "type" : "integer", + "description" : "Required number of items per page", + "format" : "int32" + }, + "items_found" : { + "type" : "integer", + "description" : "Number of items found. (The last page may have fewer elements than required)", + "format" : "int32" + }, + "total_pages" : { + "type" : "integer", + "description" : "Total number of pages", + "format" : "int32" } } }, - "TransactionListItem": { - "type": "object", - "properties": { - "transactionId": { - "type": "string" + "TransactionListItem" : { + "type" : "object", + "properties" : { + "transactionId" : { + "type" : "string" }, - "payeeName": { - "type": "string" + "payeeName" : { + "type" : "string" }, - "payeeTaxCode": { - "type": "string" + "payeeTaxCode" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "transactionDate": { - "type": "string" + "transactionDate" : { + "type" : "string" }, - "isCart": { - "type": "boolean" + "isCart" : { + "type" : "boolean" }, - "isPayer": { - "type": "boolean" + "isPayer" : { + "type" : "boolean" }, - "isDebtor": { - "type": "boolean" + "isDebtor" : { + "type" : "boolean" } } }, - "TransactionListWrapResponse": { - "type": "object", - "properties": { - "transactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransactionListItem" + "TransactionListWrapResponse" : { + "type" : "object", + "properties" : { + "transactions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TransactionListItem" } }, - "page_info": { - "$ref": "#/components/schemas/PageInfo" + "page_info" : { + "$ref" : "#/components/schemas/PageInfo" } } }, - "CartItem": { - "type": "object", - "properties": { - "subject": { - "type": "string" + "CartItem" : { + "type" : "object", + "properties" : { + "subject" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "payee": { - "$ref": "#/components/schemas/UserDetail" + "payee" : { + "$ref" : "#/components/schemas/UserDetail" }, - "debtor": { - "$ref": "#/components/schemas/UserDetail" + "debtor" : { + "$ref" : "#/components/schemas/UserDetail" }, - "refNumberValue": { - "type": "string" + "refNumberValue" : { + "type" : "string" }, - "refNumberType": { - "type": "string" + "refNumberType" : { + "type" : "string" } } }, - "InfoTransactionView": { - "type": "object", - "properties": { - "transactionId": { - "type": "string" - }, - "authCode": { - "type": "string" - }, - "rrn": { - "type": "string" - }, - "transactionDate": { - "type": "string" - }, - "pspName": { - "type": "string" - }, - "walletInfo": { - "$ref": "#/components/schemas/WalletInfo" - }, - "paymentMethod": { - "type": "string", - "enum": [ - "BBT", - "BP", - "AD", - "CP", - "PO", - "OBEP", - "JIF", - "MYBK", - "PPAL", - "UNKNOWN" - ] - }, - "payer": { - "$ref": "#/components/schemas/UserDetail" - }, - "amount": { - "type": "string" - }, - "fee": { - "type": "string" - }, - "origin": { - "type": "string", - "enum": [ - "INTERNAL", - "PM", - "NDP001PROD", - "NDP002PROD", - "NDP003PROD", - "UNKNOWN" - ] + "InfoTransactionView" : { + "type" : "object", + "properties" : { + "transactionId" : { + "type" : "string" + }, + "authCode" : { + "type" : "string" + }, + "rrn" : { + "type" : "string" + }, + "transactionDate" : { + "type" : "string" + }, + "pspName" : { + "type" : "string" + }, + "walletInfo" : { + "$ref" : "#/components/schemas/WalletInfo" + }, + "paymentMethod" : { + "type" : "string", + "enum" : [ "BBT", "BP", "AD", "CP", "PO", "OBEP", "JIF", "MYBK", "PPAL", "UNKNOWN" ] + }, + "payer" : { + "$ref" : "#/components/schemas/UserDetail" + }, + "amount" : { + "type" : "string" + }, + "fee" : { + "type" : "string" + }, + "origin" : { + "type" : "string", + "enum" : [ "INTERNAL", "PM", "NDP001PROD", "NDP002PROD", "NDP003PROD", "UNKNOWN" ] } } }, - "TransactionDetailResponse": { - "type": "object", - "properties": { - "infoTransaction": { - "$ref": "#/components/schemas/InfoTransactionView" + "TransactionDetailResponse" : { + "type" : "object", + "properties" : { + "infoTransaction" : { + "$ref" : "#/components/schemas/InfoTransactionView" }, - "carts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartItem" + "carts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CartItem" } } } }, - "UserDetail": { - "type": "object", - "properties": { - "name": { - "type": "string" + "UserDetail" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" }, - "taxCode": { - "type": "string" + "taxCode" : { + "type" : "string" } } }, - "WalletInfo": { - "type": "object", - "properties": { - "accountHolder": { - "type": "string" + "WalletInfo" : { + "type" : "object", + "properties" : { + "accountHolder" : { + "type" : "string" }, - "brand": { - "type": "string" + "brand" : { + "type" : "string" }, - "blurredNumber": { - "type": "string" + "blurredNumber" : { + "type" : "string" }, - "maskedEmail": { - "type": "string" + "maskedEmail" : { + "type" : "string" } } }, - "CtReceiptModelResponse": { - "required": [ - "channelDescription", - "companyName", - "creditorReferenceId", - "debtor", - "description", - "fiscalCode", - "idChannel", - "idPSP", - "noticeNumber", - "outcome", - "paymentAmount", - "pspCompanyName", - "receiptId", - "transferList" - ], - "type": "object", - "properties": { - "receiptId": { - "type": "string" + "CtReceiptModelResponse" : { + "required" : [ "channelDescription", "companyName", "creditorReferenceId", "debtor", "description", "fiscalCode", "idChannel", "idPSP", "noticeNumber", "outcome", "paymentAmount", "pspCompanyName", "receiptId", "transferList" ], + "type" : "object", + "properties" : { + "receiptId" : { + "type" : "string" }, - "noticeNumber": { - "type": "string" + "noticeNumber" : { + "type" : "string" }, - "fiscalCode": { - "type": "string" + "fiscalCode" : { + "type" : "string" }, - "outcome": { - "type": "string" + "outcome" : { + "type" : "string" }, - "creditorReferenceId": { - "type": "string" + "creditorReferenceId" : { + "type" : "string" }, - "paymentAmount": { - "type": "number" + "paymentAmount" : { + "type" : "number" }, - "description": { - "type": "string" + "description" : { + "type" : "string" }, - "companyName": { - "type": "string" + "companyName" : { + "type" : "string" }, - "officeName": { - "type": "string" + "officeName" : { + "type" : "string" }, - "debtor": { - "$ref": "#/components/schemas/Debtor" + "debtor" : { + "$ref" : "#/components/schemas/Debtor" }, - "transferList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransferPA" + "transferList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TransferPA" } }, - "idPSP": { - "type": "string" + "idPSP" : { + "type" : "string" }, - "pspFiscalCode": { - "type": "string" + "pspFiscalCode" : { + "type" : "string" }, - "pspPartitaIVA": { - "type": "string" + "pspPartitaIVA" : { + "type" : "string" }, - "pspCompanyName": { - "type": "string" + "pspCompanyName" : { + "type" : "string" }, - "idChannel": { - "type": "string" + "idChannel" : { + "type" : "string" }, - "channelDescription": { - "type": "string" + "channelDescription" : { + "type" : "string" }, - "payer": { - "$ref": "#/components/schemas/Payer" + "payer" : { + "$ref" : "#/components/schemas/Payer" }, - "paymentMethod": { - "type": "string" + "paymentMethod" : { + "type" : "string" }, - "fee": { - "type": "number" + "fee" : { + "type" : "number" }, - "primaryCiIncurredFee": { - "type": "number" + "primaryCiIncurredFee" : { + "type" : "number" }, - "idBundle": { - "type": "string" + "idBundle" : { + "type" : "string" }, - "idCiBundle": { - "type": "string" + "idCiBundle" : { + "type" : "string" }, - "paymentDateTime": { - "type": "string", - "format": "date" + "paymentDateTime" : { + "type" : "string", + "format" : "date" }, - "applicationDate": { - "type": "string", - "format": "date" + "applicationDate" : { + "type" : "string", + "format" : "date" }, - "transferDate": { - "type": "string", - "format": "date" + "transferDate" : { + "type" : "string", + "format" : "date" }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } } } }, - "Debtor": { - "type": "object", - "properties": { - "fullName": { - "type": "string" + "Debtor" : { + "type" : "object", + "properties" : { + "fullName" : { + "type" : "string" }, - "entityUniqueIdentifierType": { - "type": "string" + "entityUniqueIdentifierType" : { + "type" : "string" }, - "entityUniqueIdentifierValue": { - "type": "string" + "entityUniqueIdentifierValue" : { + "type" : "string" }, - "streetName": { - "type": "string" + "streetName" : { + "type" : "string" }, - "civicNumber": { - "type": "string" + "civicNumber" : { + "type" : "string" }, - "postalCode": { - "type": "string" + "postalCode" : { + "type" : "string" }, - "city": { - "type": "string" + "city" : { + "type" : "string" }, - "stateProvinceRegion": { - "type": "string" + "stateProvinceRegion" : { + "type" : "string" }, - "country": { - "type": "string" + "country" : { + "type" : "string" }, - "eMail": { - "type": "string" + "eMail" : { + "type" : "string" } } }, - "MapEntry": { - "type": "object", - "properties": { - "key": { - "type": "string" + "MapEntry" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string" }, - "value": { - "type": "string" + "value" : { + "type" : "string" } } }, - "Payer": { - "type": "object", - "properties": { - "fullName": { - "type": "string" + "Payer" : { + "type" : "object", + "properties" : { + "fullName" : { + "type" : "string" }, - "entityUniqueIdentifierType": { - "type": "string" + "entityUniqueIdentifierType" : { + "type" : "string" }, - "entityUniqueIdentifierValue": { - "type": "string" + "entityUniqueIdentifierValue" : { + "type" : "string" }, - "streetName": { - "type": "string" + "streetName" : { + "type" : "string" }, - "civicNumber": { - "type": "string" + "civicNumber" : { + "type" : "string" }, - "postalCode": { - "type": "string" + "postalCode" : { + "type" : "string" }, - "city": { - "type": "string" + "city" : { + "type" : "string" }, - "stateProvinceRegion": { - "type": "string" + "stateProvinceRegion" : { + "type" : "string" }, - "country": { - "type": "string" + "country" : { + "type" : "string" }, - "eMail": { - "type": "string" + "eMail" : { + "type" : "string" } } }, - "TransferPA": { - "required": [ - "fiscalCodePA", - "iban", - "mbdAttachment", - "remittanceInformation", - "transferAmount", - "transferCategory" - ], - "type": "object", - "properties": { - "idTransfer": { - "maximum": 5, - "minimum": 1, - "type": "integer", - "format": "int32" - }, - "transferAmount": { - "type": "number" - }, - "fiscalCodePA": { - "type": "string" - }, - "iban": { - "type": "string" - }, - "mbdAttachment": { - "type": "string" - }, - "remittanceInformation": { - "type": "string" - }, - "transferCategory": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "TransferPA" : { + "required" : [ "fiscalCodePA", "iban", "mbdAttachment", "remittanceInformation", "transferAmount", "transferCategory" ], + "type" : "object", + "properties" : { + "idTransfer" : { + "maximum" : 5, + "minimum" : 1, + "type" : "integer", + "format" : "int32" + }, + "transferAmount" : { + "type" : "number" + }, + "fiscalCodePA" : { + "type" : "string" + }, + "iban" : { + "type" : "string" + }, + "mbdAttachment" : { + "type" : "string" + }, + "remittanceInformation" : { + "type" : "string" + }, + "transferCategory" : { + "type" : "string" + }, + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } } } }, - "AppInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" + "AppInfo" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" }, - "version": { - "type": "string" + "version" : { + "type" : "string" }, - "environment": { - "type": "string" + "environment" : { + "type" : "string" } } }, - "AuthRequest": { - "type": "object", - "properties": { - "authOutcome": { - "type": "string" + "AuthRequest" : { + "type" : "object", + "properties" : { + "authOutcome" : { + "type" : "string" }, - "guid": { - "type": "string" + "guid" : { + "type" : "string" }, - "correlationId": { - "type": "string" + "correlationId" : { + "type" : "string" }, - "error": { - "type": "string" + "error" : { + "type" : "string" }, - "auth_code": { - "type": "string" + "auth_code" : { + "type" : "string" } } }, - "BizEvent": { - "type": "object", - "properties": { - "id": { - "type": "string" + "BizEvent" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" }, - "version": { - "type": "string" + "version" : { + "type" : "string" }, - "idPaymentManager": { - "type": "string" + "idPaymentManager" : { + "type" : "string" }, - "complete": { - "type": "string" + "complete" : { + "type" : "string" }, - "receiptId": { - "type": "string" + "receiptId" : { + "type" : "string" }, - "missingInfo": { - "type": "array", - "items": { - "type": "string" + "missingInfo" : { + "type" : "array", + "items" : { + "type" : "string" } }, - "debtorPosition": { - "$ref": "#/components/schemas/DebtorPosition" + "debtorPosition" : { + "$ref" : "#/components/schemas/DebtorPosition" }, - "creditor": { - "$ref": "#/components/schemas/Creditor" + "creditor" : { + "$ref" : "#/components/schemas/Creditor" }, - "psp": { - "$ref": "#/components/schemas/Psp" + "psp" : { + "$ref" : "#/components/schemas/Psp" }, - "debtor": { - "$ref": "#/components/schemas/Debtor" + "debtor" : { + "$ref" : "#/components/schemas/Debtor" }, - "payer": { - "$ref": "#/components/schemas/Payer" + "payer" : { + "$ref" : "#/components/schemas/Payer" }, - "paymentInfo": { - "$ref": "#/components/schemas/PaymentInfo" + "paymentInfo" : { + "$ref" : "#/components/schemas/PaymentInfo" }, - "transferList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transfer" + "transferList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Transfer" } }, - "transactionDetails": { - "$ref": "#/components/schemas/TransactionDetails" + "transactionDetails" : { + "$ref" : "#/components/schemas/TransactionDetails" }, - "eventStatus": { - "type": "string", - "enum": [ - "NA", - "RETRY", - "FAILED", - "DONE", - "INGESTED" - ] + "eventStatus" : { + "type" : "string", + "enum" : [ "NA", "RETRY", "FAILED", "DONE", "INGESTED" ] }, - "eventRetryEnrichmentCount": { - "type": "integer", - "format": "int32" + "eventRetryEnrichmentCount" : { + "type" : "integer", + "format" : "int32" } } }, - "Creditor": { - "type": "object", - "properties": { - "idPA": { - "type": "string" + "Creditor" : { + "type" : "object", + "properties" : { + "idPA" : { + "type" : "string" }, - "idBrokerPA": { - "type": "string" + "idBrokerPA" : { + "type" : "string" }, - "idStation": { - "type": "string" + "idStation" : { + "type" : "string" }, - "companyName": { - "type": "string" + "companyName" : { + "type" : "string" }, - "officeName": { - "type": "string" + "officeName" : { + "type" : "string" } } }, - "DebtorPosition": { - "type": "object", - "properties": { - "modelType": { - "type": "string" + "DebtorPosition" : { + "type" : "object", + "properties" : { + "modelType" : { + "type" : "string" }, - "noticeNumber": { - "type": "string" + "noticeNumber" : { + "type" : "string" }, - "iuv": { - "type": "string" + "iuv" : { + "type" : "string" }, - "iur": { - "type": "string" + "iur" : { + "type" : "string" } } }, - "Details": { - "type": "object", - "properties": { - "blurredNumber": { - "type": "string" + "Details" : { + "type" : "object", + "properties" : { + "blurredNumber" : { + "type" : "string" }, - "holder": { - "type": "string" + "holder" : { + "type" : "string" }, - "circuit": { - "type": "string" + "circuit" : { + "type" : "string" } } }, - "Info": { - "type": "object", - "properties": { - "type": { - "type": "string" + "Info" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" }, - "blurredNumber": { - "type": "string" + "blurredNumber" : { + "type" : "string" }, - "holder": { - "type": "string" + "holder" : { + "type" : "string" }, - "expireMonth": { - "type": "string" + "expireMonth" : { + "type" : "string" }, - "expireYear": { - "type": "string" + "expireYear" : { + "type" : "string" }, - "brand": { - "type": "string" + "brand" : { + "type" : "string" }, - "issuerAbi": { - "type": "string" + "issuerAbi" : { + "type" : "string" }, - "issuerName": { - "type": "string" + "issuerName" : { + "type" : "string" }, - "label": { - "type": "string" + "label" : { + "type" : "string" } } }, - "InfoTransaction": { - "type": "object", - "properties": { - "brand": { - "type": "string" + "InfoTransaction" : { + "type" : "object", + "properties" : { + "brand" : { + "type" : "string" }, - "brandLogo": { - "type": "string" + "brandLogo" : { + "type" : "string" }, - "clientId": { - "type": "string" + "clientId" : { + "type" : "string" }, - "paymentMethodName": { - "type": "string" + "paymentMethodName" : { + "type" : "string" }, - "type": { - "type": "string" + "type" : { + "type" : "string" } } }, - "MBD": { - "type": "object", - "properties": { - "IUBD": { - "type": "string" + "MBD" : { + "type" : "object", + "properties" : { + "IUBD" : { + "type" : "string" }, - "oraAcquisto": { - "type": "string" + "oraAcquisto" : { + "type" : "string" }, - "importo": { - "type": "string" + "importo" : { + "type" : "string" }, - "tipoBollo": { - "type": "string" + "tipoBollo" : { + "type" : "string" }, - "MBDAttachment": { - "type": "string" + "MBDAttachment" : { + "type" : "string" } } }, - "PaymentAuthorizationRequest": { - "type": "object", - "properties": { - "authOutcome": { - "type": "string" + "PaymentAuthorizationRequest" : { + "type" : "object", + "properties" : { + "authOutcome" : { + "type" : "string" }, - "requestId": { - "type": "string" + "requestId" : { + "type" : "string" }, - "correlationId": { - "type": "string" + "correlationId" : { + "type" : "string" }, - "authCode": { - "type": "string" + "authCode" : { + "type" : "string" }, - "paymentMethodType": { - "type": "string" + "paymentMethodType" : { + "type" : "string" }, - "details": { - "$ref": "#/components/schemas/Details" + "details" : { + "$ref" : "#/components/schemas/Details" } } }, - "PaymentInfo": { - "type": "object", - "properties": { - "paymentDateTime": { - "type": "string" + "PaymentInfo" : { + "type" : "object", + "properties" : { + "paymentDateTime" : { + "type" : "string" }, - "applicationDate": { - "type": "string" + "applicationDate" : { + "type" : "string" }, - "transferDate": { - "type": "string" + "transferDate" : { + "type" : "string" }, - "dueDate": { - "type": "string" + "dueDate" : { + "type" : "string" }, - "paymentToken": { - "type": "string" + "paymentToken" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "fee": { - "type": "string" + "fee" : { + "type" : "string" }, - "primaryCiIncurredFee": { - "type": "string" + "primaryCiIncurredFee" : { + "type" : "string" }, - "idBundle": { - "type": "string" + "idBundle" : { + "type" : "string" }, - "idCiBundle": { - "type": "string" + "idCiBundle" : { + "type" : "string" }, - "totalNotice": { - "type": "string" + "totalNotice" : { + "type" : "string" }, - "paymentMethod": { - "type": "string" + "paymentMethod" : { + "type" : "string" }, - "touchpoint": { - "type": "string" + "touchpoint" : { + "type" : "string" }, - "remittanceInformation": { - "type": "string" + "remittanceInformation" : { + "type" : "string" }, - "description": { - "type": "string" + "description" : { + "type" : "string" }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } }, - "IUR": { - "type": "string" + "IUR" : { + "type" : "string" } } }, - "Psp": { - "type": "object", - "properties": { - "idPsp": { - "type": "string" + "Psp" : { + "type" : "object", + "properties" : { + "idPsp" : { + "type" : "string" }, - "idBrokerPsp": { - "type": "string" + "idBrokerPsp" : { + "type" : "string" }, - "idChannel": { - "type": "string" + "idChannel" : { + "type" : "string" }, - "psp": { - "type": "string" + "psp" : { + "type" : "string" }, - "pspPartitaIVA": { - "type": "string" + "pspPartitaIVA" : { + "type" : "string" }, - "pspFiscalCode": { - "type": "string" + "pspFiscalCode" : { + "type" : "string" }, - "channelDescription": { - "type": "string" + "channelDescription" : { + "type" : "string" } } }, - "Transaction": { - "type": "object", - "properties": { - "idTransaction": { - "type": "string" + "Transaction" : { + "type" : "object", + "properties" : { + "idTransaction" : { + "type" : "string" }, - "transactionId": { - "type": "string" + "transactionId" : { + "type" : "string" }, - "grandTotal": { - "type": "integer", - "format": "int64" + "grandTotal" : { + "type" : "integer", + "format" : "int64" }, - "amount": { - "type": "integer", - "format": "int64" + "amount" : { + "type" : "integer", + "format" : "int64" }, - "fee": { - "type": "integer", - "format": "int64" + "fee" : { + "type" : "integer", + "format" : "int64" }, - "transactionStatus": { - "type": "string" + "transactionStatus" : { + "type" : "string" }, - "accountingStatus": { - "type": "string" + "accountingStatus" : { + "type" : "string" }, - "rrn": { - "type": "string" + "rrn" : { + "type" : "string" }, - "authorizationCode": { - "type": "string" + "authorizationCode" : { + "type" : "string" }, - "creationDate": { - "type": "string" + "creationDate" : { + "type" : "string" }, - "numAut": { - "type": "string" + "numAut" : { + "type" : "string" }, - "accountCode": { - "type": "string" + "accountCode" : { + "type" : "string" }, - "psp": { - "$ref": "#/components/schemas/TransactionPsp" + "psp" : { + "$ref" : "#/components/schemas/TransactionPsp" }, - "origin": { - "type": "string" + "origin" : { + "type" : "string" } } }, - "TransactionDetails": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/User" + "TransactionDetails" : { + "type" : "object", + "properties" : { + "user" : { + "$ref" : "#/components/schemas/User" }, - "paymentAuthorizationRequest": { - "$ref": "#/components/schemas/PaymentAuthorizationRequest" + "paymentAuthorizationRequest" : { + "$ref" : "#/components/schemas/PaymentAuthorizationRequest" }, - "wallet": { - "$ref": "#/components/schemas/WalletItem" + "wallet" : { + "$ref" : "#/components/schemas/WalletItem" }, - "origin": { - "type": "string" + "origin" : { + "type" : "string" }, - "transaction": { - "$ref": "#/components/schemas/Transaction" + "transaction" : { + "$ref" : "#/components/schemas/Transaction" }, - "info": { - "$ref": "#/components/schemas/InfoTransaction" + "info" : { + "$ref" : "#/components/schemas/InfoTransaction" } } }, - "TransactionPsp": { - "type": "object", - "properties": { - "idChannel": { - "type": "string" + "TransactionPsp" : { + "type" : "object", + "properties" : { + "idChannel" : { + "type" : "string" }, - "businessName": { - "type": "string" + "businessName" : { + "type" : "string" }, - "serviceName": { - "type": "string" + "serviceName" : { + "type" : "string" } } }, - "Transfer": { - "type": "object", - "properties": { - "idTransfer": { - "type": "string" + "Transfer" : { + "type" : "object", + "properties" : { + "idTransfer" : { + "type" : "string" }, - "fiscalCodePA": { - "type": "string" + "fiscalCodePA" : { + "type" : "string" }, - "companyName": { - "type": "string" + "companyName" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "transferCategory": { - "type": "string" + "transferCategory" : { + "type" : "string" }, - "remittanceInformation": { - "type": "string" + "remittanceInformation" : { + "type" : "string" }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } }, - "IBAN": { - "type": "string" + "IBAN" : { + "type" : "string" }, - "MBD": { - "$ref": "#/components/schemas/MBD" + "MBD" : { + "$ref" : "#/components/schemas/MBD" } } }, - "User": { - "type": "object", - "properties": { - "fullName": { - "type": "string" + "User" : { + "type" : "object", + "properties" : { + "fullName" : { + "type" : "string" }, - "type": { - "type": "string", - "enum": [ - "F", - "G", - "GUEST", - "REGISTERED" - ] + "type" : { + "type" : "string", + "enum" : [ "F", "G", "GUEST", "REGISTERED" ] }, - "fiscalCode": { - "type": "string" + "fiscalCode" : { + "type" : "string" }, - "notificationEmail": { - "type": "string" + "notificationEmail" : { + "type" : "string" }, - "userId": { - "type": "string" + "userId" : { + "type" : "string" }, - "userStatus": { - "type": "string" + "userStatus" : { + "type" : "string" }, - "userStatusDescription": { - "type": "string" + "userStatusDescription" : { + "type" : "string" } } }, - "WalletItem": { - "type": "object", - "properties": { - "idWallet": { - "type": "string" + "WalletItem" : { + "type" : "object", + "properties" : { + "idWallet" : { + "type" : "string" }, - "walletType": { - "type": "string", - "enum": [ - "CARD", - "PAYPAL", - "BANCOMATPAY" - ] + "walletType" : { + "type" : "string", + "enum" : [ "CARD", "PAYPAL", "BANCOMATPAY" ] }, - "enableableFunctions": { - "type": "array", - "items": { - "type": "string" + "enableableFunctions" : { + "type" : "array", + "items" : { + "type" : "string" } }, - "pagoPa": { - "type": "boolean" + "pagoPa" : { + "type" : "boolean" }, - "onboardingChannel": { - "type": "string" + "onboardingChannel" : { + "type" : "string" }, - "favourite": { - "type": "boolean" + "favourite" : { + "type" : "boolean" }, - "createDate": { - "type": "string" + "createDate" : { + "type" : "string" }, - "info": { - "$ref": "#/components/schemas/Info" + "info" : { + "$ref" : "#/components/schemas/Info" }, - "authRequest": { - "$ref": "#/components/schemas/AuthRequest" + "authRequest" : { + "$ref" : "#/components/schemas/AuthRequest" } } } }, - "securitySchemes": { - "ApiKey": { - "type": "apiKey", - "description": "The API key to access this function app.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" + "securitySchemes" : { + "ApiKey" : { + "type" : "apiKey", + "description" : "The API key to access this function app.", + "name" : "Ocp-Apim-Subscription-Key", + "in" : "header" } } } -} +} \ No newline at end of file diff --git a/openapi/openapi_ec.json b/openapi/openapi_ec.json index e79e42d4..c9215ed3 100644 --- a/openapi/openapi_ec.json +++ b/openapi/openapi_ec.json @@ -1,724 +1,661 @@ { - "openapi": "3.0.1", - "info": { - "title": "Biz-Events Service", - "description": "Microservice for exposing REST APIs about payment receipts.", - "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.1.48" + "openapi" : "3.0.1", + "info" : { + "title" : "Biz-Events Service", + "description" : "Microservice for exposing REST APIs about payment receipts.", + "termsOfService" : "https://www.pagopa.gov.it/", + "version" : "0.1.48" }, - "servers": [ - { - "url": "http://localhost", - "description": "Generated server url" - } - ], - "paths": { - "/organizations/{organizationfiscalcode}/receipts/{iur}": { - "get": { - "tags": [ - "Payment Receipts REST APIs" - ], - "summary": "The organization get the receipt for the creditor institution using IUR.", - "operationId": "getOrganizationReceiptIur", - "parameters": [ - { - "name": "organizationfiscalcode", - "in": "path", - "description": "The fiscal code of the Organization.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iur", - "in": "path", - "description": "The unique reference of the operation assigned to the payment (Payment Token).", - "required": true, - "schema": { - "type": "string" - } + "servers" : [ { + "url" : "http://localhost", + "description" : "Generated server url" + } ], + "paths" : { + "/organizations/{organizationfiscalcode}/receipts/{iur}" : { + "get" : { + "tags" : [ "Payment Receipts REST APIs" ], + "summary" : "The organization get the receipt for the creditor institution using IUR.", + "operationId" : "getOrganizationReceiptIur", + "parameters" : [ { + "name" : "organizationfiscalcode", + "in" : "path", + "description" : "The fiscal code of the Organization.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iur", + "in" : "path", + "description" : "The unique reference of the operation assigned to the payment (Payment Token).", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + } ], + "responses" : { + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "200": { - "description": "Obtained receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CtReceiptModelResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Obtained receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CtReceiptModelResponse" } } } }, - "404": { - "description": "Not found the receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/organizations/{organizationfiscalcode}/receipts/{iur}/paymentoptions/{iuv}": { - "get": { - "tags": [ - "Payment Receipts REST APIs" - ], - "summary": "The organization get the receipt for the creditor institution using IUV and IUR.", - "operationId": "getOrganizationReceiptIuvIur", - "parameters": [ - { - "name": "organizationfiscalcode", - "in": "path", - "description": "The fiscal code of the Organization.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iur", - "in": "path", - "description": "The unique reference of the operation assigned to the payment (Payment Token).", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iuv", - "in": "path", - "description": "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", - "required": true, - "schema": { - "type": "string" - } + "/organizations/{organizationfiscalcode}/receipts/{iur}/paymentoptions/{iuv}" : { + "get" : { + "tags" : [ "Payment Receipts REST APIs" ], + "summary" : "The organization get the receipt for the creditor institution using IUV and IUR.", + "operationId" : "getOrganizationReceiptIuvIur", + "parameters" : [ { + "name" : "organizationfiscalcode", + "in" : "path", + "description" : "The fiscal code of the Organization.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iur", + "in" : "path", + "description" : "The unique reference of the operation assigned to the payment (Payment Token).", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iuv", + "in" : "path", + "description" : "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + } ], + "responses" : { + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "200": { - "description": "Obtained receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CtReceiptModelResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Obtained receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CtReceiptModelResponse" } } } }, - "404": { - "description": "Not found the receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/info": { - "get": { - "tags": [ - "Home" - ], - "summary": "health check", - "description": "Return OK if application is started", - "operationId": "healthCheck", - "responses": { - "500": { - "description": "Service unavailable", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/info" : { + "get" : { + "tags" : [ "Home" ], + "summary" : "health check", + "description" : "Return OK if application is started", + "operationId" : "healthCheck", + "responses" : { + "401" : { + "description" : "Unauthorized", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "403" : { + "description" : "Forbidden", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "400": { - "description": "Bad Request", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "400" : { + "description" : "Bad Request", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" - } - } - } - }, - "403": { - "description": "Forbidden", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "200": { - "description": "OK", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "OK", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfo" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AppInfo" } } } }, - "429": { - "description": "Too many requests", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "401": { - "description": "Unauthorized", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] } }, - "components": { - "schemas": { - "ProblemJson": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" - }, - "status": { - "maximum": 600, - "minimum": 100, - "type": "integer", - "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format": "int32", - "example": 200 - }, - "detail": { - "type": "string", - "description": "A human readable explanation specific to this occurrence of the problem.", - "example": "There was an error processing the request" + "components" : { + "schemas" : { + "ProblemJson" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + }, + "status" : { + "maximum" : 600, + "minimum" : 100, + "type" : "integer", + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format" : "int32", + "example" : 200 + }, + "detail" : { + "type" : "string", + "description" : "A human readable explanation specific to this occurrence of the problem.", + "example" : "There was an error processing the request" } } }, - "CtReceiptModelResponse": { - "required": [ - "channelDescription", - "companyName", - "creditorReferenceId", - "debtor", - "description", - "fiscalCode", - "idChannel", - "idPSP", - "noticeNumber", - "outcome", - "paymentAmount", - "pspCompanyName", - "receiptId", - "transferList" - ], - "type": "object", - "properties": { - "receiptId": { - "type": "string" - }, - "noticeNumber": { - "type": "string" - }, - "fiscalCode": { - "type": "string" - }, - "outcome": { - "type": "string" - }, - "creditorReferenceId": { - "type": "string" - }, - "paymentAmount": { - "type": "number" - }, - "description": { - "type": "string" - }, - "companyName": { - "type": "string" - }, - "officeName": { - "type": "string" - }, - "debtor": { - "$ref": "#/components/schemas/Debtor" - }, - "transferList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransferPA" + "CtReceiptModelResponse" : { + "required" : [ "channelDescription", "companyName", "creditorReferenceId", "debtor", "description", "fiscalCode", "idChannel", "idPSP", "noticeNumber", "outcome", "paymentAmount", "pspCompanyName", "receiptId", "transferList" ], + "type" : "object", + "properties" : { + "receiptId" : { + "type" : "string" + }, + "noticeNumber" : { + "type" : "string" + }, + "fiscalCode" : { + "type" : "string" + }, + "outcome" : { + "type" : "string" + }, + "creditorReferenceId" : { + "type" : "string" + }, + "paymentAmount" : { + "type" : "number" + }, + "description" : { + "type" : "string" + }, + "companyName" : { + "type" : "string" + }, + "officeName" : { + "type" : "string" + }, + "debtor" : { + "$ref" : "#/components/schemas/Debtor" + }, + "transferList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TransferPA" } }, - "idPSP": { - "type": "string" + "idPSP" : { + "type" : "string" }, - "pspFiscalCode": { - "type": "string" + "pspFiscalCode" : { + "type" : "string" }, - "pspPartitaIVA": { - "type": "string" + "pspPartitaIVA" : { + "type" : "string" }, - "pspCompanyName": { - "type": "string" + "pspCompanyName" : { + "type" : "string" }, - "idChannel": { - "type": "string" + "idChannel" : { + "type" : "string" }, - "channelDescription": { - "type": "string" + "channelDescription" : { + "type" : "string" }, - "payer": { - "$ref": "#/components/schemas/Payer" + "payer" : { + "$ref" : "#/components/schemas/Payer" }, - "paymentMethod": { - "type": "string" + "paymentMethod" : { + "type" : "string" }, - "fee": { - "type": "number" + "fee" : { + "type" : "number" }, - "primaryCiIncurredFee": { - "type": "number" + "primaryCiIncurredFee" : { + "type" : "number" }, - "idBundle": { - "type": "string" + "idBundle" : { + "type" : "string" }, - "idCiBundle": { - "type": "string" + "idCiBundle" : { + "type" : "string" }, - "paymentDateTime": { - "type": "string", - "format": "date" + "paymentDateTime" : { + "type" : "string", + "format" : "date" }, - "applicationDate": { - "type": "string", - "format": "date" + "applicationDate" : { + "type" : "string", + "format" : "date" }, - "transferDate": { - "type": "string", - "format": "date" + "transferDate" : { + "type" : "string", + "format" : "date" }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } } } }, - "Debtor": { - "required": [ - "entityUniqueIdentifierType", - "entityUniqueIdentifierValue", - "fullName" - ], - "type": "object", - "properties": { - "entityUniqueIdentifierType": { - "type": "string", - "enum": [ - "F", - "G" - ] - }, - "entityUniqueIdentifierValue": { - "type": "string" - }, - "fullName": { - "type": "string" - }, - "streetName": { - "type": "string" - }, - "civicNumber": { - "type": "string" - }, - "postalCode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "stateProvinceRegion": { - "type": "string" - }, - "country": { - "type": "string" - }, - "email": { - "type": "string" + "Debtor" : { + "required" : [ "entityUniqueIdentifierType", "entityUniqueIdentifierValue", "fullName" ], + "type" : "object", + "properties" : { + "entityUniqueIdentifierType" : { + "type" : "string", + "enum" : [ "F", "G" ] + }, + "entityUniqueIdentifierValue" : { + "type" : "string" + }, + "fullName" : { + "type" : "string" + }, + "streetName" : { + "type" : "string" + }, + "civicNumber" : { + "type" : "string" + }, + "postalCode" : { + "type" : "string" + }, + "city" : { + "type" : "string" + }, + "stateProvinceRegion" : { + "type" : "string" + }, + "country" : { + "type" : "string" + }, + "eMail" : { + "type" : "string" } } }, - "MapEntry": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" + "MapEntry" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string" + }, + "value" : { + "type" : "string" } } }, - "Payer": { - "required": [ - "entityUniqueIdentifierType", - "entityUniqueIdentifierValue", - "fullName" - ], - "type": "object", - "properties": { - "entityUniqueIdentifierType": { - "type": "string", - "enum": [ - "F", - "G" - ] - }, - "entityUniqueIdentifierValue": { - "type": "string" - }, - "fullName": { - "type": "string" - }, - "streetName": { - "type": "string" - }, - "civicNumber": { - "type": "string" - }, - "postalCode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "stateProvinceRegion": { - "type": "string" - }, - "country": { - "type": "string" - }, - "email": { - "type": "string" + "Payer" : { + "required" : [ "entityUniqueIdentifierType", "entityUniqueIdentifierValue", "fullName" ], + "type" : "object", + "properties" : { + "entityUniqueIdentifierType" : { + "type" : "string", + "enum" : [ "F", "G" ] + }, + "entityUniqueIdentifierValue" : { + "type" : "string" + }, + "fullName" : { + "type" : "string" + }, + "streetName" : { + "type" : "string" + }, + "civicNumber" : { + "type" : "string" + }, + "postalCode" : { + "type" : "string" + }, + "city" : { + "type" : "string" + }, + "stateProvinceRegion" : { + "type" : "string" + }, + "country" : { + "type" : "string" + }, + "eMail" : { + "type" : "string" } } }, - "TransferPA": { - "required": [ - "fiscalCodePA", - "iban", - "mbdAttachment", - "remittanceInformation", - "transferAmount", - "transferCategory" - ], - "type": "object", - "properties": { - "idTransfer": { - "maximum": 5, - "minimum": 1, - "type": "integer", - "format": "int32" - }, - "transferAmount": { - "type": "number" - }, - "fiscalCodePA": { - "type": "string" - }, - "iban": { - "type": "string" - }, - "mbdAttachment": { - "type": "string" - }, - "remittanceInformation": { - "type": "string" - }, - "transferCategory": { - "type": "string" - }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "TransferPA" : { + "required" : [ "fiscalCodePA", "iban", "mbdAttachment", "remittanceInformation", "transferAmount", "transferCategory" ], + "type" : "object", + "properties" : { + "idTransfer" : { + "maximum" : 5, + "minimum" : 1, + "type" : "integer", + "format" : "int32" + }, + "transferAmount" : { + "type" : "number" + }, + "fiscalCodePA" : { + "type" : "string" + }, + "iban" : { + "type" : "string" + }, + "mbdAttachment" : { + "type" : "string" + }, + "remittanceInformation" : { + "type" : "string" + }, + "transferCategory" : { + "type" : "string" + }, + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } } } }, - "AppInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" + "AppInfo" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" }, - "version": { - "type": "string" + "version" : { + "type" : "string" }, - "environment": { - "type": "string" + "environment" : { + "type" : "string" } } } }, - "securitySchemes": { - "ApiKey": { - "type": "apiKey", - "description": "The API key to access this function app.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" + "securitySchemes" : { + "ApiKey" : { + "type" : "apiKey", + "description" : "The API key to access this function app.", + "name" : "Ocp-Apim-Subscription-Key", + "in" : "header" } } } -} +} \ No newline at end of file diff --git a/openapi/openapi_helpdesk.json b/openapi/openapi_helpdesk.json index 4f9d190c..5e2c4ccd 100644 --- a/openapi/openapi_helpdesk.json +++ b/openapi/openapi_helpdesk.json @@ -1,1046 +1,1006 @@ { - "openapi": "3.0.1", - "info": { - "title": "Biz-Events Service", - "description": "Microservice for exposing REST APIs about payment receipts.", - "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.1.48" + "openapi" : "3.0.1", + "info" : { + "title" : "Biz-Events Service", + "description" : "Microservice for exposing REST APIs about payment receipts.", + "termsOfService" : "https://www.pagopa.gov.it/", + "version" : "0.1.48" }, - "servers": [ - { - "url": "http://localhost", - "description": "Generated server url" - } - ], - "paths": { - "/info": { - "get": { - "tags": [ - "Home" - ], - "summary": "health check", - "description": "Return OK if application is started", - "operationId": "healthCheck", - "responses": { - "500": { - "description": "Service unavailable", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "servers" : [ { + "url" : "http://localhost", + "description" : "Generated server url" + } ], + "paths" : { + "/info" : { + "get" : { + "tags" : [ "Home" ], + "summary" : "health check", + "description" : "Return OK if application is started", + "operationId" : "healthCheck", + "responses" : { + "401" : { + "description" : "Unauthorized", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "403" : { + "description" : "Forbidden", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "400": { - "description": "Bad Request", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "400" : { + "description" : "Bad Request", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "403": { - "description": "Forbidden", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" - } - } - } - }, - "200": { - "description": "OK", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "OK", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfo" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AppInfo" } } } }, - "429": { - "description": "Too many requests", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "401": { - "description": "Unauthorized", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/events/{biz-event-id}": { - "get": { - "tags": [ - "Biz-Events Helpdesk" - ], - "summary": "Retrieve the biz-event given its id.", - "operationId": "getBizEvent", - "parameters": [ - { - "name": "biz-event-id", - "in": "path", - "description": "The id of the biz-event.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/events/{biz-event-id}" : { + "get" : { + "tags" : [ "Biz-Events Helpdesk" ], + "summary" : "Retrieve the biz-event given its id.", + "operationId" : "getBizEvent", + "parameters" : [ { + "name" : "biz-event-id", + "in" : "path", + "description" : "The id of the biz-event.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "404" : { + "description" : "Not found the biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "404": { - "description": "Not found the biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Obtained biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BizEvent" } } } }, - "200": { - "description": "Obtained biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BizEvent" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/events/organizations/{organization-fiscal-code}/iuvs/{iuv}": { - "get": { - "tags": [ - "Biz-Events Helpdesk" - ], - "summary": "Retrieve the biz-event given the organization fiscal code and IUV.", - "operationId": "getBizEventByOrganizationFiscalCodeAndIuv", - "parameters": [ - { - "name": "organization-fiscal-code", - "in": "path", - "description": "The fiscal code of the Organization.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "iuv", - "in": "path", - "description": "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/events/organizations/{organization-fiscal-code}/iuvs/{iuv}" : { + "get" : { + "tags" : [ "Biz-Events Helpdesk" ], + "summary" : "Retrieve the biz-event given the organization fiscal code and IUV.", + "operationId" : "getBizEventByOrganizationFiscalCodeAndIuv", + "parameters" : [ { + "name" : "organization-fiscal-code", + "in" : "path", + "description" : "The fiscal code of the Organization.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "iuv", + "in" : "path", + "description" : "The unique payment identification. Alphanumeric code that uniquely associates and identifies three key elements of a payment: reason, payer, amount", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "404" : { + "description" : "Not found the biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "404": { - "description": "Not found the biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unable to process the request.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "422": { - "description": "Unable to process the request.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Obtained biz-event.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BizEvent" } } } }, - "200": { - "description": "Obtained biz-event.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BizEvent" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] } }, - "components": { - "schemas": { - "ProblemJson": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" - }, - "status": { - "maximum": 600, - "minimum": 100, - "type": "integer", - "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format": "int32", - "example": 200 - }, - "detail": { - "type": "string", - "description": "A human readable explanation specific to this occurrence of the problem.", - "example": "There was an error processing the request" + "components" : { + "schemas" : { + "ProblemJson" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + }, + "status" : { + "maximum" : 600, + "minimum" : 100, + "type" : "integer", + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format" : "int32", + "example" : 200 + }, + "detail" : { + "type" : "string", + "description" : "A human readable explanation specific to this occurrence of the problem.", + "example" : "There was an error processing the request" } } }, - "AppInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" + "AppInfo" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" }, - "version": { - "type": "string" + "version" : { + "type" : "string" }, - "environment": { - "type": "string" + "environment" : { + "type" : "string" } } }, - "AuthRequest": { - "type": "object", - "properties": { - "authOutcome": { - "type": "string" + "AuthRequest" : { + "type" : "object", + "properties" : { + "authOutcome" : { + "type" : "string" }, - "guid": { - "type": "string" + "guid" : { + "type" : "string" }, - "correlationId": { - "type": "string" + "correlationId" : { + "type" : "string" }, - "error": { - "type": "string" + "error" : { + "type" : "string" }, - "auth_code": { - "type": "string" + "auth_code" : { + "type" : "string" } } }, - "BizEvent": { - "type": "object", - "properties": { - "id": { - "type": "string" + "BizEvent" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" }, - "version": { - "type": "string" + "version" : { + "type" : "string" }, - "idPaymentManager": { - "type": "string" + "idPaymentManager" : { + "type" : "string" }, - "complete": { - "type": "string" + "complete" : { + "type" : "string" }, - "receiptId": { - "type": "string" + "receiptId" : { + "type" : "string" }, - "missingInfo": { - "type": "array", - "items": { - "type": "string" + "missingInfo" : { + "type" : "array", + "items" : { + "type" : "string" } }, - "debtorPosition": { - "$ref": "#/components/schemas/DebtorPosition" + "debtorPosition" : { + "$ref" : "#/components/schemas/DebtorPosition" }, - "creditor": { - "$ref": "#/components/schemas/Creditor" + "creditor" : { + "$ref" : "#/components/schemas/Creditor" }, - "psp": { - "$ref": "#/components/schemas/Psp" + "psp" : { + "$ref" : "#/components/schemas/Psp" }, - "debtor": { - "$ref": "#/components/schemas/Debtor" + "debtor" : { + "$ref" : "#/components/schemas/Debtor" }, - "payer": { - "$ref": "#/components/schemas/Payer" + "payer" : { + "$ref" : "#/components/schemas/Payer" }, - "paymentInfo": { - "$ref": "#/components/schemas/PaymentInfo" + "paymentInfo" : { + "$ref" : "#/components/schemas/PaymentInfo" }, - "transferList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Transfer" + "transferList" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Transfer" } }, - "transactionDetails": { - "$ref": "#/components/schemas/TransactionDetails" - }, - "eventStatus": { - "type": "string", - "enum": [ - "NA", - "RETRY", - "FAILED", - "DONE", - "INGESTED" - ] - }, - "eventRetryEnrichmentCount": { - "type": "integer", - "format": "int32" + "transactionDetails" : { + "$ref" : "#/components/schemas/TransactionDetails" + }, + "eventStatus" : { + "type" : "string", + "enum" : [ "NA", "RETRY", "FAILED", "DONE", "INGESTED" ] + }, + "eventRetryEnrichmentCount" : { + "type" : "integer", + "format" : "int32" } } }, - "Creditor": { - "type": "object", - "properties": { - "idPA": { - "type": "string" + "Creditor" : { + "type" : "object", + "properties" : { + "idPA" : { + "type" : "string" }, - "idBrokerPA": { - "type": "string" + "idBrokerPA" : { + "type" : "string" }, - "idStation": { - "type": "string" + "idStation" : { + "type" : "string" }, - "companyName": { - "type": "string" + "companyName" : { + "type" : "string" }, - "officeName": { - "type": "string" + "officeName" : { + "type" : "string" } } }, - "Debtor": { - "type": "object", - "properties": { - "fullName": { - "type": "string" + "Debtor" : { + "type" : "object", + "properties" : { + "fullName" : { + "type" : "string" }, - "entityUniqueIdentifierType": { - "type": "string" + "entityUniqueIdentifierType" : { + "type" : "string" }, - "entityUniqueIdentifierValue": { - "type": "string" + "entityUniqueIdentifierValue" : { + "type" : "string" }, - "streetName": { - "type": "string" + "streetName" : { + "type" : "string" }, - "civicNumber": { - "type": "string" + "civicNumber" : { + "type" : "string" }, - "postalCode": { - "type": "string" + "postalCode" : { + "type" : "string" }, - "city": { - "type": "string" + "city" : { + "type" : "string" }, - "stateProvinceRegion": { - "type": "string" + "stateProvinceRegion" : { + "type" : "string" }, - "country": { - "type": "string" + "country" : { + "type" : "string" }, - "eMail": { - "type": "string" + "eMail" : { + "type" : "string" } } }, - "DebtorPosition": { - "type": "object", - "properties": { - "modelType": { - "type": "string" + "DebtorPosition" : { + "type" : "object", + "properties" : { + "modelType" : { + "type" : "string" }, - "noticeNumber": { - "type": "string" + "noticeNumber" : { + "type" : "string" }, - "iuv": { - "type": "string" + "iuv" : { + "type" : "string" }, - "iur": { - "type": "string" + "iur" : { + "type" : "string" } } }, - "Details": { - "type": "object", - "properties": { - "blurredNumber": { - "type": "string" + "Details" : { + "type" : "object", + "properties" : { + "blurredNumber" : { + "type" : "string" }, - "holder": { - "type": "string" + "holder" : { + "type" : "string" }, - "circuit": { - "type": "string" + "circuit" : { + "type" : "string" } } }, - "Info": { - "type": "object", - "properties": { - "type": { - "type": "string" + "Info" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string" }, - "blurredNumber": { - "type": "string" + "blurredNumber" : { + "type" : "string" }, - "holder": { - "type": "string" + "holder" : { + "type" : "string" }, - "expireMonth": { - "type": "string" + "expireMonth" : { + "type" : "string" }, - "expireYear": { - "type": "string" + "expireYear" : { + "type" : "string" }, - "brand": { - "type": "string" + "brand" : { + "type" : "string" }, - "issuerAbi": { - "type": "string" + "issuerAbi" : { + "type" : "string" }, - "issuerName": { - "type": "string" + "issuerName" : { + "type" : "string" }, - "label": { - "type": "string" + "label" : { + "type" : "string" } } }, - "InfoTransaction": { - "type": "object", - "properties": { - "brand": { - "type": "string" + "InfoTransaction" : { + "type" : "object", + "properties" : { + "brand" : { + "type" : "string" }, - "brandLogo": { - "type": "string" + "brandLogo" : { + "type" : "string" }, - "clientId": { - "type": "string" + "clientId" : { + "type" : "string" }, - "paymentMethodName": { - "type": "string" + "paymentMethodName" : { + "type" : "string" }, - "type": { - "type": "string" + "type" : { + "type" : "string" } } }, - "MBD": { - "type": "object", - "properties": { - "IUBD": { - "type": "string" + "MBD" : { + "type" : "object", + "properties" : { + "IUBD" : { + "type" : "string" }, - "oraAcquisto": { - "type": "string" + "oraAcquisto" : { + "type" : "string" }, - "importo": { - "type": "string" + "importo" : { + "type" : "string" }, - "tipoBollo": { - "type": "string" + "tipoBollo" : { + "type" : "string" }, - "MBDAttachment": { - "type": "string" + "MBDAttachment" : { + "type" : "string" } } }, - "MapEntry": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" + "MapEntry" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string" + }, + "value" : { + "type" : "string" } } }, - "Payer": { - "type": "object", - "properties": { - "fullName": { - "type": "string" + "Payer" : { + "type" : "object", + "properties" : { + "fullName" : { + "type" : "string" }, - "entityUniqueIdentifierType": { - "type": "string" + "entityUniqueIdentifierType" : { + "type" : "string" }, - "entityUniqueIdentifierValue": { - "type": "string" + "entityUniqueIdentifierValue" : { + "type" : "string" }, - "streetName": { - "type": "string" + "streetName" : { + "type" : "string" }, - "civicNumber": { - "type": "string" + "civicNumber" : { + "type" : "string" }, - "postalCode": { - "type": "string" + "postalCode" : { + "type" : "string" }, - "city": { - "type": "string" + "city" : { + "type" : "string" }, - "stateProvinceRegion": { - "type": "string" + "stateProvinceRegion" : { + "type" : "string" }, - "country": { - "type": "string" + "country" : { + "type" : "string" }, - "eMail": { - "type": "string" + "eMail" : { + "type" : "string" } } }, - "PaymentAuthorizationRequest": { - "type": "object", - "properties": { - "authOutcome": { - "type": "string" + "PaymentAuthorizationRequest" : { + "type" : "object", + "properties" : { + "authOutcome" : { + "type" : "string" }, - "requestId": { - "type": "string" + "requestId" : { + "type" : "string" }, - "correlationId": { - "type": "string" + "correlationId" : { + "type" : "string" }, - "authCode": { - "type": "string" + "authCode" : { + "type" : "string" }, - "paymentMethodType": { - "type": "string" + "paymentMethodType" : { + "type" : "string" }, - "details": { - "$ref": "#/components/schemas/Details" + "details" : { + "$ref" : "#/components/schemas/Details" } } }, - "PaymentInfo": { - "type": "object", - "properties": { - "paymentDateTime": { - "type": "string" + "PaymentInfo" : { + "type" : "object", + "properties" : { + "paymentDateTime" : { + "type" : "string" }, - "applicationDate": { - "type": "string" + "applicationDate" : { + "type" : "string" }, - "transferDate": { - "type": "string" + "transferDate" : { + "type" : "string" }, - "dueDate": { - "type": "string" + "dueDate" : { + "type" : "string" }, - "paymentToken": { - "type": "string" + "paymentToken" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "fee": { - "type": "string" + "fee" : { + "type" : "string" }, - "primaryCiIncurredFee": { - "type": "string" + "primaryCiIncurredFee" : { + "type" : "string" }, - "idBundle": { - "type": "string" + "idBundle" : { + "type" : "string" }, - "idCiBundle": { - "type": "string" + "idCiBundle" : { + "type" : "string" }, - "totalNotice": { - "type": "string" + "totalNotice" : { + "type" : "string" }, - "paymentMethod": { - "type": "string" + "paymentMethod" : { + "type" : "string" }, - "touchpoint": { - "type": "string" + "touchpoint" : { + "type" : "string" }, - "remittanceInformation": { - "type": "string" + "remittanceInformation" : { + "type" : "string" }, - "description": { - "type": "string" + "description" : { + "type" : "string" }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } }, - "IUR": { - "type": "string" + "IUR" : { + "type" : "string" } } }, - "Psp": { - "type": "object", - "properties": { - "idPsp": { - "type": "string" + "Psp" : { + "type" : "object", + "properties" : { + "idPsp" : { + "type" : "string" }, - "idBrokerPsp": { - "type": "string" + "idBrokerPsp" : { + "type" : "string" }, - "idChannel": { - "type": "string" + "idChannel" : { + "type" : "string" }, - "psp": { - "type": "string" + "psp" : { + "type" : "string" }, - "pspPartitaIVA": { - "type": "string" + "pspPartitaIVA" : { + "type" : "string" }, - "pspFiscalCode": { - "type": "string" + "pspFiscalCode" : { + "type" : "string" }, - "channelDescription": { - "type": "string" + "channelDescription" : { + "type" : "string" } } }, - "Transaction": { - "type": "object", - "properties": { - "idTransaction": { - "type": "string" + "Transaction" : { + "type" : "object", + "properties" : { + "idTransaction" : { + "type" : "string" }, - "transactionId": { - "type": "string" + "transactionId" : { + "type" : "string" }, - "grandTotal": { - "type": "integer", - "format": "int64" + "grandTotal" : { + "type" : "integer", + "format" : "int64" }, - "amount": { - "type": "integer", - "format": "int64" + "amount" : { + "type" : "integer", + "format" : "int64" }, - "fee": { - "type": "integer", - "format": "int64" + "fee" : { + "type" : "integer", + "format" : "int64" }, - "transactionStatus": { - "type": "string" + "transactionStatus" : { + "type" : "string" }, - "accountingStatus": { - "type": "string" + "accountingStatus" : { + "type" : "string" }, - "rrn": { - "type": "string" + "rrn" : { + "type" : "string" }, - "authorizationCode": { - "type": "string" + "authorizationCode" : { + "type" : "string" }, - "creationDate": { - "type": "string" + "creationDate" : { + "type" : "string" }, - "numAut": { - "type": "string" + "numAut" : { + "type" : "string" }, - "accountCode": { - "type": "string" + "accountCode" : { + "type" : "string" }, - "psp": { - "$ref": "#/components/schemas/TransactionPsp" + "psp" : { + "$ref" : "#/components/schemas/TransactionPsp" }, - "origin": { - "type": "string" + "origin" : { + "type" : "string" } } }, - "TransactionDetails": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/User" + "TransactionDetails" : { + "type" : "object", + "properties" : { + "user" : { + "$ref" : "#/components/schemas/User" }, - "paymentAuthorizationRequest": { - "$ref": "#/components/schemas/PaymentAuthorizationRequest" + "paymentAuthorizationRequest" : { + "$ref" : "#/components/schemas/PaymentAuthorizationRequest" }, - "wallet": { - "$ref": "#/components/schemas/WalletItem" + "wallet" : { + "$ref" : "#/components/schemas/WalletItem" }, - "origin": { - "type": "string" + "origin" : { + "type" : "string" }, - "transaction": { - "$ref": "#/components/schemas/Transaction" + "transaction" : { + "$ref" : "#/components/schemas/Transaction" }, - "info": { - "$ref": "#/components/schemas/InfoTransaction" + "info" : { + "$ref" : "#/components/schemas/InfoTransaction" } } }, - "TransactionPsp": { - "type": "object", - "properties": { - "idChannel": { - "type": "string" + "TransactionPsp" : { + "type" : "object", + "properties" : { + "idChannel" : { + "type" : "string" }, - "businessName": { - "type": "string" + "businessName" : { + "type" : "string" }, - "serviceName": { - "type": "string" + "serviceName" : { + "type" : "string" } } }, - "Transfer": { - "type": "object", - "properties": { - "idTransfer": { - "type": "string" + "Transfer" : { + "type" : "object", + "properties" : { + "idTransfer" : { + "type" : "string" }, - "fiscalCodePA": { - "type": "string" + "fiscalCodePA" : { + "type" : "string" }, - "companyName": { - "type": "string" + "companyName" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "transferCategory": { - "type": "string" + "transferCategory" : { + "type" : "string" }, - "remittanceInformation": { - "type": "string" + "remittanceInformation" : { + "type" : "string" }, - "metadata": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MapEntry" + "metadata" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MapEntry" } }, - "IBAN": { - "type": "string" + "IBAN" : { + "type" : "string" }, - "MBD": { - "$ref": "#/components/schemas/MBD" + "MBD" : { + "$ref" : "#/components/schemas/MBD" } } }, - "User": { - "type": "object", - "properties": { - "fullName": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "F", - "G", - "GUEST", - "REGISTERED" - ] - }, - "fiscalCode": { - "type": "string" - }, - "notificationEmail": { - "type": "string" - }, - "userId": { - "type": "string" - }, - "userStatus": { - "type": "string" - }, - "userStatusDescription": { - "type": "string" + "User" : { + "type" : "object", + "properties" : { + "fullName" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "enum" : [ "F", "G", "GUEST", "REGISTERED" ] + }, + "fiscalCode" : { + "type" : "string" + }, + "notificationEmail" : { + "type" : "string" + }, + "userId" : { + "type" : "string" + }, + "userStatus" : { + "type" : "string" + }, + "userStatusDescription" : { + "type" : "string" } } }, - "WalletItem": { - "type": "object", - "properties": { - "idWallet": { - "type": "string" - }, - "walletType": { - "type": "string", - "enum": [ - "CARD", - "PAYPAL", - "BANCOMATPAY" - ] - }, - "enableableFunctions": { - "type": "array", - "items": { - "type": "string" + "WalletItem" : { + "type" : "object", + "properties" : { + "idWallet" : { + "type" : "string" + }, + "walletType" : { + "type" : "string", + "enum" : [ "CARD", "PAYPAL", "BANCOMATPAY" ] + }, + "enableableFunctions" : { + "type" : "array", + "items" : { + "type" : "string" } }, - "pagoPa": { - "type": "boolean" + "pagoPa" : { + "type" : "boolean" }, - "onboardingChannel": { - "type": "string" + "onboardingChannel" : { + "type" : "string" }, - "favourite": { - "type": "boolean" + "favourite" : { + "type" : "boolean" }, - "createDate": { - "type": "string" + "createDate" : { + "type" : "string" }, - "info": { - "$ref": "#/components/schemas/Info" + "info" : { + "$ref" : "#/components/schemas/Info" }, - "authRequest": { - "$ref": "#/components/schemas/AuthRequest" + "authRequest" : { + "$ref" : "#/components/schemas/AuthRequest" } } } }, - "securitySchemes": { - "ApiKey": { - "type": "apiKey", - "description": "The API key to access this function app.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" + "securitySchemes" : { + "ApiKey" : { + "type" : "apiKey", + "description" : "The API key to access this function app.", + "name" : "Ocp-Apim-Subscription-Key", + "in" : "header" } } } -} +} \ No newline at end of file diff --git a/openapi/openapi_io.json b/openapi/openapi_io.json index a3000094..ca1e6077 100644 --- a/openapi/openapi_io.json +++ b/openapi/openapi_io.json @@ -1,1119 +1,1025 @@ { - "openapi": "3.0.1", - "info": { - "title": "Biz-Events Service", - "description": "Microservice for exposing REST APIs about payment receipts.", - "termsOfService": "https://www.pagopa.gov.it/", - "version": "0.1.48" + "openapi" : "3.0.1", + "info" : { + "title" : "Biz-Events Service", + "description" : "Microservice for exposing REST APIs about payment receipts.", + "termsOfService" : "https://www.pagopa.gov.it/", + "version" : "0.1.48" }, - "servers": [ - { - "url": "http://localhost", - "description": "Generated server url" - } - ], - "paths": { - "/transactions/{transaction-id}/disable": { - "post": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Disable the transaction details given its id.", - "operationId": "disableTransaction", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "transaction-id", - "in": "path", - "description": "The id of the transaction.", - "required": true, - "schema": { - "type": "string" - } + "servers" : [ { + "url" : "http://localhost", + "description" : "Generated server url" + } ], + "paths" : { + "/transactions/{transaction-id}/disable" : { + "post" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Disable the transaction details given its id.", + "description" : "This service is deprecated. Use Paid Notice APIs instead", + "operationId" : "disableTransaction", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "description": "Disabled Transactions.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, { + "name" : "transaction-id", + "in" : "path", + "description" : "The id of the transaction.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": {} + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" + } + } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Disabled Transactions.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" - } - } + "content" : { + "application/json" : { } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "deprecated" : true, + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the paged transaction list from biz events.", - "operationId": "getTransactionList", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "is_payer", - "in": "query", - "description": "Filter by payer", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "is_debtor", - "in": "query", - "description": "Filter by debtor", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "x-continuation-token", - "in": "header", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "orderby", - "in": "query", - "description": "Order by TRANSACTION_DATE", - "required": false, - "schema": { - "type": "string", - "default": "TRANSACTION_DATE", - "enum": [ - "TRANSACTION_DATE" - ] - } - }, - { - "name": "ordering", - "in": "query", - "description": "Direction of ordering", - "required": false, - "schema": { - "type": "string", - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ] - } + "/transactions" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the paged transaction list from biz events.", + "operationId" : "getTransactionList", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "is_payer", + "in" : "query", + "description" : "Filter by payer", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "is_debtor", + "in" : "query", + "description" : "Filter by debtor", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "x-continuation-token", + "in" : "header", + "required" : false, + "schema" : { + "type" : "string" } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, { + "name" : "size", + "in" : "query", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "orderby", + "in" : "query", + "description" : "Order by TRANSACTION_DATE", + "required" : false, + "schema" : { + "type" : "string", + "default" : "TRANSACTION_DATE", + "enum" : [ "TRANSACTION_DATE" ] + } + }, { + "name" : "ordering", + "in" : "query", + "description" : "Direction of ordering", + "required" : false, + "schema" : { + "type" : "string", + "default" : "DESC", + "enum" : [ "ASC", "DESC" ] + } + } ], + "responses" : { + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "200": { - "description": "Obtained transaction list.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" - } - }, - "x-continuation-token": { - "description": "continuation token for paginated query", - "style": "simple", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionListWrapResponse" + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Obtained transaction list.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + }, + "x-continuation-token" : { + "description" : "continuation token for paginated query", + "style" : "simple", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionListWrapResponse" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/{transaction-id}": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the transaction details given its id.", - "operationId": "getTransactionDetails", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "transaction-id", - "in": "path", - "description": "The id of the transaction.", - "required": true, - "schema": { - "type": "string" - } + "/transactions/{transaction-id}" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the transaction details given its id.", + "operationId" : "getTransactionDetails", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "transaction-id", + "in" : "path", + "description" : "The id of the transaction.", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + } ], + "responses" : { + "200" : { + "description" : "Obtained transaction details.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionDetailResponse" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "200": { - "description": "Obtained transaction details.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionDetailResponse" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/{event-id}/pdf": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the PDF receipt given event id.", - "operationId": "getPDFReceipt", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "event-id", - "in": "path", - "description": "The id of the event.", - "required": true, - "schema": { - "type": "string" - } + "/transactions/{event-id}/pdf" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the PDF receipt given event id.", + "operationId" : "getPDFReceipt", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "404": { - "description": "Not found the receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, { + "name" : "event-id", + "in" : "path", + "description" : "The id of the event.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Obtained the PDF receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/pdf" : { + "schema" : { + "type" : "string", + "format" : "binary" } } } }, - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "200": { - "description": "Obtained the PDF receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "422" : { + "description" : "Unprocessable receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/pdf": { - "schema": { - "type": "string", - "format": "binary" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "422": { - "description": "Unprocessable receipt.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "404" : { + "description" : "Not found the receipt.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/transactions/cached": { - "get": { - "tags": [ - "IO Transactions REST APIs" - ], - "summary": "Retrieve the paged transaction list from biz events.", - "operationId": "getTransactionList_1", - "parameters": [ - { - "name": "x-fiscal-code", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "is_payer", - "in": "query", - "description": "Filter by payer", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "is_debtor", - "in": "query", - "description": "Filter by debtor", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "name": "page", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "size", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "orderby", - "in": "query", - "description": "Order by TRANSACTION_DATE", - "required": false, - "schema": { - "type": "string", - "default": "TRANSACTION_DATE", - "enum": [ - "TRANSACTION_DATE" - ] - } - }, - { - "name": "ordering", - "in": "query", - "description": "Direction of ordering", - "required": false, - "schema": { - "type": "string", - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ] - } + "/transactions/cached" : { + "get" : { + "tags" : [ "IO Transactions REST APIs" ], + "summary" : "Retrieve the paged transaction list from biz events.", + "operationId" : "getTransactionList_1", + "parameters" : [ { + "name" : "x-fiscal-code", + "in" : "header", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "is_payer", + "in" : "query", + "description" : "Filter by payer", + "required" : false, + "schema" : { + "type" : "boolean" } - ], - "responses": { - "429": { - "description": "Too many requests.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, { + "name" : "is_debtor", + "in" : "query", + "description" : "Filter by debtor", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "page", + "in" : "query", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 0 + } + }, { + "name" : "size", + "in" : "query", + "required" : false, + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + }, { + "name" : "orderby", + "in" : "query", + "description" : "Order by TRANSACTION_DATE", + "required" : false, + "schema" : { + "type" : "string", + "default" : "TRANSACTION_DATE", + "enum" : [ "TRANSACTION_DATE" ] + } + }, { + "name" : "ordering", + "in" : "query", + "description" : "Direction of ordering", + "required" : false, + "schema" : { + "type" : "string", + "default" : "DESC", + "enum" : [ "ASC", "DESC" ] + } + } ], + "responses" : { + "404" : { + "description" : "Not found the transaction.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - } - }, - "200": { - "description": "Obtained transaction list.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionListWrapResponse" + } + }, + "429" : { + "description" : "Too many requests.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "401": { - "description": "Wrong or missing function key.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "401" : { + "description" : "Wrong or missing function key.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "500": { - "description": "Service unavailable.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "Obtained transaction list.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionListWrapResponse" } } } }, - "404": { - "description": "Not found the transaction.", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable.", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] }, - "/info": { - "get": { - "tags": [ - "Home" - ], - "summary": "health check", - "description": "Return OK if application is started", - "operationId": "healthCheck", - "responses": { - "500": { - "description": "Service unavailable", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "/info" : { + "get" : { + "tags" : [ "Home" ], + "summary" : "health check", + "description" : "Return OK if application is started", + "operationId" : "healthCheck", + "responses" : { + "401" : { + "description" : "Unauthorized", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" + } + }, + "403" : { + "description" : "Forbidden", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "400": { - "description": "Bad Request", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "400" : { + "description" : "Bad Request", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemJson" - } - } - } - }, - "403": { - "description": "Forbidden", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } }, - "200": { - "description": "OK", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "200" : { + "description" : "OK", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfo" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AppInfo" } } } }, - "429": { - "description": "Too many requests", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "429" : { + "description" : "Too many requests", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" } } } }, - "401": { - "description": "Unauthorized", - "headers": { - "X-Request-Id": { - "description": "This header identifies the call", - "schema": { - "type": "string" + "500" : { + "description" : "Service unavailable", + "headers" : { + "X-Request-Id" : { + "description" : "This header identifies the call", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemJson" } } } } }, - "security": [ - { - "ApiKey": [] - } - ] + "security" : [ { + "ApiKey" : [ ] + } ] }, - "parameters": [ - { - "name": "X-Request-Id", - "in": "header", - "description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", - "required": false, - "schema": { - "type": "string" - } + "parameters" : [ { + "name" : "X-Request-Id", + "in" : "header", + "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.", + "required" : false, + "schema" : { + "type" : "string" } - ] + } ] } }, - "components": { - "schemas": { - "ProblemJson": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" - }, - "status": { - "maximum": 600, - "minimum": 100, - "type": "integer", - "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", - "format": "int32", - "example": 200 - }, - "detail": { - "type": "string", - "description": "A human readable explanation specific to this occurrence of the problem.", - "example": "There was an error processing the request" + "components" : { + "schemas" : { + "ProblemJson" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable" + }, + "status" : { + "maximum" : 600, + "minimum" : 100, + "type" : "integer", + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.", + "format" : "int32", + "example" : 200 + }, + "detail" : { + "type" : "string", + "description" : "A human readable explanation specific to this occurrence of the problem.", + "example" : "There was an error processing the request" } } }, - "PageInfo": { - "required": [ - "items_found", - "limit", - "page", - "total_pages" - ], - "type": "object", - "properties": { - "page": { - "type": "integer", - "description": "Page number", - "format": "int32" - }, - "limit": { - "type": "integer", - "description": "Required number of items per page", - "format": "int32" - }, - "items_found": { - "type": "integer", - "description": "Number of items found. (The last page may have fewer elements than required)", - "format": "int32" - }, - "total_pages": { - "type": "integer", - "description": "Total number of pages", - "format": "int32" + "PageInfo" : { + "required" : [ "items_found", "limit", "page", "total_pages" ], + "type" : "object", + "properties" : { + "page" : { + "type" : "integer", + "description" : "Page number", + "format" : "int32" + }, + "limit" : { + "type" : "integer", + "description" : "Required number of items per page", + "format" : "int32" + }, + "items_found" : { + "type" : "integer", + "description" : "Number of items found. (The last page may have fewer elements than required)", + "format" : "int32" + }, + "total_pages" : { + "type" : "integer", + "description" : "Total number of pages", + "format" : "int32" } } }, - "TransactionListItem": { - "type": "object", - "properties": { - "transactionId": { - "type": "string" + "TransactionListItem" : { + "type" : "object", + "properties" : { + "transactionId" : { + "type" : "string" }, - "payeeName": { - "type": "string" + "payeeName" : { + "type" : "string" }, - "payeeTaxCode": { - "type": "string" + "payeeTaxCode" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "transactionDate": { - "type": "string" + "transactionDate" : { + "type" : "string" }, - "isCart": { - "type": "boolean" + "isCart" : { + "type" : "boolean" }, - "isPayer": { - "type": "boolean" + "isPayer" : { + "type" : "boolean" }, - "isDebtor": { - "type": "boolean" + "isDebtor" : { + "type" : "boolean" } } }, - "TransactionListWrapResponse": { - "type": "object", - "properties": { - "transactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TransactionListItem" + "TransactionListWrapResponse" : { + "type" : "object", + "properties" : { + "transactions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TransactionListItem" } }, - "page_info": { - "$ref": "#/components/schemas/PageInfo" + "page_info" : { + "$ref" : "#/components/schemas/PageInfo" } } }, - "CartItem": { - "type": "object", - "properties": { - "subject": { - "type": "string" + "CartItem" : { + "type" : "object", + "properties" : { + "subject" : { + "type" : "string" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "payee": { - "$ref": "#/components/schemas/UserDetail" + "payee" : { + "$ref" : "#/components/schemas/UserDetail" }, - "debtor": { - "$ref": "#/components/schemas/UserDetail" + "debtor" : { + "$ref" : "#/components/schemas/UserDetail" }, - "refNumberValue": { - "type": "string" + "refNumberValue" : { + "type" : "string" }, - "refNumberType": { - "type": "string" + "refNumberType" : { + "type" : "string" } } }, - "InfoTransactionView": { - "type": "object", - "properties": { - "transactionId": { - "type": "string" + "InfoTransactionView" : { + "type" : "object", + "properties" : { + "transactionId" : { + "type" : "string" }, - "authCode": { - "type": "string" + "authCode" : { + "type" : "string" }, - "rrn": { - "type": "string" + "rrn" : { + "type" : "string" }, - "transactionDate": { - "type": "string" + "transactionDate" : { + "type" : "string" }, - "pspName": { - "type": "string" + "pspName" : { + "type" : "string" }, - "walletInfo": { - "$ref": "#/components/schemas/WalletInfo" + "walletInfo" : { + "$ref" : "#/components/schemas/WalletInfo" }, - "paymentMethod": { - "type": "string", - "enum": [ - "BBT", - "BP", - "AD", - "CP", - "PO", - "OBEP", - "JIF", - "MYBK", - "PPAL", - "UNKNOWN" - ] + "paymentMethod" : { + "type" : "string", + "enum" : [ "BBT", "BP", "AD", "CP", "PO", "OBEP", "JIF", "MYBK", "PPAL", "UNKNOWN" ] }, - "payer": { - "$ref": "#/components/schemas/UserDetail" + "payer" : { + "$ref" : "#/components/schemas/UserDetail" }, - "amount": { - "type": "string" + "amount" : { + "type" : "string" }, - "fee": { - "type": "string" + "fee" : { + "type" : "string" }, - "origin": { - "type": "string", - "enum": [ - "INTERNAL", - "PM", - "NDP001PROD", - "NDP002PROD", - "NDP003PROD", - "UNKNOWN" - ] + "origin" : { + "type" : "string", + "enum" : [ "INTERNAL", "PM", "NDP001PROD", "NDP002PROD", "NDP003PROD", "UNKNOWN" ] } } }, - "TransactionDetailResponse": { - "type": "object", - "properties": { - "infoTransaction": { - "$ref": "#/components/schemas/InfoTransactionView" - }, - "carts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartItem" + "TransactionDetailResponse" : { + "type" : "object", + "properties" : { + "infoTransaction" : { + "$ref" : "#/components/schemas/InfoTransactionView" + }, + "carts" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CartItem" } } } }, - "UserDetail": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "taxCode": { - "type": "string" + "UserDetail" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "taxCode" : { + "type" : "string" } } }, - "WalletInfo": { - "type": "object", - "properties": { - "accountHolder": { - "type": "string" + "WalletInfo" : { + "type" : "object", + "properties" : { + "accountHolder" : { + "type" : "string" }, - "brand": { - "type": "string" + "brand" : { + "type" : "string" }, - "blurredNumber": { - "type": "string" + "blurredNumber" : { + "type" : "string" }, - "maskedEmail": { - "type": "string" + "maskedEmail" : { + "type" : "string" } } }, - "AppInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" + "AppInfo" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" }, - "version": { - "type": "string" + "version" : { + "type" : "string" }, - "environment": { - "type": "string" + "environment" : { + "type" : "string" } } } }, - "securitySchemes": { - "ApiKey": { - "type": "apiKey", - "description": "The API key to access this function app.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" + "securitySchemes" : { + "ApiKey" : { + "type" : "apiKey", + "description" : "The API key to access this function app.", + "name" : "Ocp-Apim-Subscription-Key", + "in" : "header" } } } -} +} \ No newline at end of file diff --git a/src/main/java/it/gov/pagopa/bizeventsservice/controller/IPaidNoticeController.java b/src/main/java/it/gov/pagopa/bizeventsservice/controller/IPaidNoticeController.java new file mode 100644 index 00000000..a515b865 --- /dev/null +++ b/src/main/java/it/gov/pagopa/bizeventsservice/controller/IPaidNoticeController.java @@ -0,0 +1,41 @@ +package it.gov.pagopa.bizeventsservice.controller; + +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.responses.ApiResponses; +import io.swagger.v3.oas.annotations.security.SecurityRequirement; +import io.swagger.v3.oas.annotations.tags.Tag; +import it.gov.pagopa.bizeventsservice.model.ProblemJson; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.*; + +import javax.validation.constraints.NotBlank; + + +@Tag(name = "Paid Notice REST APIs") +@RequestMapping("/paids") +@Validated +public interface IPaidNoticeController { + String X_FISCAL_CODE = "x-fiscal-code"; + + @Operation(summary = "Disable the paid notice details given its id.", security = { + @SecurityRequirement(name = "ApiKey")}, operationId = "disablePaidNotice") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "Event Disabled.", + content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE)), + @ApiResponse(responseCode = "401", description = "Wrong or missing function key.", content = @Content(schema = @Schema())), + @ApiResponse(responseCode = "404", description = "Not found the paid event.", content = @Content(schema = @Schema(implementation = ProblemJson.class))), + @ApiResponse(responseCode = "429", description = "Too many requests.", content = @Content(schema = @Schema())), + @ApiResponse(responseCode = "500", description = "Service unavailable.", content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = ProblemJson.class)))}) + @PostMapping(value = "/{event-id}/disable", produces = MediaType.APPLICATION_JSON_VALUE) + ResponseEntity disablePaidNotice( + @RequestHeader(X_FISCAL_CODE) @NotBlank String fiscalCode, + @Parameter(description = "The id of the paid event.", required = true) @NotBlank @PathVariable("event-id") String eventId); + + +} diff --git a/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java b/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java index a3617e77..7af3ee0f 100644 --- a/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java +++ b/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java @@ -54,7 +54,7 @@ public interface ITransactionController { @GetMapping @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Obtained transaction list.", - headers = @Header(name = X_CONTINUATION_TOKEN, description = "continuation token for paginated query", schema = @Schema(type="string")), + headers = @Header(name = X_CONTINUATION_TOKEN, description = "continuation token for paginated query", schema = @Schema(type = "string")), content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(name = "TransactionListWrapResponse", implementation = TransactionListWrapResponse.class))), @ApiResponse(responseCode = "401", description = "Wrong or missing function key.", content = @Content(schema = @Schema())), @ApiResponse(responseCode = "404", description = "Not found the transaction.", content = @Content(schema = @Schema(implementation = ProblemJson.class))), @@ -71,17 +71,17 @@ ResponseEntity getTransactionList( @RequestParam(required = false, name = "orderby", defaultValue = "TRANSACTION_DATE") @Parameter(description = "Order by TRANSACTION_DATE") Order.TransactionListOrder orderBy, @RequestParam(required = false, name = "ordering", defaultValue = "DESC") @Parameter(description = "Direction of ordering") Sort.Direction ordering); - + /** * recovers biz-event data for the transaction list * - * @param fiscalCode tokenized user fiscal code - * @param isPayer optional flag defining the filter to select only the notices where the user is the payer - * @param isDebtor optional flag defining the filter to select only the notices where the user is the debtor - * @param page optional parameter defining page number, default to 0 (first page) - * @param size optional parameter defining page size, defaults to 10 - * @param orderBy optional parameter defining the sort field for the returned list, defaults to TRANSACTION_DATE - * @param ordering optional parameter defining the sorting direction of the returned list, defaults to DESC + * @param fiscalCode tokenized user fiscal code + * @param isPayer optional flag defining the filter to select only the notices where the user is the payer + * @param isDebtor optional flag defining the filter to select only the notices where the user is the debtor + * @param page optional parameter defining page number, default to 0 (first page) + * @param size optional parameter defining page size, defaults to 10 + * @param orderBy optional parameter defining the sort field for the returned list, defaults to TRANSACTION_DATE + * @param ordering optional parameter defining the sorting direction of the returned list, defaults to DESC * @return the transaction list */ @GetMapping(value = "/cached", produces = MediaType.APPLICATION_JSON_VALUE) @@ -117,7 +117,13 @@ ResponseEntity getTransactionDetails( @RequestHeader("x-fiscal-code") @NotBlank String fiscalCode, @Parameter(description = "The id of the transaction.", required = true) @NotBlank @PathVariable("transaction-id") String transactionId); - @Operation(summary = "Disable the transaction details given its id.", security = { + /** + * @param fiscalCode + * @param transactionId + * @return + * @deprecated + */ + @Operation(summary = "Disable the transaction details given its id.", description = "This service is deprecated. Use Paid Notice APIs instead", deprecated = true, security = { @SecurityRequirement(name = "ApiKey")}, operationId = "disableTransaction") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Disabled Transactions.", @@ -127,14 +133,15 @@ ResponseEntity getTransactionDetails( @ApiResponse(responseCode = "429", description = "Too many requests.", content = @Content(schema = @Schema())), @ApiResponse(responseCode = "500", description = "Service unavailable.", content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = ProblemJson.class)))}) @PostMapping(value = "/{transaction-id}/disable", produces = MediaType.APPLICATION_JSON_VALUE) + @Deprecated(forRemoval = false) ResponseEntity disableTransaction( @RequestHeader("x-fiscal-code") @NotBlank String fiscalCode, @Parameter(description = "The id of the transaction.", required = true) @NotBlank @PathVariable("transaction-id") String transactionId); - + @Operation(summary = "Retrieve the PDF receipt given event id.", security = { @SecurityRequirement(name = "ApiKey")}, operationId = "getPDFReceipt") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "Obtained the PDF receipt.", content = @Content(mediaType = MediaType.APPLICATION_PDF_VALUE, schema = @Schema( type = "string", format = "binary"))), + @ApiResponse(responseCode = "200", description = "Obtained the PDF receipt.", content = @Content(mediaType = MediaType.APPLICATION_PDF_VALUE, schema = @Schema(type = "string", format = "binary"))), @ApiResponse(responseCode = "401", description = "Wrong or missing function key.", content = @Content(schema = @Schema())), @ApiResponse(responseCode = "404", description = "Not found the receipt.", content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = ProblemJson.class))), @ApiResponse(responseCode = "422", description = "Unprocessable receipt.", content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = ProblemJson.class))), @@ -142,7 +149,7 @@ ResponseEntity disableTransaction( @ApiResponse(responseCode = "500", description = "Service unavailable.", content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE, schema = @Schema(implementation = ProblemJson.class)))}) @GetMapping(value = "/{event-id}/pdf") ResponseEntity getPDFReceipt( - @RequestHeader("x-fiscal-code") @NotBlank String fiscalCode, + @RequestHeader("x-fiscal-code") @NotBlank String fiscalCode, @Parameter(description = "The id of the event.", required = true) @NotBlank @PathVariable("event-id") String eventId); } diff --git a/src/main/java/it/gov/pagopa/bizeventsservice/controller/impl/PaidNoticeController.java b/src/main/java/it/gov/pagopa/bizeventsservice/controller/impl/PaidNoticeController.java new file mode 100644 index 00000000..beb5cb5a --- /dev/null +++ b/src/main/java/it/gov/pagopa/bizeventsservice/controller/impl/PaidNoticeController.java @@ -0,0 +1,32 @@ +package it.gov.pagopa.bizeventsservice.controller.impl; + +import it.gov.pagopa.bizeventsservice.controller.IPaidNoticeController; +import it.gov.pagopa.bizeventsservice.service.ITransactionService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.RestController; + +/** + * Implementation of {@link IPaidNoticeController} that contains the Rest Controller + * for events services + */ +@RestController +public class PaidNoticeController implements IPaidNoticeController { + + private final ITransactionService transactionService; + + @Autowired + public PaidNoticeController(ITransactionService transactionService) { + this.transactionService = transactionService; + } + + + @Override + public ResponseEntity disablePaidNotice(String fiscalCode, String transactionId) { + transactionService.disableTransaction(fiscalCode, transactionId); + return new ResponseEntity<>(HttpStatus.OK); + } + + +} diff --git a/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java b/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java new file mode 100644 index 00000000..0ce2786b --- /dev/null +++ b/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java @@ -0,0 +1,95 @@ +package it.gov.pagopa.bizeventsservice.controller; + + +import it.gov.pagopa.bizeventsservice.client.IReceiptGeneratePDFClient; +import it.gov.pagopa.bizeventsservice.client.IReceiptGetPDFClient; +import it.gov.pagopa.bizeventsservice.exception.AppError; +import it.gov.pagopa.bizeventsservice.exception.AppException; +import it.gov.pagopa.bizeventsservice.model.response.Attachment; +import it.gov.pagopa.bizeventsservice.model.response.AttachmentsDetailsResponse; +import it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse; +import it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem; +import it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListResponse; +import it.gov.pagopa.bizeventsservice.service.IBizEventsService; +import it.gov.pagopa.bizeventsservice.service.ITransactionService; +import it.gov.pagopa.bizeventsservice.util.Utility; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; + +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@SpringBootTest +@AutoConfigureMockMvc +public class PaidNoticeControllerTest { + + public static final String INVALID_FISCAL_CODE = "INVALID_TX_FISCAL_CODE"; + public static final String VALID_FISCAL_CODE = "AAAAAA00A00A000A"; + public static final String FISCAL_CODE_HEADER_KEY = "x-fiscal-code"; + public static final String PAIDS_EVENT_ID_DISABLE_PATH = "/paids/1234321234/disable"; + + @Autowired + private MockMvc mvc; + + @MockBean + private ITransactionService transactionService; + + + private byte[] receipt = {69, 121, 101, 45, 62, 118, 101, 114, (byte) 196, (byte) 195, 61, 101, 98}; + + @BeforeEach + void setUp() throws IOException { + // precondition + List transactionListItems = Utility.readModelFromFile("biz-events/getTransactionList.json", List.class); + TransactionListResponse transactionListResponse = TransactionListResponse.builder().transactionList(transactionListItems).build(); + TransactionDetailResponse transactionDetailResponse = Utility.readModelFromFile("biz-events/transactionDetails.json", TransactionDetailResponse.class); + when(transactionService.getTransactionList(eq(VALID_FISCAL_CODE), any(), any(), anyString(), anyInt(), any(), any())).thenReturn(transactionListResponse); + when(transactionService.getCachedTransactionList(eq(VALID_FISCAL_CODE), any(), any(), anyInt(), anyInt(), any(), any())).thenReturn(transactionListResponse); + when(transactionService.getTransactionDetails(anyString(), anyString())).thenReturn(transactionDetailResponse); + when(transactionService.getPDFReceipt(anyString(), anyString())).thenReturn(receipt); + } + + @Test + void getTransactionDisableShouldReturnOK() throws Exception { + mvc.perform(post(PAIDS_EVENT_ID_DISABLE_PATH) + .header(FISCAL_CODE_HEADER_KEY, VALID_FISCAL_CODE) + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andReturn(); + verify(transactionService).disableTransaction(any(), any()); + } + + @Test + void getTransactionDisableWithMissingFiscalCodeShouldReturnError() throws Exception { + mvc.perform(post(PAIDS_EVENT_ID_DISABLE_PATH) + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isBadRequest()) + .andReturn(); + } + + @Test + void getTransactionDisableithInvalidFiscalCodeShouldReturnError() throws Exception { + doAnswer(x -> { + throw new AppException(AppError.INVALID_FISCAL_CODE, INVALID_FISCAL_CODE); + }).when(transactionService).disableTransaction(anyString(), anyString()); + mvc.perform(post(PAIDS_EVENT_ID_DISABLE_PATH) + .header(FISCAL_CODE_HEADER_KEY, INVALID_FISCAL_CODE) + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isBadRequest()) + .andReturn(); + } + +} diff --git a/src/test/resources/receipts/getOrganizationReceipt.json b/src/test/resources/receipts/getOrganizationReceipt.json index 7228e228..a5f2f6ef 100644 --- a/src/test/resources/receipts/getOrganizationReceipt.json +++ b/src/test/resources/receipts/getOrganizationReceipt.json @@ -18,7 +18,7 @@ "city": null, "stateProvinceRegion": null, "country": null, - "email": null + "eMail": null }, "transferList": [ { From e0a21e33b60616366675a17cc15e81f5094d9c55 Mon Sep 17 00:00:00 2001 From: Jacopo Carlini Date: Tue, 3 Sep 2024 15:57:47 +0200 Subject: [PATCH 2/4] small changes openapi --- openapi/openapi.json | 2 +- openapi/openapi_io.json | 2 +- .../bizeventsservice/controller/ITransactionController.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/openapi/openapi.json b/openapi/openapi.json index a0bea9e9..44b0111e 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -1329,7 +1329,7 @@ "post" : { "tags" : [ "IO Transactions REST APIs" ], "summary" : "Disable the transaction details given its id.", - "description" : "This service is deprecated. Use Paid Notice APIs instead", + "description" : "This operation is deprecated. Use Paid Notice APIs instead", "operationId" : "disableTransaction", "parameters" : [ { "name" : "x-fiscal-code", diff --git a/openapi/openapi_io.json b/openapi/openapi_io.json index ca1e6077..05c00663 100644 --- a/openapi/openapi_io.json +++ b/openapi/openapi_io.json @@ -15,7 +15,7 @@ "post" : { "tags" : [ "IO Transactions REST APIs" ], "summary" : "Disable the transaction details given its id.", - "description" : "This service is deprecated. Use Paid Notice APIs instead", + "description" : "This operation is deprecated. Use Paid Notice APIs instead", "operationId" : "disableTransaction", "parameters" : [ { "name" : "x-fiscal-code", diff --git a/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java b/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java index 7af3ee0f..0b73c1e1 100644 --- a/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java +++ b/src/main/java/it/gov/pagopa/bizeventsservice/controller/ITransactionController.java @@ -123,7 +123,7 @@ ResponseEntity getTransactionDetails( * @return * @deprecated */ - @Operation(summary = "Disable the transaction details given its id.", description = "This service is deprecated. Use Paid Notice APIs instead", deprecated = true, security = { + @Operation(summary = "Disable the transaction details given its id.", description = "This operation is deprecated. Use Paid Notice APIs instead", deprecated = true, security = { @SecurityRequirement(name = "ApiKey")}, operationId = "disableTransaction") @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Disabled Transactions.", From e6ae7234bac683521abc6f8682eaeefb832c1bb4 Mon Sep 17 00:00:00 2001 From: Jacopo Carlini Date: Tue, 3 Sep 2024 16:08:26 +0200 Subject: [PATCH 3/4] merge --- openapi/openapi.json | 2 +- openapi/openapi_ec.json | 2 +- openapi/openapi_helpdesk.json | 2 +- openapi/openapi_io.json | 2 +- .../bizeventsservice/controller/PaymentsControllerTest.java | 1 - 5 files changed, 4 insertions(+), 5 deletions(-) diff --git a/openapi/openapi.json b/openapi/openapi.json index 44b0111e..76d37874 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -4,7 +4,7 @@ "title" : "Biz-Events Service", "description" : "Microservice for exposing REST APIs about payment receipts.", "termsOfService" : "https://www.pagopa.gov.it/", - "version" : "0.1.48" + "version" : "0.1.49" }, "servers" : [ { "url" : "http://localhost", diff --git a/openapi/openapi_ec.json b/openapi/openapi_ec.json index c9215ed3..928053bc 100644 --- a/openapi/openapi_ec.json +++ b/openapi/openapi_ec.json @@ -4,7 +4,7 @@ "title" : "Biz-Events Service", "description" : "Microservice for exposing REST APIs about payment receipts.", "termsOfService" : "https://www.pagopa.gov.it/", - "version" : "0.1.48" + "version" : "0.1.49" }, "servers" : [ { "url" : "http://localhost", diff --git a/openapi/openapi_helpdesk.json b/openapi/openapi_helpdesk.json index 5e2c4ccd..45f3cca4 100644 --- a/openapi/openapi_helpdesk.json +++ b/openapi/openapi_helpdesk.json @@ -4,7 +4,7 @@ "title" : "Biz-Events Service", "description" : "Microservice for exposing REST APIs about payment receipts.", "termsOfService" : "https://www.pagopa.gov.it/", - "version" : "0.1.48" + "version" : "0.1.49" }, "servers" : [ { "url" : "http://localhost", diff --git a/openapi/openapi_io.json b/openapi/openapi_io.json index 05c00663..53087587 100644 --- a/openapi/openapi_io.json +++ b/openapi/openapi_io.json @@ -4,7 +4,7 @@ "title" : "Biz-Events Service", "description" : "Microservice for exposing REST APIs about payment receipts.", "termsOfService" : "https://www.pagopa.gov.it/", - "version" : "0.1.48" + "version" : "0.1.49" }, "servers" : [ { "url" : "http://localhost", diff --git a/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaymentsControllerTest.java b/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaymentsControllerTest.java index ed8fe2cb..1414fb81 100644 --- a/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaymentsControllerTest.java +++ b/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaymentsControllerTest.java @@ -11,7 +11,6 @@ import java.io.IOException; import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.CsvSource; import org.springframework.beans.factory.annotation.Autowired; From 42b641f4d6ee6ef81f32e03528f9ef9a018c3851 Mon Sep 17 00:00:00 2001 From: Jacopo Carlini Date: Tue, 3 Sep 2024 17:00:21 +0200 Subject: [PATCH 4/4] code smells --- .../controller/PaidNoticeControllerTest.java | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java b/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java index 0ce2786b..b1e22751 100644 --- a/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java +++ b/src/test/java/it/gov/pagopa/bizeventsservice/controller/PaidNoticeControllerTest.java @@ -1,16 +1,11 @@ package it.gov.pagopa.bizeventsservice.controller; -import it.gov.pagopa.bizeventsservice.client.IReceiptGeneratePDFClient; -import it.gov.pagopa.bizeventsservice.client.IReceiptGetPDFClient; import it.gov.pagopa.bizeventsservice.exception.AppError; import it.gov.pagopa.bizeventsservice.exception.AppException; -import it.gov.pagopa.bizeventsservice.model.response.Attachment; -import it.gov.pagopa.bizeventsservice.model.response.AttachmentsDetailsResponse; import it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse; import it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem; import it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListResponse; -import it.gov.pagopa.bizeventsservice.service.IBizEventsService; import it.gov.pagopa.bizeventsservice.service.ITransactionService; import it.gov.pagopa.bizeventsservice.util.Utility; import org.junit.jupiter.api.BeforeEach; @@ -23,12 +18,10 @@ import org.springframework.test.web.servlet.MockMvc; import java.io.IOException; -import java.util.Arrays; import java.util.List; import static org.mockito.ArgumentMatchers.*; import static org.mockito.Mockito.*; -import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -81,7 +74,7 @@ void getTransactionDisableWithMissingFiscalCodeShouldReturnError() throws Except } @Test - void getTransactionDisableithInvalidFiscalCodeShouldReturnError() throws Exception { + void getTransactionDisableWithInvalidFiscalCodeShouldReturnError() throws Exception { doAnswer(x -> { throw new AppException(AppError.INVALID_FISCAL_CODE, INVALID_FISCAL_CODE); }).when(transactionService).disableTransaction(anyString(), anyString());