From c3790a96da0293087769aa0e59d40dab5b08a06d Mon Sep 17 00:00:00 2001 From: pagopa-github-bot Date: Thu, 12 Sep 2024 06:33:19 +0000 Subject: [PATCH] Bump to version 0.1.56 [skip ci] --- helm/Chart.yaml | 4 +- helm/values-dev.yaml | 2 +- helm/values-prod.yaml | 2 +- helm/values-uat.yaml | 2 +- openapi/openapi.json | 4148 +++++++++++++++-------------- openapi/openapi_ec.json | 1049 ++++---- openapi/openapi_helpdesk.json | 1416 +++++----- openapi/openapi_io.json | 1350 +++++----- openapi/openapi_io_patch.json | 51 +- openapi/openapi_io_patch_lap.json | 46 +- pom.xml | 2 +- 11 files changed, 4280 insertions(+), 3792 deletions(-) diff --git a/helm/Chart.yaml b/helm/Chart.yaml index 353e93a..a1eb7ca 100644 --- a/helm/Chart.yaml +++ b/helm/Chart.yaml @@ -2,8 +2,8 @@ apiVersion: v2 name: pagopa-biz-events-service description: Microservice for exposing REST APIs about payment receipts. type: application -version: 0.78.0 -appVersion: 0.1.55 +version: 0.79.0 +appVersion: 0.1.56 dependencies: - name: microservice-chart version: 2.4.0 diff --git a/helm/values-dev.yaml b/helm/values-dev.yaml index 51d5eee..d065ead 100644 --- a/helm/values-dev.yaml +++ b/helm/values-dev.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "" image: repository: ghcr.io/pagopa/pagopa-biz-events-service - tag: "0.1.55" + tag: "0.1.56" pullPolicy: Always livenessProbe: httpGet: diff --git a/helm/values-prod.yaml b/helm/values-prod.yaml index 9307904..f1a5f12 100644 --- a/helm/values-prod.yaml +++ b/helm/values-prod.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "" image: repository: ghcr.io/pagopa/pagopa-biz-events-service - tag: "0.1.55" + tag: "0.1.56" pullPolicy: Always livenessProbe: httpGet: diff --git a/helm/values-uat.yaml b/helm/values-uat.yaml index 2e7f048..9eb8e19 100644 --- a/helm/values-uat.yaml +++ b/helm/values-uat.yaml @@ -4,7 +4,7 @@ microservice-chart: fullnameOverride: "" image: repository: ghcr.io/pagopa/pagopa-biz-events-service - tag: "0.1.55" + tag: "0.1.56" pullPolicy: Always livenessProbe: httpGet: diff --git a/openapi/openapi.json b/openapi/openapi.json index 3c1bec2..9d93cea 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -1,2738 +1,2976 @@ { - "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.55" + "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.56" }, - "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" : { - "get" : { - "tags" : [ "Paid Notice REST APIs" ], - "summary" : "Retrieve the paged transaction list from biz events.", - "description" : "This operation is deprecated. Use Paid Notice APIs instead", - "operationId" : "getPaidNotices", - "parameters" : [ { - "name" : "x-fiscal-code", - "in" : "header", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "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" : "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" : "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 paid notices list.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "/paids": { + "get": { + "tags": [ + "Paid Notice REST APIs" + ], + "summary": "Retrieve the paged transaction list from biz events.", + "description": "This operation is deprecated. Use Paid Notice APIs instead", + "operationId": "getPaidNotices", + "parameters": [ + { + "name": "x-fiscal-code", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": "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": "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 paid notices 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/NoticeListWrapResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NoticeListWrapResponse" } } } }, - "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 fiscal code.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "404": { + "description": "Not found the fiscal code.", + "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" + } } - } ] + ] }, - "/paids/{event-id}" : { - "get" : { - "tags" : [ "Paid Notice REST APIs" ], - "summary" : "Retrieve the paid notice details given its id.", - "operationId" : "getPaidNoticeDetail", - "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" : "Obtained paid notice detail.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "/paids/{event-id}": { + "get": { + "tags": [ + "Paid Notice REST APIs" + ], + "summary": "Retrieve the paid notice details given its id.", + "operationId": "getPaidNoticeDetail", + "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": "Obtained paid notice detail.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/NoticeDetailResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NoticeDetailResponse" } } } }, - "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" + } } - } ] + ] }, - "/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" + "/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" : { } + "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 paid event.", - "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" + "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}/pdf" : { - "get" : { - "tags" : [ "Paid Notice REST APIs" ], - "summary" : "Retrieve the PDF receipt given event id.", - "operationId" : "generatePDF", - "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" : "Obtained the PDF receipt.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "/paids/{event-id}/pdf": { + "get": { + "tags": [ + "Paid Notice REST APIs" + ], + "summary": "Retrieve the PDF receipt given event id.", + "operationId": "generatePDF", + "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": "Obtained the PDF receipt.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } }, - "Content-Disposition" : { - "description" : "Content disposition with name of the file", - "style" : "simple", - "schema" : { - "type" : "string" + "Content-Disposition": { + "description": "Content disposition with name of the file", + "style": "simple", + "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" } } }, - "content" : { - "application/json" : { } + "content": { + "application/json": {} } }, - "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" : { - "get" : { - "tags" : [ "IO Transactions REST APIs" ], - "summary" : "Retrieve the paged transaction list from biz events.", - "description" : "This operation is deprecated. Use Paid Notice APIs instead", - "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.", + "description": "This operation is deprecated. Use Paid Notice APIs instead", + "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" } } } } }, - "deprecated" : true, - "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/{event-id}/pdf" : { - "get" : { - "tags" : [ "IO Transactions REST APIs" ], - "summary" : "Retrieve the PDF receipt given event id.", - "description" : "This operation is deprecated. Use Paid Notice APIs instead", - "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.", + "description": "This operation is deprecated. Use Paid Notice APIs instead", + "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" } } } } }, - "deprecated" : true, - "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/{transaction-id}" : { - "get" : { - "tags" : [ "IO Transactions REST APIs" ], - "summary" : "Retrieve the transaction details given its id.", - "description" : "This operation is deprecated. Use Paid Notice APIs instead", - "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.", + "description": "This operation is deprecated. Use Paid Notice APIs instead", + "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" } } } } }, - "deprecated" : true, - "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/{transaction-id}/disable" : { - "post" : { - "tags" : [ "IO Transactions REST APIs" ], - "summary" : "Disable the transaction details given its id.", - "description" : "This operation 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" + "/transactions/{transaction-id}/disable": { + "post": { + "tags": [ + "IO Transactions REST APIs" + ], + "summary": "Disable the transaction details given its id.", + "description": "This operation 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" } } } } }, - "deprecated" : true, - "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" : { - "required" : [ "amount", "refNumberType", "refNumberValue", "subject" ], - "type" : "object", - "properties" : { - "subject" : { - "type" : "string" + "CartItem": { + "required": [ + "amount", + "refNumberType", + "refNumberValue", + "subject" + ], + "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" : { - "required" : [ "taxCode" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "taxCode" : { - "type" : "string" + "UserDetail": { + "required": [ + "taxCode" + ], + "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" } } }, - "NoticeListItem" : { - "required" : [ "amount", "eventId", "isCart", "isDebtor", "isPayer", "noticeDate", "payeeTaxCode" ], - "type" : "object", - "properties" : { - "eventId" : { - "type" : "string" - }, - "payeeName" : { - "type" : "string" - }, - "payeeTaxCode" : { - "type" : "string" - }, - "amount" : { - "type" : "string" - }, - "noticeDate" : { - "type" : "string" - }, - "isCart" : { - "type" : "boolean" - }, - "isPayer" : { - "type" : "boolean" - }, - "isDebtor" : { - "type" : "boolean" + "NoticeListItem": { + "required": [ + "amount", + "eventId", + "isCart", + "isDebtor", + "isPayer", + "noticeDate", + "payeeTaxCode" + ], + "type": "object", + "properties": { + "eventId": { + "type": "string" + }, + "payeeName": { + "type": "string" + }, + "payeeTaxCode": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "noticeDate": { + "type": "string" + }, + "isCart": { + "type": "boolean" + }, + "isPayer": { + "type": "boolean" + }, + "isDebtor": { + "type": "boolean" } } }, - "NoticeListWrapResponse" : { - "required" : [ "notices" ], - "type" : "object", - "properties" : { - "notices" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoticeListItem" + "NoticeListWrapResponse": { + "required": [ + "notices" + ], + "type": "object", + "properties": { + "notices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoticeListItem" } } } }, - "InfoNotice" : { - "required" : [ "amount", "eventId", "noticeDate", "origin", "pspName", "rrn" ], - "type" : "object", - "properties" : { - "eventId" : { - "type" : "string" - }, - "authCode" : { - "type" : "string" - }, - "rrn" : { - "type" : "string" - }, - "noticeDate" : { - "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" ] + "InfoNotice": { + "required": [ + "amount", + "eventId", + "noticeDate", + "origin", + "pspName", + "rrn" + ], + "type": "object", + "properties": { + "eventId": { + "type": "string" + }, + "authCode": { + "type": "string" + }, + "rrn": { + "type": "string" + }, + "noticeDate": { + "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" + ] } } }, - "NoticeDetailResponse" : { - "type" : "object", - "properties" : { - "infoNotice" : { - "$ref" : "#/components/schemas/InfoNotice" + "NoticeDetailResponse": { + "type": "object", + "properties": { + "infoNotice": { + "$ref": "#/components/schemas/InfoNotice" }, - "carts" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CartItem" + "carts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItem" } } } }, - "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 d223505..cfc7a28 100644 --- a/openapi/openapi_ec.json +++ b/openapi/openapi_ec.json @@ -1,661 +1,724 @@ { - "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.55" + "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.56" }, - "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" : { - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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 receipt.", - "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/CtReceiptModelResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CtReceiptModelResponse" } } } } }, - "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" : { - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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 receipt.", - "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/CtReceiptModelResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CtReceiptModelResponse" } } } } }, - "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" : { - "429" : { - "description" : "Too many requests", - "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": { + "429": { + "description": "Too many requests", + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } } }, - "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 4abbf26..d98c11d 100644 --- a/openapi/openapi_helpdesk.json +++ b/openapi/openapi_helpdesk.json @@ -1,1006 +1,1046 @@ { - "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.55" + "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.56" }, - "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" : { - "429" : { - "description" : "Too many requests", - "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": { + "429": { + "description": "Too many requests", + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } } }, - "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" : { - "404" : { - "description" : "Not found the 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": { + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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 biz-event.", - "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/BizEvent" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BizEvent" } } } } }, - "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" : { - "404" : { - "description" : "Not found the biz-event.", - "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" } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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 biz-event.", - "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/BizEvent" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BizEvent" } } } } }, - "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 20310da..2b1c963 100644 --- a/openapi/openapi_io.json +++ b/openapi/openapi_io.json @@ -1,851 +1,947 @@ { - "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.55" + "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.56" }, - "servers" : [ { - "url" : "http://localhost", - "description" : "Generated server url" - } ], - "paths" : { - "/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" + "servers": [ + { + "url": "http://localhost", + "description": "Generated server url" + } + ], + "paths": { + "/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" : { - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "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" } } } }, - "200" : { - "description" : "Event Disabled.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Event Disabled.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { } + "content": { + "application/json": {} } }, - "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" } } } }, - "404" : { - "description" : "Not found the paid event.", - "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" + "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" : { - "get" : { - "tags" : [ "Paid Notice REST APIs" ], - "summary" : "Retrieve the paged transaction list from biz events.", - "description" : "This operation is deprecated. Use Paid Notice APIs instead", - "operationId" : "getPaidNotices", - "parameters" : [ { - "name" : "x-fiscal-code", - "in" : "header", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "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" : "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" : "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" ] + "/paids": { + "get": { + "tags": [ + "Paid Notice REST APIs" + ], + "summary": "Retrieve the paged transaction list from biz events.", + "description": "This operation is deprecated. Use Paid Notice APIs instead", + "operationId": "getPaidNotices", + "parameters": [ + { + "name": "x-fiscal-code", + "in": "header", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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": "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": "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 paid notices list.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "200": { + "description": "Obtained paid notices 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/NoticeListWrapResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NoticeListWrapResponse" } } } }, - "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" } } } }, - "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" } } } }, - "404" : { - "description" : "Not found the fiscal code.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "404": { + "description": "Not found the fiscal code.", + "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" } } } } }, - "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}" : { - "get" : { - "tags" : [ "Paid Notice REST APIs" ], - "summary" : "Retrieve the paid notice details given its id.", - "operationId" : "getPaidNoticeDetail", - "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" + "/paids/{event-id}": { + "get": { + "tags": [ + "Paid Notice REST APIs" + ], + "summary": "Retrieve the paid notice details given its id.", + "operationId": "getPaidNoticeDetail", + "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" : { - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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 paid notice detail.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + "200": { + "description": "Obtained paid notice detail.", + "headers": { + "X-Request-Id": { + "description": "This header identifies the call", + "schema": { + "type": "string" } } }, - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/NoticeDetailResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NoticeDetailResponse" } } } } }, - "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}/pdf" : { - "get" : { - "tags" : [ "Paid Notice REST APIs" ], - "summary" : "Retrieve the PDF receipt given event id.", - "operationId" : "generatePDF", - "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" + "/paids/{event-id}/pdf": { + "get": { + "tags": [ + "Paid Notice REST APIs" + ], + "summary": "Retrieve the PDF receipt given event id.", + "operationId": "generatePDF", + "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" : { - "500" : { - "description" : "Service unavailable.", - "headers" : { - "X-Request-Id" : { - "description" : "This header identifies the call", - "schema" : { - "type" : "string" + ], + "responses": { + "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" } } } }, - "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" } } }, - "content" : { - "application/json" : { } + "content": { + "application/json": {} } }, - "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" } } } }, - "200" : { - "description" : "Obtained the PDF receipt.", - "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" } }, - "Content-Disposition" : { - "description" : "Content disposition with name of the file", - "style" : "simple", - "schema" : { - "type" : "string" + "Content-Disposition": { + "description": "Content disposition with name of the file", + "style": "simple", + "schema": { + "type": "string" } } }, - "content" : { - "application/pdf" : { - "schema" : { - "type" : "string", - "format" : "binary" + "content": { + "application/pdf": { + "schema": { + "type": "string", + "format": "binary" } } } } }, - "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" : { - "429" : { - "description" : "Too many requests", - "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": { + "429": { + "description": "Too many requests", + "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } }, - "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" } } } } }, - "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" } } }, - "NoticeListItem" : { - "required" : [ "amount", "eventId", "isCart", "isDebtor", "isPayer", "noticeDate", "payeeTaxCode" ], - "type" : "object", - "properties" : { - "eventId" : { - "type" : "string" - }, - "payeeName" : { - "type" : "string" - }, - "payeeTaxCode" : { - "type" : "string" - }, - "amount" : { - "type" : "string" - }, - "noticeDate" : { - "type" : "string" - }, - "isCart" : { - "type" : "boolean" - }, - "isPayer" : { - "type" : "boolean" - }, - "isDebtor" : { - "type" : "boolean" + "NoticeListItem": { + "required": [ + "amount", + "eventId", + "isCart", + "isDebtor", + "isPayer", + "noticeDate", + "payeeTaxCode" + ], + "type": "object", + "properties": { + "eventId": { + "type": "string" + }, + "payeeName": { + "type": "string" + }, + "payeeTaxCode": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "noticeDate": { + "type": "string" + }, + "isCart": { + "type": "boolean" + }, + "isPayer": { + "type": "boolean" + }, + "isDebtor": { + "type": "boolean" } } }, - "NoticeListWrapResponse" : { - "required" : [ "notices" ], - "type" : "object", - "properties" : { - "notices" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/NoticeListItem" + "NoticeListWrapResponse": { + "required": [ + "notices" + ], + "type": "object", + "properties": { + "notices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NoticeListItem" } } } }, - "CartItem" : { - "required" : [ "amount", "refNumberType", "refNumberValue", "subject" ], - "type" : "object", - "properties" : { - "subject" : { - "type" : "string" - }, - "amount" : { - "type" : "string" - }, - "payee" : { - "$ref" : "#/components/schemas/UserDetail" - }, - "debtor" : { - "$ref" : "#/components/schemas/UserDetail" - }, - "refNumberValue" : { - "type" : "string" - }, - "refNumberType" : { - "type" : "string" + "CartItem": { + "required": [ + "amount", + "refNumberType", + "refNumberValue", + "subject" + ], + "type": "object", + "properties": { + "subject": { + "type": "string" + }, + "amount": { + "type": "string" + }, + "payee": { + "$ref": "#/components/schemas/UserDetail" + }, + "debtor": { + "$ref": "#/components/schemas/UserDetail" + }, + "refNumberValue": { + "type": "string" + }, + "refNumberType": { + "type": "string" } } }, - "InfoNotice" : { - "required" : [ "amount", "eventId", "noticeDate", "origin", "pspName", "rrn" ], - "type" : "object", - "properties" : { - "eventId" : { - "type" : "string" - }, - "authCode" : { - "type" : "string" - }, - "rrn" : { - "type" : "string" - }, - "noticeDate" : { - "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" ] + "InfoNotice": { + "required": [ + "amount", + "eventId", + "noticeDate", + "origin", + "pspName", + "rrn" + ], + "type": "object", + "properties": { + "eventId": { + "type": "string" + }, + "authCode": { + "type": "string" + }, + "rrn": { + "type": "string" + }, + "noticeDate": { + "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" + ] } } }, - "NoticeDetailResponse" : { - "type" : "object", - "properties" : { - "infoNotice" : { - "$ref" : "#/components/schemas/InfoNotice" - }, - "carts" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CartItem" + "NoticeDetailResponse": { + "type": "object", + "properties": { + "infoNotice": { + "$ref": "#/components/schemas/InfoNotice" + }, + "carts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItem" } } } }, - "UserDetail" : { - "required" : [ "taxCode" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "taxCode" : { - "type" : "string" + "UserDetail": { + "required": [ + "taxCode" + ], + "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/openapi/openapi_io_patch.json b/openapi/openapi_io_patch.json index 53cc8b6..deb27ca 100644 --- a/openapi/openapi_io_patch.json +++ b/openapi/openapi_io_patch.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.55" + "version": "0.1.56" }, "servers": [ { @@ -15,7 +15,9 @@ "paths": { "/transactions/{transaction-id}/disable": { "post": { - "tags": ["IO Transactions REST APIs"], + "tags": [ + "IO Transactions REST APIs" + ], "summary": "Disable the transaction details given its id.", "operationId": "disableTransaction", "parameters": [ @@ -124,7 +126,9 @@ }, "/transactions": { "get": { - "tags": ["IO Transactions REST APIs"], + "tags": [ + "IO Transactions REST APIs" + ], "summary": "Retrieve the paged transaction list from biz events.", "operationId": "getTransactionList", "parameters": [ @@ -181,7 +185,9 @@ "schema": { "type": "string", "default": "TRANSACTION_DATE", - "enum": ["TRANSACTION_DATE"] + "enum": [ + "TRANSACTION_DATE" + ] } }, { @@ -192,7 +198,10 @@ "schema": { "type": "string", "default": "DESC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } ], @@ -290,7 +299,9 @@ }, "/transactions/{transaction-id}": { "get": { - "tags": ["IO Transactions REST APIs"], + "tags": [ + "IO Transactions REST APIs" + ], "summary": "Retrieve the transaction details given its id.", "operationId": "getTransactionDetails", "parameters": [ @@ -400,7 +411,9 @@ }, "/transactions/{event-id}/pdf": { "get": { - "tags": ["IO Transactions REST APIs"], + "tags": [ + "IO Transactions REST APIs" + ], "summary": "Retrieve the PDF receipt given event id.", "operationId": "getPDFReceipt", "parameters": [ @@ -529,7 +542,9 @@ }, "/transactions/cached": { "get": { - "tags": ["IO Transactions REST APIs"], + "tags": [ + "IO Transactions REST APIs" + ], "summary": "Retrieve the paged transaction list from biz events.", "operationId": "getTransactionList_1", "parameters": [ @@ -588,7 +603,9 @@ "schema": { "type": "string", "default": "TRANSACTION_DATE", - "enum": ["TRANSACTION_DATE"] + "enum": [ + "TRANSACTION_DATE" + ] } }, { @@ -599,7 +616,10 @@ "schema": { "type": "string", "default": "DESC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } ], @@ -690,7 +710,9 @@ }, "/info": { "get": { - "tags": ["Home"], + "tags": [ + "Home" + ], "summary": "health check", "description": "Return OK if application is started", "operationId": "healthCheck", @@ -816,7 +838,12 @@ } }, "PageInfo": { - "required": ["items_found", "limit", "page", "total_pages"], + "required": [ + "items_found", + "limit", + "page", + "total_pages" + ], "type": "object", "properties": { "page": { diff --git a/openapi/openapi_io_patch_lap.json b/openapi/openapi_io_patch_lap.json index 2e0585a..579d281 100644 --- a/openapi/openapi_io_patch_lap.json +++ b/openapi/openapi_io_patch_lap.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.55" + "version": "0.1.56" }, "servers": [ { @@ -15,7 +15,9 @@ "paths": { "/paids/{event-id}/disable": { "post": { - "tags": ["Paid Notice REST APIs"], + "tags": [ + "Paid Notice REST APIs" + ], "summary": "Disable the paid notice details given its id.", "operationId": "disablePaidNotice", "parameters": [ @@ -121,7 +123,9 @@ }, "/paids": { "get": { - "tags": ["Paid Notice REST APIs"], + "tags": [ + "Paid Notice REST APIs" + ], "summary": "Retrieve the paged transaction list from biz events.", "description": "This operation is deprecated. Use Paid Notice APIs instead", "operationId": "getPaidNotices", @@ -179,7 +183,9 @@ "schema": { "type": "string", "default": "TRANSACTION_DATE", - "enum": ["TRANSACTION_DATE"] + "enum": [ + "TRANSACTION_DATE" + ] } }, { @@ -190,7 +196,10 @@ "schema": { "type": "string", "default": "DESC", - "enum": ["ASC", "DESC"] + "enum": [ + "ASC", + "DESC" + ] } } ], @@ -288,7 +297,9 @@ }, "/paids/{event-id}": { "get": { - "tags": ["Paid Notice REST APIs"], + "tags": [ + "Paid Notice REST APIs" + ], "summary": "Retrieve the paid notice details given its id.", "operationId": "getPaidNoticeDetail", "parameters": [ @@ -398,7 +409,9 @@ }, "/paids/{event-id}/pdf": { "get": { - "tags": ["Paid Notice REST APIs"], + "tags": [ + "Paid Notice REST APIs" + ], "summary": "Retrieve the PDF receipt given event id.", "operationId": "generatePDF", "parameters": [ @@ -537,7 +550,9 @@ }, "/info": { "get": { - "tags": ["Home"], + "tags": [ + "Home" + ], "summary": "health check", "description": "Return OK if application is started", "operationId": "healthCheck", @@ -701,7 +716,9 @@ } }, "NoticeListWrapResponse": { - "required": ["notices"], + "required": [ + "notices" + ], "type": "object", "properties": { "notices": { @@ -713,7 +730,12 @@ } }, "CartItem": { - "required": ["amount", "refNumberType", "refNumberValue", "subject"], + "required": [ + "amount", + "refNumberType", + "refNumberValue", + "subject" + ], "type": "object", "properties": { "subject": { @@ -817,7 +839,9 @@ } }, "UserDetail": { - "required": ["taxCode"], + "required": [ + "taxCode" + ], "type": "object", "properties": { "name": { diff --git a/pom.xml b/pom.xml index 488a0c8..49309e0 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ it.gov.pagopa bizeventsservice - 0.1.55 + 0.1.56 Biz-Events Service Microservice for exposing REST APIs about payment receipts.