POST api/OuterGatePagoPa/CheckVerificationDebtPositionForPagoPa

Messaggio di richiesta di Verifica Posizione Debitoria per tributi PagoPa, PagoPa PRA e PagoPa Bollo. Nel modello in ingresso i parametri NoticeNumber(numero di avviso) e PAIdentifier(codice fiscale o partita IVA ente) sono indispensabili per poter effettuare la richiesta. Invece per distinguere il tipo di PagoPa bisognerà valorizzare la proprietà TypeOfBulletin. Valori ammessi per TypesOfBulletin: TypesOfBulletin.PagoPa (PagoPa generico [50]), TypesOfBulletin.PagoPaBollo (PagoPa Bollo [53]), TypesOfBulletin.PagoPaPra (PagoPa PRA [52]). In caso di risposta positiva si dovrà confermare la richiesta con la chiamata "api/OuterGatePagoPa/ConfirmTransaction" oppure annullare la richiesta con la chiamata "api/OuterGatePagoPa/CancelCheckVerificationDebtPosition". Sempre in caso di risposta positiva si otterranno tutte le informazioni relative a questo pagamento: importo, commissioni, totale, tipologia e info cliente. In caso di esito negativo si avrà una risposta http con stato 4xx o 5xx a seconda dei vari esiti problemi riscontrati

Request Information

URI Parameters

None.

Body Parameters

Modello di input per la richiesta di verifica della posizione debitoria.

OuterCheckVerificationDebtPositionForPagoPaModelIn

Name	Description	Type	Additional information
NoticeNumber	NumeroAvviso da 1 a 18 caratteri	string	Required String length: inclusive between 0 and 18
PAIdentifier	Identificativo PA (codice fiscale o partita IVA Ente) da 1 a 16 caratteri	string	String length: inclusive between 0 and 11
TypeOfBulletin	Tipo di servizio default PagoPA generico[50]. Valori ammessi: TypesOfBulletin.PagoPa (PagoPa generico [50]), TypesOfBulletin.PagoPaBollo (PagoPa Bollo [52]), TypesOfBulletin.PagoPaPra (PagoPa PRA [53])	TypesOfBulletin	None.
CustomData1		string	None.
CustomData2		string	None.
CustomData3		string	None.
IdempotencyKey		string	None.
CreatedByIpAddress	Indirizzo IP	string	Required Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
PaymentType		PaymentType	None.
CustomerSepafinId	Id del cliente ordinante del pagamento	integer	None.
CustomerExecutorSepafinId	Id del cliente esecutore del pagamento	integer	None.
CustomerAlternativeAddressId	Id dell'indirizzo alternativo del cliente ordinante del pagamento	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "NoticeNumber": "sample string 1",
  "PAIdentifier": "sample string 2",
  "TypeOfBulletin": 0,
  "ExternalAgencyId": "sample string 3",
  "HttpRequestTransactionId": "sample string 4",
  "CustomData1": "sample string 5",
  "CustomData2": "sample string 6",
  "CustomData3": "sample string 7",
  "IdempotencyKey": "sample string 8",
  "CreatedByIpAddress": "sample string 9",
  "PaymentType": 0,
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CustomerAlternativeAddressId": 1
}

application/xml, text/xml

Sample:

<OuterCheckVerificationDebtPositionForPagoPaModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PagoPa">
  <CreatedByIpAddress>sample string 9</CreatedByIpAddress>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <ExpirationTime>1</ExpirationTime>
  <PaymentType>Cash</PaymentType>
  <CustomData1>sample string 5</CustomData1>
  <CustomData2>sample string 6</CustomData2>
  <CustomData3>sample string 7</CustomData3>
  <ExternalAgencyId>sample string 3</ExternalAgencyId>
  <HttpRequestTransactionId>sample string 4</HttpRequestTransactionId>
  <IdempotencyKey>sample string 8</IdempotencyKey>
  <NoticeNumber>sample string 1</NoticeNumber>
  <PAIdentifier>sample string 2</PAIdentifier>
  <TypeOfBulletin>Mav</TypeOfBulletin>
</OuterCheckVerificationDebtPositionForPagoPaModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

OK (200 - Richiesta eseguita correttamente, verrà ritornato il modello di risposta)
MethodNotAllowed (405 - L'utente che sta svolgendo l'operazione non è associato a un PO)
NotAcceptable (406 - I dati di input non sono conformi)
BadRequest (400 - La richiesta è stata rifiutata dal servizio esterno)
InternalServerError (500 - La richiesta non è stata effettuata a causa di un errore interno)
RequestTimeout (408 - La richiesta verso un servizio esterno è andata in timeout)

Resource Description

OuterCheckVerificationDebtPositionOut

