POST api/OuterGatePagoPa/CheckVerificationDebtPositionForPassports

Messaggio di richiesta di Verifica Posizione Debitoria per pagamento Passaporti tramite PagoPA.Nel modello di input devono essere presenti i codici fiscali necessari alla richiesta del numero di avviso.Il numero di avviso verrà generato a partire dai codici fiscali forniti e validato tramite il servizio PagoPA. In caso di risposta positiva si dovrà confermare la richiesta con la chiamata "api/OuterGatePagoPa/ConfirmTransaction" oppure annullare la richiesta con "api/OuterGatePagoPa/CancelCheckVerificationDebtPosition".

Request Information

URI Parameters

None.

Body Parameters

The model.

OuterCheckVerificationDebtPositionForPassportModelIn

Name	Description	Type	Additional information
Pagatore	Dati del soggetto pagatore.	PassportPayerModel	Required
Intestatario	Dati del soggetto intestatario della pratica di passaporto.	PassportHolderModel	Required
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:

{
  "Pagatore": {
    "CodiceFiscale": "sample string 1",
    "Denominazione": "sample string 2"
  },
  "Intestatario": {
    "CodiceFiscale": "sample string 1",
    "Denominazione": "sample string 2"
  },
  "CreatedByIpAddress": "sample string 1",
  "PaymentType": 0,
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CustomerAlternativeAddressId": 1
}

application/xml, text/xml

Sample:

<OuterCheckVerificationDebtPositionForPassportModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PagoPa">
  <CreatedByIpAddress>sample string 1</CreatedByIpAddress>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <ExpirationTime>1</ExpirationTime>
  <PaymentType>Cash</PaymentType>
  <Intestatario>
    <CodiceFiscale>sample string 1</CodiceFiscale>
    <Denominazione>sample string 2</Denominazione>
  </Intestatario>
  <Pagatore>
    <CodiceFiscale>sample string 1</CodiceFiscale>
    <Denominazione>sample string 2</Denominazione>
  </Pagatore>
</OuterCheckVerificationDebtPositionForPassportModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

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.
NoticeNumberResp	NoticeNumber from the response with no FramePlate and TypeOfVehicle for Bollo, or the same NoticeNumber from the request for PagoPa	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",
  "NoticeNumberResp": "sample string 20",
  "PAIdentifier": "sample string 21",
  "ErrorCode": "sample string 22",
  "ErrorDescription": "sample string 23"
}

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 22</ErrorCode>
  <ErrorDescription>sample string 23</ErrorDescription>
  <PAIdentifier>sample string 21</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>
  <NoticeNumberResp>sample string 20</NoticeNumberResp>
  <PayeeFiscalCodeOrVatNumber>sample string 18</PayeeFiscalCodeOrVatNumber>
  <PayeeLocation>sample string 17</PayeeLocation>
  <PayeeName>sample string 16</PayeeName>
  <RRN>sample string 15</RRN>
  <TotalAmount>13</TotalAmount>
</OuterCheckVerificationDebtPositionOut>