POST api/OuterGateF24/Validate

Valida la richiesta di un pagamento F24 semplice, se l'operazione riesce viene restituisce il pre-scontrino.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerSepafinId	Id intestatario bollettino obbligatorio	integer	Required
CustomerAlternativeAddressId	Id dell'indirizzo alternativo del cliente intestatario del bollettino	integer	None.
CustomerExecutorId	L'ID del cliente inserito	integer	None.
CustomerExecutorLastNameOrBusinessName	Cognome del pagatore o ragione sociale	string	None.
CustomerExecutorName	Nome del pagatore	string	None.
CustomerExecutorSepafinId	Id del cliente esecutore del bollettino	integer	Required
CreatedByIpAddress	Indirizzo IP di chi sta effettuando la richiesta	string	Required Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
ExecutionDate	Data esecuzione del pagamento	date time	Required
DocumentAmount	Totale documento	decimal number	Required
Currency	Valuta (EUR)	string	Required
OfficeCode	Codice ufficio	string	None.
OperationCode	Codice operazione	string	None.
DeedCode	Codice tributo	string	None.
PayerAgentFiscalCode	Codice fiscale Coobbligato	string	Fiscal code validation String length: inclusive between 0 and 16
PayerAgentIDCode	Codice identificativo coobbligato	PayerAgentTypeEnum	None.
Taxes	Elenco tasse del pagamento	Collection of OuterSimpleF24Tax	Required

Request Formats

application/json, text/json

Sample:

{
  "CustomerSepafinId": 1,
  "CustomerAlternativeAddressId": 1,
  "CustomerExecutorId": 1,
  "CustomerExecutorLastNameOrBusinessName": "sample string 1",
  "CustomerExecutorName": "sample string 2",
  "CustomerExecutorSepafinId": 1,
  "CreatedByIpAddress": "sample string 3",
  "ExecutionDate": "2025-05-14T03:03:05.9369834+02:00",
  "DocumentAmount": 5.0,
  "Currency": "sample string 6",
  "OfficeCode": "sample string 7",
  "OperationCode": "sample string 8",
  "DeedCode": "sample string 9",
  "PayerAgentFiscalCode": "sample string 10",
  "PayerAgentIDCode": 2,
  "Taxes": [
    {
      "Section": "sample string 1",
      "TaxCode": "sample string 2",
      "ReceiverCode": "sample string 3",
      "IsAmendment": true,
      "IsRealEstateVariation": true,
      "IsDeposit": true,
      "IsFinalPayment": true,
      "RealEstateCount": 1,
      "ReferenceMonth": "sample string 4",
      "ReferenceYear": "sample string 5",
      "DeductionAmount": 1.0,
      "TaxAmount": 1.0,
      "CompensationAmount": 1.0
    },
    {
      "Section": "sample string 1",
      "TaxCode": "sample string 2",
      "ReceiverCode": "sample string 3",
      "IsAmendment": true,
      "IsRealEstateVariation": true,
      "IsDeposit": true,
      "IsFinalPayment": true,
      "RealEstateCount": 1,
      "ReferenceMonth": "sample string 4",
      "ReferenceYear": "sample string 5",
      "DeductionAmount": 1.0,
      "TaxAmount": 1.0,
      "CompensationAmount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<OuterSimpleF24ValidateIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.SimpleF24">
  <CreatedByIpAddress>sample string 3</CreatedByIpAddress>
  <Currency>sample string 6</Currency>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <CustomerExecutorId>1</CustomerExecutorId>
  <CustomerExecutorLastNameOrBusinessName>sample string 1</CustomerExecutorLastNameOrBusinessName>
  <CustomerExecutorName>sample string 2</CustomerExecutorName>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <DeedCode>sample string 9</DeedCode>
  <DocumentAmount>5</DocumentAmount>
  <ExecutionDate>2025-05-14T03:03:05.9369834+02:00</ExecutionDate>
  <OfficeCode>sample string 7</OfficeCode>
  <OperationCode>sample string 8</OperationCode>
  <PayerAgentFiscalCode>sample string 10</PayerAgentFiscalCode>
  <PayerAgentIDCode>Type01</PayerAgentIDCode>
  <Taxes>
    <OuterSimpleF24Tax>
      <CompensationAmount>1</CompensationAmount>
      <DeductionAmount>1</DeductionAmount>
      <IsAmendment>true</IsAmendment>
      <IsDeposit>true</IsDeposit>
      <IsFinalPayment>true</IsFinalPayment>
      <IsRealEstateVariation>true</IsRealEstateVariation>
      <RealEstateCount>1</RealEstateCount>
      <ReceiverCode>sample string 3</ReceiverCode>
      <ReferenceMonth>sample string 4</ReferenceMonth>
      <ReferenceYear>sample string 5</ReferenceYear>
      <Section>sample string 1</Section>
      <TaxAmount>1</TaxAmount>
      <TaxCode>sample string 2</TaxCode>
    </OuterSimpleF24Tax>
    <OuterSimpleF24Tax>
      <CompensationAmount>1</CompensationAmount>
      <DeductionAmount>1</DeductionAmount>
      <IsAmendment>true</IsAmendment>
      <IsDeposit>true</IsDeposit>
      <IsFinalPayment>true</IsFinalPayment>
      <IsRealEstateVariation>true</IsRealEstateVariation>
      <RealEstateCount>1</RealEstateCount>
      <ReceiverCode>sample string 3</ReceiverCode>
      <ReferenceMonth>sample string 4</ReferenceMonth>
      <ReferenceYear>sample string 5</ReferenceYear>
      <Section>sample string 1</Section>
      <TaxAmount>1</TaxAmount>
      <TaxCode>sample string 2</TaxCode>
    </OuterSimpleF24Tax>
  </Taxes>
</OuterSimpleF24ValidateIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterSimpleF24ValidateOut

Name	Description	Type	Additional information
IdValidation	Identificativo della richiesta di validazione	integer	None.
OperationCode	Codice identificativo univoco	string	None.
FeeAmount	Commissioni	decimal number	None.
PreReceiptData	Dati in base 64 della pre-ricevuta	Collection of byte	None.

Response Formats

application/json, text/json

Sample:

{
  "IdValidation": 1,
  "OperationCode": "sample string 2",
  "FeeAmount": 3.0,
  "PreReceiptData": "QEA="
}

application/xml, text/xml

Sample:

<OuterSimpleF24ValidateOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.SimpleF24">
  <FeeAmount>3</FeeAmount>
  <IdValidation>1</IdValidation>
  <OperationCode>sample string 2</OperationCode>
  <PreReceiptData>QEA=</PreReceiptData>
</OuterSimpleF24ValidateOut>