Name	Description	Type	Additional information
CheckVerificationDebtPositionId	Identificativo interno della verifica della posizione debitoria	integer	None.
CustomerExecutorSepafinId	Id del cliente esecutore	integer	None.
CustomerSepafinId	Id del cliente ordinante	integer	None.
CustomerName	cliente (nome)	string	None.
CustomerLastNameOrBusinessName	Cliente (cognome o ragione sociale)	string	None.
CustomerAlternativeAddressId	Id dell 'indirizzo alternativo del cliente ordinante	integer	None.
CustomerAddress	Indirizzo	string	None.
CustomerCity	Città	string	None.
CustomerCountry	Nazione	string	None.
CustomerZipCode	Cap	string	None.
CustomerCredentials	CredenzialiPagatore: Dati relativi al soggetto pagatore identificato con il proprio CF ricevuto in risposta alla verifica	string	None.
Amount	Importo senza commissioni (arriva direttamente dalla risposta della check)	decimal number	None.
FeesAmount	Commissioni su operazione	decimal number	None.
TotalAmount	Totale dovuto	decimal number	None.
Cause	Causale del versamento (arriva direttamente dalla PA in risposta della verifica	string	None.
RRN	CodiceContestoPagamento o RRN univoco si compone con Anno+IdTransazione.	string	None.
PayeeName	Denominazione Beneficiario o Ente (arriva direttamente dalla risposta della check)	string	None.
PayeeLocation	Località Beneficiario o Ente (arriva direttamente dalla risposta della check)	string	None.
PayeeFiscalCodeOrVatNumber	CodiceFiscaleOrCFPABeneficaria Beneficiario o Ente (arriva direttamente dalla risposta dalla verifica)	string	None.
IUV	Codice IUV	string	None.
PAIdentifier	Identificativo PA (codice fiscale o partita IVA Ente) da 1 a 16 caratteri	string	None.
ErrorCode	Codice dell'esito dell'operazione, attesta che la Pa ha risposto in maniera positiva (In caso di esito positivo sarà restituito il valore E000001, altrimenti verrà generata un'eccezione)	string	None.
ErrorDescription	Messaggio dell'esito dell'operazione, attesta che la PA ha risposto in maniera positiva (In caso di esito positivo sarà restituito il valore "Esito positivo da parte di EasyChannel", altrimenti verrà generata un'eccezione)	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CheckVerificationDebtPositionId": 1,
  "CustomerExecutorSepafinId": 2,
  "CustomerSepafinId": 3,
  "CustomerName": "sample string 4",
  "CustomerLastNameOrBusinessName": "sample string 5",
  "CustomerAlternativeAddressId": 1,
  "CustomerAddress": "sample string 6",
  "CustomerCity": "sample string 7",
  "CustomerCountry": "sample string 8",
  "CustomerZipCode": "sample string 9",
  "CustomerCredentials": "sample string 10",
  "Amount": 11.0,
  "FeesAmount": 12.0,
  "TotalAmount": 13.0,
  "Cause": "sample string 14",
  "RRN": "sample string 15",
  "PayeeName": "sample string 16",
  "PayeeLocation": "sample string 17",
  "PayeeFiscalCodeOrVatNumber": "sample string 18",
  "IUV": "sample string 19",
  "PAIdentifier": "sample string 20",
  "ErrorCode": "sample string 21",
  "ErrorDescription": "sample string 22"
}

application/xml, text/xml

Sample:

<OuterCheckVerificationDebtPositionOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PagoPa">
  <ErrorCode>sample string 21</ErrorCode>
  <ErrorDescription>sample string 22</ErrorDescription>
  <PAIdentifier>sample string 20</PAIdentifier>
  <Amount>11</Amount>
  <Cause>sample string 14</Cause>
  <CheckVerificationDebtPositionId>1</CheckVerificationDebtPositionId>
  <CustomerAddress>sample string 6</CustomerAddress>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <CustomerCity>sample string 7</CustomerCity>
  <CustomerCountry>sample string 8</CustomerCountry>
  <CustomerCredentials>sample string 10</CustomerCredentials>
  <CustomerExecutorSepafinId>2</CustomerExecutorSepafinId>
  <CustomerLastNameOrBusinessName>sample string 5</CustomerLastNameOrBusinessName>
  <CustomerName>sample string 4</CustomerName>
  <CustomerSepafinId>3</CustomerSepafinId>
  <CustomerZipCode>sample string 9</CustomerZipCode>
  <FeesAmount>12</FeesAmount>
  <IUV>sample string 19</IUV>
  <PayeeFiscalCodeOrVatNumber>sample string 18</PayeeFiscalCodeOrVatNumber>
  <PayeeLocation>sample string 17</PayeeLocation>
  <PayeeName>sample string 16</PayeeName>
  <RRN>sample string 15</RRN>
  <TotalAmount>13</TotalAmount>
</OuterCheckVerificationDebtPositionOut>