generated from pagopa/template-payments-java-repository
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
527 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,302 @@ | ||
openapi: 3.0.3 | ||
info: | ||
version: 0.6.0 | ||
title: Pagopa ACA | ||
description: pagoPA ACA microservice pagoPA ACA microservice contains the api to allow the creation of a new debt position. | ||
contact: | ||
name: pagoPA - Touchpoints team | ||
servers: | ||
- url: https://api.uat.platform.pagopa.it/aca/v1 | ||
description: paCreatePosition Test environment | ||
- url: https://api.platform.pagopa.it/aca/v1 | ||
description: paCreatePosition Prod environment | ||
tags: | ||
- name: ACA | ||
description: API's for performing a debt position census | ||
paths: | ||
/paCreatePosition: | ||
post: | ||
parameters: | ||
- in: query | ||
name: segregationCodes | ||
required: false | ||
schema: | ||
type: string | ||
description: Segregation codes for which broker is authorized | ||
tags: | ||
- ACA | ||
operationId: newDebtPosition | ||
summary: Create a new debt position | ||
description: Create a new debt position. | ||
requestBody: | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/NewDebtPositionRequest' | ||
responses: | ||
'200': | ||
description: New debt position successfully created or updated | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/DebtPositionResponse' | ||
'400': | ||
description: Formally invalid input | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ProblemJson' | ||
example: | ||
value: | ||
invalidInput: | ||
type: https://example.com/problem/ | ||
title: string | ||
status: 400 | ||
detail: Formally invalid input | ||
'404': | ||
description: Entity not found | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ProblemJson' | ||
examples: | ||
iupd_not_found: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Invocation exception | ||
status: 404 | ||
detail: Error while invalidate debit position. Debit position not found with {iupd} | ||
pa_fiscal_code_not_found: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Invocation exception | ||
status: 404 | ||
detail: No debt position found with Creditor institution code {creditorInstitutionCode} and {iupd} | ||
'422': | ||
description: Can not perform the requested action on debit position | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ProblemJson' | ||
example: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Unprocessable request | ||
status: 422 | ||
detail: Can not perform the requested action on debit position | ||
'409': | ||
description: Conflict into requested action | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ProblemJson' | ||
examples: | ||
create: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Invocation exception | ||
status: 409 | ||
detail: Error while create new debit position conflict into request | ||
update: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Invocation exception | ||
status: 409 | ||
detail: Error while update debit position conflict into request | ||
invalidate: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Invocation exception | ||
status: 409 | ||
detail: Error while invalidate debit position conflict into request | ||
unauthorized_action: | ||
value: | ||
type: https://example.com/problem/ | ||
title: Unauthorized action | ||
status: 409 | ||
detail: Unauthorized action on debt position with iuv {iuv} | ||
'502': | ||
description: Bad gateway | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ProblemJson' | ||
example: | ||
value: | ||
type: https://example.com/problem/ | ||
title: string | ||
status: 502 | ||
detail: Bad gateway, error while execute request | ||
'500': | ||
description: Internal server error | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ProblemJson' | ||
example: | ||
value: | ||
type: https://example.com/problem/ | ||
title: string | ||
status: 500 | ||
detail: Internal server error | ||
components: | ||
schemas: | ||
NewDebtPositionRequest: | ||
type: object | ||
required: | ||
- paFiscalCode | ||
- entityType | ||
- entityFiscalCode | ||
- entityFullName | ||
- iuv | ||
- amount | ||
- description | ||
- expirationDate | ||
description: Request body for creating a new transaction | ||
properties: | ||
paFiscalCode: | ||
type: string | ||
example: "12345678910" | ||
minLength: 11 | ||
maxLength: 11 | ||
entityType: | ||
type: string | ||
example: "G" | ||
enum: | ||
- F | ||
- G | ||
entityFiscalCode: | ||
type: string | ||
example: "12345678910" | ||
minLength: 2 | ||
entityFullName: | ||
type: string | ||
example: "Full Name" | ||
minLength: 1 | ||
maxLength: 255 | ||
iuv: | ||
type: string | ||
example: "00000000000000000" | ||
minLength: 1 | ||
maxLength: 255 | ||
nav: | ||
type: string | ||
example: "30000000000000000" | ||
minLength: 1 | ||
maxLength: 255 | ||
description: |- | ||
notice number, if not specified it will created using the following pattern: 3 + iuv | ||
amount: | ||
$ref: '#/components/schemas/AmountEuroCents' | ||
description: | ||
type: string | ||
example: "ACA Debt Position description" | ||
minLength: 1 | ||
maxLength: 255 | ||
expirationDate: | ||
type: string | ||
format: date-time | ||
iban: | ||
type: string | ||
example: "IT0000000000000000000000000" | ||
minLength: 27 | ||
maxLength: 27 | ||
postalIban: | ||
type: string | ||
example: "IT60X0542811101000000123456" | ||
minLength: 27 | ||
maxLength: 27 | ||
switchToExpired: | ||
type: boolean | ||
example: true | ||
default: false | ||
payStandIn: | ||
type: boolean | ||
example: true | ||
default: true | ||
|
||
DebtPositionResponse: | ||
type: object | ||
properties: | ||
paFiscalCode: | ||
type: string | ||
companyName: | ||
type: string | ||
entityType: | ||
type: string | ||
entityFiscalCode: | ||
type: string | ||
entityFullName: | ||
type: string | ||
iuv: | ||
type: string | ||
nav: | ||
type: string | ||
amount: | ||
type: integer | ||
format: int64 | ||
description: | ||
type: string | ||
expirationDate: | ||
type: string | ||
format: local-date-time | ||
iban: | ||
type: string | ||
postalIban: | ||
type: string | ||
switchToExpired: | ||
type: boolean | ||
status: | ||
type: string | ||
AmountEuroCents: | ||
description: Amount for payments, in eurocents | ||
type: integer | ||
example: 100 | ||
minimum: 0 | ||
maximum: 99999999999 | ||
ProblemJson: | ||
type: object | ||
properties: | ||
type: | ||
type: string | ||
format: uri | ||
description: |- | ||
An absolute URI that identifies the problem type. When dereferenced, | ||
it SHOULD provide human-readable documentation for the problem type | ||
(e.g., using HTML). | ||
default: about:blank | ||
example: https://example.com/problem/ | ||
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: | ||
type: integer | ||
format: int32 | ||
description: |- | ||
The HTTP status code generated by the origin server for this occurrence | ||
of the problem. | ||
minimum: 100 | ||
maximum: 600 | ||
exclusiveMaximum: true | ||
example: 400 | ||
detail: | ||
type: string | ||
description: |- | ||
A human readable explanation specific to this occurrence of the | ||
problem. | ||
instance: | ||
type: string | ||
format: uri | ||
description: |- | ||
An absolute URI that identifies the specific occurrence of the problem. | ||
It may or may not yield further information if dereferenced. | ||
securitySchemes: | ||
ApiKey: | ||
type: apiKey | ||
description: The API key to access this function app. | ||
name: Ocp-Apim-Subscription-Key | ||
in: header |
Oops, something went wrong.