diff --git a/helm/Chart.yaml b/helm/Chart.yaml
index a009f159..c7fcffab 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.41.0
-appVersion: 0.1.19
+version: 0.42.0
+appVersion: 0.1.20
dependencies:
- name: microservice-chart
version: 2.4.0
diff --git a/helm/values-dev.yaml b/helm/values-dev.yaml
index 99354a62..13d9800e 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.19"
+ tag: "0.1.20"
pullPolicy: Always
livenessProbe:
httpGet:
diff --git a/helm/values-prod.yaml b/helm/values-prod.yaml
index 6e79b504..382d78e5 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.19"
+ tag: "0.1.20"
pullPolicy: Always
livenessProbe:
httpGet:
diff --git a/helm/values-uat.yaml b/helm/values-uat.yaml
index bbc99395..6acbec48 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.19"
+ tag: "0.1.20"
pullPolicy: Always
livenessProbe:
httpGet:
diff --git a/openapi/openapi.json b/openapi/openapi.json
index f9b45500..a66cf9b6 100644
--- a/openapi/openapi.json
+++ b/openapi/openapi.json
@@ -1,1951 +1,2089 @@
{
- "openapi" : "3.0.1",
- "info" : {
- "title" : "@project.name@",
- "description" : "@project.description@",
- "termsOfService" : "https://www.pagopa.gov.it/",
- "version" : "@project.version@"
+ "openapi": "3.0.1",
+ "info": {
+ "title": "@project.name@",
+ "description": "@project.description@",
+ "termsOfService": "https://www.pagopa.gov.it/",
+ "version": "0.1.20"
},
- "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"
+ "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"
+ ],
+ "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/it.gov.pagopa.bizeventsservice.entity.BizEvent"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "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"
+ "/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"
+ ],
+ "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/it.gov.pagopa.bizeventsservice.entity.BizEvent"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "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/it.gov.pagopa.bizeventsservice.model.AppInfo"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "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"
+ "/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"
+ ],
+ "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/it.gov.pagopa.bizeventsservice.model.response.CtReceiptModelResponse"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "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" : {
- "200" : {
- "description" : "Obtained receipt.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "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/it.gov.pagopa.bizeventsservice.model.response.CtReceiptModelResponse"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/transactions" : {
- "get" : {
- "tags" : [ "IO Transactions REST APIs" ],
- "summary" : "Retrieve the paged transaction list from biz events.",
- "operationId" : "getTransactionList",
- "parameters" : [ {
- "name" : "x-fiscal-code",
- "in" : "header",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "x-continuation-token",
- "in" : "header",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "size",
- "in" : "query",
- "required" : false,
- "schema" : {
- "type" : "integer",
- "format" : "int32",
- "default" : 10
+ "/transactions": {
+ "get": {
+ "tags": [
+ "IO Transactions REST APIs"
+ ],
+ "summary": "Retrieve the paged transaction list from biz events.",
+ "operationId": "getTransactionList",
+ "parameters": [
+ {
+ "name": "x-fiscal-code",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-continuation-token",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 10
+ }
}
- } ],
- "responses" : {
- "200" : {
- "description" : "Obtained transaction list.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ ],
+ "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" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem"
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem"
}
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "*/*": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/transactions/{transaction-id}" : {
- "get" : {
- "tags" : [ "IO Transactions REST APIs" ],
- "summary" : "Retrieve the transaction details given its id.",
- "operationId" : "getTransactionDetails",
- "parameters" : [ {
- "name" : "x-fiscal-code",
- "in" : "header",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "transaction-id",
- "in" : "path",
- "description" : "The id of the transaction.",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/transactions/{transaction-id}": {
+ "get": {
+ "tags": [
+ "IO Transactions REST APIs"
+ ],
+ "summary": "Retrieve the transaction details given its id.",
+ "operationId": "getTransactionDetails",
+ "parameters": [
+ {
+ "name": "x-fiscal-code",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "transaction-id",
+ "in": "path",
+ "description": "The id of the transaction.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
- } ],
- "responses" : {
- "200" : {
- "description" : "Obtained transaction details.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ ],
+ "responses": {
+ "200": {
+ "description": "Obtained transaction details.",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/transactions/{transaction-id}/disable" : {
- "post" : {
- "tags" : [ "IO Transactions REST APIs" ],
- "summary" : "Disable the transaction details given its id.",
- "operationId" : "disableTransaction",
- "parameters" : [ {
- "name" : "x-fiscal-code",
- "in" : "header",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "transaction-id",
- "in" : "path",
- "description" : "The id of the transaction.",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/transactions/{transaction-id}/disable": {
+ "post": {
+ "tags": [
+ "IO Transactions REST APIs"
+ ],
+ "summary": "Disable the transaction details given its id.",
+ "operationId": "disableTransaction",
+ "parameters": [
+ {
+ "name": "x-fiscal-code",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "transaction-id",
+ "in": "path",
+ "description": "The id of the transaction.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
- } ],
- "responses" : {
- "200" : {
- "description" : "Disabled Transactions.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ ],
+ "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
}
},
- "components" : {
- "schemas" : {
- "it.gov.pagopa.bizeventsservice.model.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": {
+ "it.gov.pagopa.bizeventsservice.model.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem" : {
- "type" : "object",
- "properties" : {
- "transactionId" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.view.UserDetail" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "taxCode" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.view.UserDetail": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "taxCode": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.view.WalletInfo" : {
- "type" : "object",
- "properties" : {
- "accountHolder" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.view.WalletInfo": {
+ "type": "object",
+ "properties": {
+ "accountHolder": {
+ "type": "string"
},
- "brand" : {
- "type" : "string"
+ "brand": {
+ "type": "string"
},
- "blurredNumber" : {
- "type" : "string"
+ "blurredNumber": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem" : {
- "type" : "object",
- "properties" : {
- "subject" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem": {
+ "type": "object",
+ "properties": {
+ "subject": {
+ "type": "string"
},
- "amount" : {
- "type" : "string"
+ "amount": {
+ "type": "string"
},
- "payee" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
+ "payee": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
},
- "debtor" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
+ "debtor": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
},
- "refNumberValue" : {
- "type" : "string"
+ "refNumberValue": {
+ "type": "string"
},
- "refNumberType" : {
- "type" : "string"
+ "refNumberType": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction" : {
- "type" : "object",
- "properties" : {
- "transactionId" : {
- "type" : "string"
- },
- "authCode" : {
- "type" : "string"
- },
- "rrn" : {
- "type" : "string"
- },
- "transactionDate" : {
- "type" : "string"
- },
- "pspName" : {
- "type" : "string"
- },
- "walletInfo" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.WalletInfo"
- },
- "paymentMethod" : {
- "type" : "string",
- "enum" : [ "BBT", "BP", "AD", "CP", "PO", "OBEP", "JIF", "MYBK", "PPAL", "UNKNOWN" ]
- },
- "payer" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
- },
- "amount" : {
- "type" : "string"
- },
- "fee" : {
- "type" : "string"
- },
- "origin" : {
- "type" : "string",
- "enum" : [ "INTERNAL", "PM", "NDP001PROD", "NDP002PROD", "NDP003PROD", "UNKNOWN" ]
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction": {
+ "type": "object",
+ "properties": {
+ "transactionId": {
+ "type": "string"
+ },
+ "authCode": {
+ "type": "string"
+ },
+ "rrn": {
+ "type": "string"
+ },
+ "transactionDate": {
+ "type": "string"
+ },
+ "pspName": {
+ "type": "string"
+ },
+ "walletInfo": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.WalletInfo"
+ },
+ "paymentMethod": {
+ "type": "string",
+ "enum": [
+ "BBT",
+ "BP",
+ "AD",
+ "CP",
+ "PO",
+ "OBEP",
+ "JIF",
+ "MYBK",
+ "PPAL",
+ "UNKNOWN"
+ ]
+ },
+ "payer": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
+ },
+ "amount": {
+ "type": "string"
+ },
+ "fee": {
+ "type": "string"
+ },
+ "origin": {
+ "type": "string",
+ "enum": [
+ "INTERNAL",
+ "PM",
+ "NDP001PROD",
+ "NDP002PROD",
+ "NDP003PROD",
+ "UNKNOWN"
+ ]
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse" : {
- "type" : "object",
- "properties" : {
- "infoTransaction" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction"
- },
- "carts" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem"
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse": {
+ "type": "object",
+ "properties": {
+ "infoTransaction": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction"
+ },
+ "carts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem"
}
}
}
},
- "it.gov.pagopa.bizeventsservice.model.MapEntry" : {
- "type" : "object",
- "properties" : {
- "key" : {
- "type" : "string"
- },
- "value" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.MapEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.response.Debtor"
- },
- "transferList" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.TransferPA"
+ "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.response.Debtor"
+ },
+ "transferList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.response.Payer"
+ "payer": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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"
+ "it.gov.pagopa.bizeventsservice.model.response.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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"
+ "it.gov.pagopa.bizeventsservice.model.response.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
}
}
},
- "it.gov.pagopa.bizeventsservice.model.AppInfo" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.AppInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
},
- "version" : {
- "type" : "string"
+ "version": {
+ "type": "string"
},
- "environment" : {
- "type" : "string"
+ "environment": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.AuthRequest" : {
- "type" : "object",
- "properties" : {
- "authOutcome" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.BizEvent" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.DebtorPosition"
+ "debtorPosition": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.DebtorPosition"
},
- "creditor" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Creditor"
+ "creditor": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Creditor"
},
- "psp" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Psp"
+ "psp": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Psp"
},
- "debtor" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Debtor"
+ "debtor": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Debtor"
},
- "payer" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Payer"
+ "payer": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Payer"
},
- "paymentInfo" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentInfo"
+ "paymentInfo": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentInfo"
},
- "transferList" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transfer"
+ "transferList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transfer"
}
},
- "transactionDetails" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.TransactionDetails"
- },
- "eventStatus" : {
- "type" : "string",
- "enum" : [ "NA", "RETRY", "FAILED", "DONE" ]
- },
- "eventRetryEnrichmentCount" : {
- "type" : "integer",
- "format" : "int32"
+ "transactionDetails": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.TransactionDetails"
+ },
+ "eventStatus": {
+ "type": "string",
+ "enum": [
+ "NA",
+ "RETRY",
+ "FAILED",
+ "DONE"
+ ]
+ },
+ "eventRetryEnrichmentCount": {
+ "type": "integer",
+ "format": "int32"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Creditor" : {
- "type" : "object",
- "properties" : {
- "idPA" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Debtor" : {
- "type" : "object",
- "properties" : {
- "fullName" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.DebtorPosition" : {
- "type" : "object",
- "properties" : {
- "modelType" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.DebtorPosition": {
+ "type": "object",
+ "properties": {
+ "modelType": {
+ "type": "string"
},
- "noticeNumber" : {
- "type" : "string"
+ "noticeNumber": {
+ "type": "string"
},
- "iuv" : {
- "type" : "string"
+ "iuv": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Details" : {
- "type" : "object",
- "properties" : {
- "blurredNumber" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.Details": {
+ "type": "object",
+ "properties": {
+ "blurredNumber": {
+ "type": "string"
},
- "holder" : {
- "type" : "string"
+ "holder": {
+ "type": "string"
},
- "circuit" : {
- "type" : "string"
+ "circuit": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Info" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.InfoTransaction" : {
- "type" : "object",
- "properties" : {
- "brand" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.MBD" : {
- "type" : "object",
- "properties" : {
- "IUBD" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Payer" : {
- "type" : "object",
- "properties" : {
- "fullName" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.PaymentAuthorizationRequest" : {
- "type" : "object",
- "properties" : {
- "authOutcome" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.Details"
+ "details": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Details"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.PaymentInfo" : {
- "type" : "object",
- "properties" : {
- "paymentDateTime" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
},
- "IUR" : {
- "type" : "string"
+ "IUR": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Psp" : {
- "type" : "object",
- "properties" : {
- "idPsp" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Transaction" : {
- "type" : "object",
- "properties" : {
- "idTransaction" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.TransactionPsp"
+ "psp": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.TransactionPsp"
},
- "origin" : {
- "type" : "string"
+ "origin": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.TransactionDetails" : {
- "type" : "object",
- "properties" : {
- "user" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.User"
+ "it.gov.pagopa.bizeventsservice.entity.TransactionDetails": {
+ "type": "object",
+ "properties": {
+ "user": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.User"
},
- "paymentAuthorizationRequest" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentAuthorizationRequest"
+ "paymentAuthorizationRequest": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentAuthorizationRequest"
},
- "wallet" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.WalletItem"
+ "wallet": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.WalletItem"
},
- "origin" : {
- "type" : "string"
+ "origin": {
+ "type": "string"
},
- "transaction" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transaction"
+ "transaction": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transaction"
},
- "info" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.InfoTransaction"
+ "info": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.InfoTransaction"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.TransactionPsp" : {
- "type" : "object",
- "properties" : {
- "idChannel" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.TransactionPsp": {
+ "type": "object",
+ "properties": {
+ "idChannel": {
+ "type": "string"
},
- "businessName" : {
- "type" : "string"
+ "businessName": {
+ "type": "string"
},
- "serviceName" : {
- "type" : "string"
+ "serviceName": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Transfer" : {
- "type" : "object",
- "properties" : {
- "idTransfer" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
},
- "IBAN" : {
- "type" : "string"
+ "IBAN": {
+ "type": "string"
},
- "MBD" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.MBD"
+ "MBD": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.MBD"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.User" : {
- "type" : "object",
- "properties" : {
- "fullName" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.User": {
+ "type": "object",
+ "properties": {
+ "fullName": {
+ "type": "string"
},
- "type" : {
- "type" : "string",
- "enum" : [ "F", "G" ]
+ "type": {
+ "type": "string",
+ "enum": [
+ "F",
+ "G"
+ ]
},
- "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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.WalletItem" : {
- "type" : "object",
- "properties" : {
- "idWallet" : {
- "type" : "string"
- },
- "walletType" : {
- "type" : "string",
- "enum" : [ "CARD", "PAYPAL", "BANCOMATPAY" ]
- },
- "enableableFunctions" : {
- "type" : "array",
- "items" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.Info"
+ "info": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Info"
},
- "authRequest" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.AuthRequest"
+ "authRequest": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.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 f184327f..7781f619 100644
--- a/openapi/openapi_ec.json
+++ b/openapi/openapi_ec.json
@@ -1,658 +1,721 @@
{
- "openapi" : "3.0.1",
- "info" : {
- "title" : "@project.name@",
- "description" : "@project.description@",
- "termsOfService" : "https://www.pagopa.gov.it/",
- "version" : "@project.version@"
+ "openapi": "3.0.1",
+ "info": {
+ "title": "@project.name@",
+ "description": "@project.description@",
+ "termsOfService": "https://www.pagopa.gov.it/",
+ "version": "0.1.20"
},
- "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" : {
- "422" : {
- "description" : "Unable to process the request.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ ],
+ "responses": {
+ "422": {
+ "description": "Unable to process the request.",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.response.CtReceiptModelResponse"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.CtReceiptModelResponse"
}
}
}
},
- "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 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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
}
},
- "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.",
- "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.",
+ "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" : {
- "422" : {
- "description" : "Unable to process the request.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ ],
+ "responses": {
+ "422": {
+ "description": "Unable to process the request.",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.response.CtReceiptModelResponse"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.CtReceiptModelResponse"
}
}
}
},
- "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 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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
}
},
- "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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/info" : {
- "get" : {
- "tags" : [ "Home" ],
- "summary" : "health check",
- "description" : "Return OK if application is started",
- "operationId" : "healthCheck",
- "responses" : {
- "401" : {
- "description" : "Unauthorized",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "/info": {
+ "get": {
+ "tags": [
+ "Home"
+ ],
+ "summary": "health check",
+ "description": "Return OK if application is started",
+ "operationId": "healthCheck",
+ "responses": {
+ "401": {
+ "description": "Unauthorized",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "200" : {
- "description" : "OK",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "200": {
+ "description": "OK",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.AppInfo"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
}
},
- "components" : {
- "schemas" : {
- "it.gov.pagopa.bizeventsservice.model.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": {
+ "it.gov.pagopa.bizeventsservice.model.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.MapEntry" : {
- "type" : "object",
- "properties" : {
- "key" : {
- "type" : "string"
- },
- "value" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.MapEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.response.Debtor"
- },
- "transferList" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.TransferPA"
+ "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.response.Debtor"
+ },
+ "transferList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.response.Payer"
+ "payer": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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"
+ "it.gov.pagopa.bizeventsservice.model.response.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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"
+ "it.gov.pagopa.bizeventsservice.model.response.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "it.gov.pagopa.bizeventsservice.model.response.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
}
}
},
- "it.gov.pagopa.bizeventsservice.model.AppInfo" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.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 c5016ce8..945c787c 100644
--- a/openapi/openapi_helpdesk.json
+++ b/openapi/openapi_helpdesk.json
@@ -1,1000 +1,1037 @@
{
- "openapi" : "3.0.1",
- "info" : {
- "title" : "@project.name@",
- "description" : "@project.description@",
- "termsOfService" : "https://www.pagopa.gov.it/",
- "version" : "@project.version@"
+ "openapi": "3.0.1",
+ "info": {
+ "title": "@project.name@",
+ "description": "@project.description@",
+ "termsOfService": "https://www.pagopa.gov.it/",
+ "version": "0.1.20"
},
- "servers" : [ {
- "url" : "http://localhost",
- "description" : "Generated server url"
- } ],
- "paths" : {
- "/info" : {
- "get" : {
- "tags" : [ "Home" ],
- "summary" : "health check",
- "description" : "Return OK if application is started",
- "operationId" : "healthCheck",
- "responses" : {
- "401" : {
- "description" : "Unauthorized",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "servers": [
+ {
+ "url": "http://localhost",
+ "description": "Generated server url"
+ }
+ ],
+ "paths": {
+ "/info": {
+ "get": {
+ "tags": [
+ "Home"
+ ],
+ "summary": "health check",
+ "description": "Return OK if application is started",
+ "operationId": "healthCheck",
+ "responses": {
+ "401": {
+ "description": "Unauthorized",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "200" : {
- "description" : "OK",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "200": {
+ "description": "OK",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.AppInfo"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "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/it.gov.pagopa.bizeventsservice.entity.BizEvent"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.BizEvent"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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 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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
}
},
- "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.",
- "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.",
+ "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" : {
- "200" : {
- "description" : "Obtained 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": {
+ "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/it.gov.pagopa.bizeventsservice.entity.BizEvent"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.BizEvent"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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 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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
}
},
- "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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
}
},
- "components" : {
- "schemas" : {
- "it.gov.pagopa.bizeventsservice.model.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": {
+ "it.gov.pagopa.bizeventsservice.model.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.AppInfo" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.AppInfo": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
},
- "version" : {
- "type" : "string"
+ "version": {
+ "type": "string"
},
- "environment" : {
- "type" : "string"
+ "environment": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.AuthRequest" : {
- "type" : "object",
- "properties" : {
- "authOutcome" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.BizEvent" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.DebtorPosition"
+ "debtorPosition": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.DebtorPosition"
},
- "creditor" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Creditor"
+ "creditor": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Creditor"
},
- "psp" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Psp"
+ "psp": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Psp"
},
- "debtor" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Debtor"
+ "debtor": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Debtor"
},
- "payer" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Payer"
+ "payer": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Payer"
},
- "paymentInfo" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentInfo"
+ "paymentInfo": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentInfo"
},
- "transferList" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transfer"
+ "transferList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transfer"
}
},
- "transactionDetails" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.TransactionDetails"
- },
- "eventStatus" : {
- "type" : "string",
- "enum" : [ "NA", "RETRY", "FAILED", "DONE" ]
- },
- "eventRetryEnrichmentCount" : {
- "type" : "integer",
- "format" : "int32"
+ "transactionDetails": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.TransactionDetails"
+ },
+ "eventStatus": {
+ "type": "string",
+ "enum": [
+ "NA",
+ "RETRY",
+ "FAILED",
+ "DONE"
+ ]
+ },
+ "eventRetryEnrichmentCount": {
+ "type": "integer",
+ "format": "int32"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Creditor" : {
- "type" : "object",
- "properties" : {
- "idPA" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Debtor" : {
- "type" : "object",
- "properties" : {
- "fullName" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.DebtorPosition" : {
- "type" : "object",
- "properties" : {
- "modelType" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.DebtorPosition": {
+ "type": "object",
+ "properties": {
+ "modelType": {
+ "type": "string"
},
- "noticeNumber" : {
- "type" : "string"
+ "noticeNumber": {
+ "type": "string"
},
- "iuv" : {
- "type" : "string"
+ "iuv": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Details" : {
- "type" : "object",
- "properties" : {
- "blurredNumber" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.Details": {
+ "type": "object",
+ "properties": {
+ "blurredNumber": {
+ "type": "string"
},
- "holder" : {
- "type" : "string"
+ "holder": {
+ "type": "string"
},
- "circuit" : {
- "type" : "string"
+ "circuit": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Info" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.InfoTransaction" : {
- "type" : "object",
- "properties" : {
- "brand" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.MBD" : {
- "type" : "object",
- "properties" : {
- "IUBD" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Payer" : {
- "type" : "object",
- "properties" : {
- "fullName" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.PaymentAuthorizationRequest" : {
- "type" : "object",
- "properties" : {
- "authOutcome" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.Details"
+ "details": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Details"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.PaymentInfo" : {
- "type" : "object",
- "properties" : {
- "paymentDateTime" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
},
- "IUR" : {
- "type" : "string"
+ "IUR": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Psp" : {
- "type" : "object",
- "properties" : {
- "idPsp" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Transaction" : {
- "type" : "object",
- "properties" : {
- "idTransaction" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.TransactionPsp"
+ "psp": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.TransactionPsp"
},
- "origin" : {
- "type" : "string"
+ "origin": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.TransactionDetails" : {
- "type" : "object",
- "properties" : {
- "user" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.User"
+ "it.gov.pagopa.bizeventsservice.entity.TransactionDetails": {
+ "type": "object",
+ "properties": {
+ "user": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.User"
},
- "paymentAuthorizationRequest" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentAuthorizationRequest"
+ "paymentAuthorizationRequest": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.PaymentAuthorizationRequest"
},
- "wallet" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.WalletItem"
+ "wallet": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.WalletItem"
},
- "origin" : {
- "type" : "string"
+ "origin": {
+ "type": "string"
},
- "transaction" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transaction"
+ "transaction": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Transaction"
},
- "info" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.InfoTransaction"
+ "info": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.InfoTransaction"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.TransactionPsp" : {
- "type" : "object",
- "properties" : {
- "idChannel" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.TransactionPsp": {
+ "type": "object",
+ "properties": {
+ "idChannel": {
+ "type": "string"
},
- "businessName" : {
- "type" : "string"
+ "businessName": {
+ "type": "string"
},
- "serviceName" : {
- "type" : "string"
+ "serviceName": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.Transfer" : {
- "type" : "object",
- "properties" : {
- "idTransfer" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.model.MapEntry"
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.MapEntry"
}
},
- "IBAN" : {
- "type" : "string"
+ "IBAN": {
+ "type": "string"
},
- "MBD" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.MBD"
+ "MBD": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.MBD"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.User" : {
- "type" : "object",
- "properties" : {
- "fullName" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.User": {
+ "type": "object",
+ "properties": {
+ "fullName": {
+ "type": "string"
},
- "type" : {
- "type" : "string",
- "enum" : [ "F", "G" ]
+ "type": {
+ "type": "string",
+ "enum": [
+ "F",
+ "G"
+ ]
},
- "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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.WalletItem" : {
- "type" : "object",
- "properties" : {
- "idWallet" : {
- "type" : "string"
- },
- "walletType" : {
- "type" : "string",
- "enum" : [ "CARD", "PAYPAL", "BANCOMATPAY" ]
- },
- "enableableFunctions" : {
- "type" : "array",
- "items" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.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/it.gov.pagopa.bizeventsservice.entity.Info"
+ "info": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.Info"
},
- "authRequest" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.AuthRequest"
+ "authRequest": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.AuthRequest"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.MapEntry" : {
- "type" : "object",
- "properties" : {
- "key" : {
- "type" : "string"
- },
- "value" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.MapEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "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.json b/openapi/openapi_io.json
index 03a00691..7a1f7fe8 100644
--- a/openapi/openapi_io.json
+++ b/openapi/openapi_io.json
@@ -1,646 +1,700 @@
{
- "openapi" : "3.0.1",
- "info" : {
- "title" : "@project.name@",
- "description" : "@project.description@",
- "termsOfService" : "https://www.pagopa.gov.it/",
- "version" : "@project.version@"
+ "openapi": "3.0.1",
+ "info": {
+ "title": "@project.name@",
+ "description": "@project.description@",
+ "termsOfService": "https://www.pagopa.gov.it/",
+ "version": "0.1.20"
},
- "servers" : [ {
- "url" : "http://localhost",
- "description" : "Generated server url"
- } ],
- "paths" : {
- "/transactions/{transaction-id}/disable" : {
- "post" : {
- "tags" : [ "IO Transactions REST APIs" ],
- "summary" : "Disable the transaction details given its id.",
- "operationId" : "disableTransaction",
- "parameters" : [ {
- "name" : "x-fiscal-code",
- "in" : "header",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "transaction-id",
- "in" : "path",
- "description" : "The id of the transaction.",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "servers": [
+ {
+ "url": "http://localhost",
+ "description": "Generated server url"
+ }
+ ],
+ "paths": {
+ "/transactions/{transaction-id}/disable": {
+ "post": {
+ "tags": [
+ "IO Transactions REST APIs"
+ ],
+ "summary": "Disable the transaction details given its id.",
+ "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" : {
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
},
- "200" : {
- "description" : "Disabled Transactions.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "200": {
+ "description": "Disabled Transactions.",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : { }
+ "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"
}
}
}
}
},
- "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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/transactions" : {
- "get" : {
- "tags" : [ "IO Transactions REST APIs" ],
- "summary" : "Retrieve the paged transaction list from biz events.",
- "operationId" : "getTransactionList",
- "parameters" : [ {
- "name" : "x-fiscal-code",
- "in" : "header",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "x-continuation-token",
- "in" : "header",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "size",
- "in" : "query",
- "required" : false,
- "schema" : {
- "type" : "integer",
- "format" : "int32",
- "default" : 10
+ "/transactions": {
+ "get": {
+ "tags": [
+ "IO Transactions REST APIs"
+ ],
+ "summary": "Retrieve the paged transaction list from biz events.",
+ "operationId": "getTransactionList",
+ "parameters": [
+ {
+ "name": "x-fiscal-code",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-continuation-token",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "size",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 10
+ }
}
- } ],
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "*/*": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
},
- "200" : {
- "description" : "Obtained transaction list.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "200": {
+ "description": "Obtained transaction list.",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
},
- "x-continuation-token" : {
- "description" : "continuation token for paginated query",
- "style" : "simple",
- "schema" : {
- "type" : "string"
+ "x-continuation-token": {
+ "description": "continuation token for paginated query",
+ "style": "simple",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem"
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem"
}
}
}
}
},
- "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"
}
}
}
}
},
- "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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/transactions/{transaction-id}" : {
- "get" : {
- "tags" : [ "IO Transactions REST APIs" ],
- "summary" : "Retrieve the transaction details given its id.",
- "operationId" : "getTransactionDetails",
- "parameters" : [ {
- "name" : "x-fiscal-code",
- "in" : "header",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "name" : "transaction-id",
- "in" : "path",
- "description" : "The id of the transaction.",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/transactions/{transaction-id}": {
+ "get": {
+ "tags": [
+ "IO Transactions REST APIs"
+ ],
+ "summary": "Retrieve the transaction details given its id.",
+ "operationId": "getTransactionDetails",
+ "parameters": [
+ {
+ "name": "x-fiscal-code",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "transaction-id",
+ "in": "path",
+ "description": "The id of the transaction.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
- } ],
- "responses" : {
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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"
}
}
}
},
- "200" : {
- "description" : "Obtained transaction details.",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "200": {
+ "description": "Obtained transaction details.",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.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"
}
}
}
}
},
- "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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
},
- "/info" : {
- "get" : {
- "tags" : [ "Home" ],
- "summary" : "health check",
- "description" : "Return OK if application is started",
- "operationId" : "healthCheck",
- "responses" : {
- "401" : {
- "description" : "Unauthorized",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "/info": {
+ "get": {
+ "tags": [
+ "Home"
+ ],
+ "summary": "health check",
+ "description": "Return OK if application is started",
+ "operationId": "healthCheck",
+ "responses": {
+ "401": {
+ "description": "Unauthorized",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
}
},
- "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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.ProblemJson"
}
}
}
},
- "200" : {
- "description" : "OK",
- "headers" : {
- "X-Request-Id" : {
- "description" : "This header identifies the call",
- "schema" : {
- "type" : "string"
+ "200": {
+ "description": "OK",
+ "headers": {
+ "X-Request-Id": {
+ "description": "This header identifies the call",
+ "schema": {
+ "type": "string"
}
}
},
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.AppInfo"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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/it.gov.pagopa.bizeventsservice.model.ProblemJson"
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.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.",
- "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.",
+ "schema": {
+ "type": "string"
+ }
}
- } ]
+ ]
}
},
- "components" : {
- "schemas" : {
- "it.gov.pagopa.bizeventsservice.model.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": {
+ "it.gov.pagopa.bizeventsservice.model.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionListItem" : {
- "type" : "object",
- "properties" : {
- "transactionId" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.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"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.view.UserDetail" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "taxCode" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.view.UserDetail": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "taxCode": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.entity.view.WalletInfo" : {
- "type" : "object",
- "properties" : {
- "accountHolder" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.entity.view.WalletInfo": {
+ "type": "object",
+ "properties": {
+ "accountHolder": {
+ "type": "string"
},
- "brand" : {
- "type" : "string"
+ "brand": {
+ "type": "string"
},
- "blurredNumber" : {
- "type" : "string"
+ "blurredNumber": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem" : {
- "type" : "object",
- "properties" : {
- "subject" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem": {
+ "type": "object",
+ "properties": {
+ "subject": {
+ "type": "string"
},
- "amount" : {
- "type" : "string"
+ "amount": {
+ "type": "string"
},
- "payee" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
+ "payee": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
},
- "debtor" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
+ "debtor": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
},
- "refNumberValue" : {
- "type" : "string"
+ "refNumberValue": {
+ "type": "string"
},
- "refNumberType" : {
- "type" : "string"
+ "refNumberType": {
+ "type": "string"
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction" : {
- "type" : "object",
- "properties" : {
- "transactionId" : {
- "type" : "string"
- },
- "authCode" : {
- "type" : "string"
- },
- "rrn" : {
- "type" : "string"
- },
- "transactionDate" : {
- "type" : "string"
- },
- "pspName" : {
- "type" : "string"
- },
- "walletInfo" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.WalletInfo"
- },
- "paymentMethod" : {
- "type" : "string",
- "enum" : [ "BBT", "BP", "AD", "CP", "PO", "OBEP", "JIF", "MYBK", "PPAL", "UNKNOWN" ]
- },
- "payer" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
- },
- "amount" : {
- "type" : "string"
- },
- "fee" : {
- "type" : "string"
- },
- "origin" : {
- "type" : "string",
- "enum" : [ "INTERNAL", "PM", "NDP001PROD", "NDP002PROD", "NDP003PROD", "UNKNOWN" ]
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction": {
+ "type": "object",
+ "properties": {
+ "transactionId": {
+ "type": "string"
+ },
+ "authCode": {
+ "type": "string"
+ },
+ "rrn": {
+ "type": "string"
+ },
+ "transactionDate": {
+ "type": "string"
+ },
+ "pspName": {
+ "type": "string"
+ },
+ "walletInfo": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.WalletInfo"
+ },
+ "paymentMethod": {
+ "type": "string",
+ "enum": [
+ "BBT",
+ "BP",
+ "AD",
+ "CP",
+ "PO",
+ "OBEP",
+ "JIF",
+ "MYBK",
+ "PPAL",
+ "UNKNOWN"
+ ]
+ },
+ "payer": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.entity.view.UserDetail"
+ },
+ "amount": {
+ "type": "string"
+ },
+ "fee": {
+ "type": "string"
+ },
+ "origin": {
+ "type": "string",
+ "enum": [
+ "INTERNAL",
+ "PM",
+ "NDP001PROD",
+ "NDP002PROD",
+ "NDP003PROD",
+ "UNKNOWN"
+ ]
}
}
},
- "it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse" : {
- "type" : "object",
- "properties" : {
- "infoTransaction" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction"
- },
- "carts" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem"
+ "it.gov.pagopa.bizeventsservice.model.response.transaction.TransactionDetailResponse": {
+ "type": "object",
+ "properties": {
+ "infoTransaction": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.InfoTransaction"
+ },
+ "carts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/it.gov.pagopa.bizeventsservice.model.response.transaction.CartItem"
}
}
}
},
- "it.gov.pagopa.bizeventsservice.model.AppInfo" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
+ "it.gov.pagopa.bizeventsservice.model.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/pom.xml b/pom.xml
index bec2059e..003f3acc 100644
--- a/pom.xml
+++ b/pom.xml
@@ -11,7 +11,7 @@
it.gov.pagopa
bizeventsservice
- 0.1.19
+ 0.1.20
Biz-Events Service
Microservice for exposing REST APIs about payment receipts.