GET api/OuterGatePagoPa/VerifyDebtPosition?noticeNumber={noticeNumber}&PAIdentifier={PAIdentifier}&typeOfBulletin={typeOfBulletin}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
noticeNumber

string

Required
PAIdentifier

string

Required
typeOfBulletin

TypesOfBulletin

None.

Body Parameters

None.

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

OuterVerifyDebtPositionOut
NameDescriptionTypeAdditional information
TotalAmount

decimal number

None.
Cause

Causale del versamento (arriva direttamente dalla PA in risposta della verifica

 string

None.
PayeeName

CodiceContestoPagamento o RRN univoco si compone con Anno+IdTransazione.

 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: 
{
  "TotalAmount": 1.0,
  "Cause": "sample string 2",
  "PayeeName": "sample string 3",
  "PayeeLocation": "sample string 4",
  "PayeeFiscalCodeOrVatNumber": "sample string 5",
  "IUV": "sample string 6",
  "PAIdentifier": "sample string 7",
  "ErrorCode": "sample string 8",
  "ErrorDescription": "sample string 9"
}

application/xml, text/xml

Sample: 
<OuterVerifyDebtPositionOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PagoPa">
  <ErrorCode>sample string 8</ErrorCode>
  <ErrorDescription>sample string 9</ErrorDescription>
  <PAIdentifier>sample string 7</PAIdentifier>
  <Cause>sample string 2</Cause>
  <IUV>sample string 6</IUV>
  <PayeeFiscalCodeOrVatNumber>sample string 5</PayeeFiscalCodeOrVatNumber>
  <PayeeLocation>sample string 4</PayeeLocation>
  <PayeeName>sample string 3</PayeeName>
  <TotalAmount>1</TotalAmount>
</OuterVerifyDebtPositionOut>