POST api/OuterGatePagoPaPis/PaymentRequest

Generate payment link for PagoPa with PIS

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PayerName		string	None.
PayerSurname		string	None.
PayerEmail		string	None.
DebtorIban		string	None.
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:

{
  "PayerName": "sample string 1",
  "PayerSurname": "sample string 2",
  "PayerEmail": "sample string 3",
  "DebtorIban": "sample string 4",
  "NoticeNumber": "sample string 5",
  "PAIdentifier": "sample string 6",
  "TypeOfBulletin": 0,
  "ExternalAgencyId": "sample string 7",
  "HttpRequestTransactionId": "sample string 8",
  "CustomData1": "sample string 9",
  "CustomData2": "sample string 10",
  "CustomData3": "sample string 11",
  "IdempotencyKey": "sample string 12",
  "CreatedByIpAddress": "sample string 13",
  "PaymentType": 0,
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CustomerAlternativeAddressId": 1
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterPagoPaPisPayModelOut

Name	Description	Type	Additional information
Url		string	None.
PaymentOrderId		string	None.
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:

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

application/xml, text/xml

Sample:

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