POST api/OuterGateBookingBulletin/CreateCartOrAddToCart

Crea un carrello o aggiunge un pagamento al carrello. Se il parametro uniqueCodeOfCart viene valorizzato, allora se esiste un carrello valido corrispondente al codice, non verrà creato un nuovo carrello ma verrà aggiunto il pagamento al carrello esistente

Request Information

URI Parameters

None.

Body Parameters

Modello di input per aggiungere un pagamento alla prenotazione

OuterBookingBulletinModelIn

Name	Description	Type	Additional information
DenominationUserRegistered	Denominazione dell'utente, se non passato sulla ricevuta verrà mostrato Gentile Cliente	string	None.
CustomTags	Lista dei CustomTag	Collection of OuterBillerCustomTagModelIn	None.
MetaTags	Lista dei MetaTag	Collection of OuterBillerMetaTagModelIn	None.
PayeeCcp	Numero di conto corrente del beneficiario	long integer	Required
TypeBookingBulletin	Tipologia di pagamento della prenotazione	TypeBookingBulletin	Required
TransferAmount	Importo della transazione	decimal number	Required Data type: Currency Matching regular expression pattern: ^[0-9]+([.,][0-9]{0,2})?$ Range: inclusive between 0,01 and 1E+15
Cause	Causale.Se ci sono dei CUSTOM TAG, la CAUSALE LIBERA viene ignorata. Se NON ci sono dei CUSTOM TAG, la CAUSALE LIBERA se valorizzata viene inserita nella causale effettiva del bonifico, quindi è obbligatorio farla inserire al cliente per evitare problemi di riconciliazione con il Biller. I META TAG possono essere presenti sempre, sia quando ci sono i CUSTOM TAG che la CAUSALE LIBERA, non influiscono sulla causale custom o libera.	string	Matching regular expression pattern: ^[a-zA-Z0-9\-_?()+ ,;'=$%@\.]$ String length: inclusive between 0 and 60
BankPaymentSlipCode	Codice del bollettino	string	None.
CustomerLastNameOrBusinessName	Cognome o ragione sociale del cliente. OBBLIGATORIO PER TUTTI I BOLLETTINI A ECCEZIONE DEGLI 896	string	String length: inclusive between 0 and 35
CustomerName	Nome del cliente	string	String length: inclusive between 0 and 35
CustomerAddress	Indirizzo e numero civico della residenza o domicilio del cliente OBBLIGATORIO PER TUTTI I BOLLETTINI A ECCEZIONE DEGLI 896	string	String length: inclusive between 0 and 255
CustomerCap	CAP della residenza o domicilio del cliente	string	Max length: 5 Min length: 5
CustomerCity	Città della residenza o domicilio del cliente OBBLIGATORIO PER TUTTI I BOLLETTINI A ECCEZIONE DEGLI 896	string	String length: inclusive between 0 and 50
CustomerProvince	Provincia della residenza o domicilio del cliente	string	Max length: 2 Min length: 2
CustomerTwoLetterISOLanguageName	Nome ISO a due lettere della nazione (Italia = IT) della residenza o domicilio del cliente OBBLIGATORIO PER TUTTI I BOLLETTINI A ECCEZIONE DEGLI 896	string	String length: inclusive between 0 and 2
CustomerFiscalCode	Il codice fiscale del cliente	string	Fiscal code validation String length: inclusive between 0 and 16
CustomerDateOfBirth	Data di nascita	date time	None.
CustomerGender	Sesso	GenderType	None.
CustomerVatNumber	La P.IVA del cliente (es. IT07783020725)	string	String length: inclusive between 0 and 13 Vat number validation: string start with TwoLetterISOLanguageName (ex. IT07783020725)
CustomerPersonType	Tipologia di persona (persona fisica "F", persona giuridica "G") OBBLIGATORIO PER TUTTI I BOLLETTINI A ECCEZIONE DEGLI 896	string	Matching regular expression pattern: F\|G String length: inclusive between 0 and 1
ForceDuplicates	Se Passato true in caso di pagamento di bollettini duplicati non sarà possibile effettuare lo storno del pagamento	boolean	None.
CustomData1	Custom Data	string	None.
CustomData2	Custom Data	string	None.
CustomData3	Custom Data	string	None.
UniqueCodeOfCart	Codice univo della prenotazione. Per aggiungere un pagamento a un carrello esistente bisogna valorizzare per forza questo campo, caso contrario verrà creato un nuovo carrello.	string	None.
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

Request Formats

application/json, text/json

Sample:

{
  "DenominationUserRegistered": "sample string 1",
  "CustomTags": [
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "MetaTags": [
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "PayeeCcp": 1,
  "TypeBookingBulletin": 50,
  "TransferAmount": 2.0,
  "Cause": "sample string 3",
  "BankPaymentSlipCode": "sample string 4",
  "CustomerLastNameOrBusinessName": "sample string 5",
  "CustomerName": "sample string 6",
  "CustomerAddress": "sample string 7",
  "CustomerCap": "sample string 8",
  "CustomerCity": "sample string 9",
  "CustomerProvince": "sample string 10",
  "CustomerTwoLetterISOLanguageName": "sample string 11",
  "CustomerFiscalCode": "sample string 12",
  "CustomerDateOfBirth": "2025-05-14T03:08:14.0968155+02:00",
  "CustomerGender": 0,
  "CustomerVatNumber": "sample string 13",
  "CustomerPersonType": "sample string 14",
  "ForceDuplicates": true,
  "CustomData1": "sample string 16",
  "CustomData2": "sample string 17",
  "CustomData3": "sample string 18",
  "UniqueCodeOfCart": "sample string 19",
  "CreatedByIpAddress": "sample string 20"
}

application/xml, text/xml

Sample:

<OuterBookingBulletinModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking.Bullettins">
  <CreatedByIpAddress xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking">sample string 20</CreatedByIpAddress>
  <TypeBookingBulletin i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking" />
  <TypesOfBulletin xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking">Mav</TypesOfBulletin>
  <UniqueCodeOfCart xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking">sample string 19</UniqueCodeOfCart>
  <BankPaymentSlipCode>sample string 4</BankPaymentSlipCode>
  <Cause>sample string 3</Cause>
  <CustomData1>sample string 16</CustomData1>
  <CustomData2>sample string 17</CustomData2>
  <CustomData3>sample string 18</CustomData3>
  <CustomTags xmlns:d2p1="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
    <d2p1:OuterBillerCustomTagModelIn>
      <d2p1:TagLabel>sample string 1</d2p1:TagLabel>
      <d2p1:TagRegEx>sample string 3</d2p1:TagRegEx>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:OuterBillerCustomTagModelIn>
    <d2p1:OuterBillerCustomTagModelIn>
      <d2p1:TagLabel>sample string 1</d2p1:TagLabel>
      <d2p1:TagRegEx>sample string 3</d2p1:TagRegEx>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:OuterBillerCustomTagModelIn>
  </CustomTags>
  <CustomerAddress>sample string 7</CustomerAddress>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <CustomerCap>sample string 8</CustomerCap>
  <CustomerCity>sample string 9</CustomerCity>
  <CustomerDateOfBirth>2025-05-14T03:08:14.0968155+02:00</CustomerDateOfBirth>
  <CustomerFiscalCode>sample string 12</CustomerFiscalCode>
  <CustomerGender>M</CustomerGender>
  <CustomerLastNameOrBusinessName>sample string 5</CustomerLastNameOrBusinessName>
  <CustomerName>sample string 6</CustomerName>
  <CustomerPersonType>sample string 14</CustomerPersonType>
  <CustomerProvince>sample string 10</CustomerProvince>
  <CustomerSepafinId>1</CustomerSepafinId>
  <CustomerTwoLetterISOLanguageName>sample string 11</CustomerTwoLetterISOLanguageName>
  <CustomerVatNumber>sample string 13</CustomerVatNumber>
  <DenominationUserRegistered>sample string 1</DenominationUserRegistered>
  <ForceDuplicates>true</ForceDuplicates>
  <MetaTags xmlns:d2p1="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
    <d2p1:OuterBillerMetaTagModelIn>
      <d2p1:TagLabel>sample string 1</d2p1:TagLabel>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:OuterBillerMetaTagModelIn>
    <d2p1:OuterBillerMetaTagModelIn>
      <d2p1:TagLabel>sample string 1</d2p1:TagLabel>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:OuterBillerMetaTagModelIn>
  </MetaTags>
  <PayeeCcp>1</PayeeCcp>
  <TransferAmount>2</TransferAmount>
  <TypeBookingBulletin>PagoPa</TypeBookingBulletin>
</OuterBookingBulletinModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Verrà ritornato il modello del carrello OuterBookingCartBulletinModelOut

OuterBookingCartBulletinModelOut

Name	Description	Type	Additional information
BookingPayments	Lista dei bollettini prenotati ancora da pagare	Collection of OuterBookingPaymentsBulletinModelOut	None.
DenominationUserRegistered	Denominazione dell'utente registrato al portale che ha effettuato la richiesta di prenotazione	string	None.
UniqueCodeOfCart	Codice univo della prenotazione	string	None.
BookingCartState	Enumerativo dello stato della prenotazione	EnumBookingCartState	None.
BookingCartStateValue	Valore dell'enumerativo dello stato della prenotazione	string	None.
CreatedOnDate	Data di creazione	date time	None.
TotalPayments	Numero totale di tutti i pagamenti presenti in questo carrello	integer	None.
TotalAmountOfPayments	Importo totale di tutti i pagamenti presenti in questo carrello	decimal number	None.
TotalPaymentsPaid	Numero totale dei pagamenti prenotati già pagati presenti in questo carrello	integer	None.
TotalPaymentsToPay	Numero totale dei pagamenti prenotati ancora da pagare presenti in questo carrello	integer	None.
TotalAmountOfPaymentsToPay	Importo totale dei pagamenti prenotati ancora da pagare presenti in questo carrello	decimal number	None.
TotalPaymentsExpired	Numero totale dei pagamenti prenotati che sono scaduti e non è più possibile pagare presenti in questo carrello	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "BookingPayments": [
    {
      "PayeeCcp": 1,
      "PayeeName": "sample string 1",
      "BankPaymentSlipCode": "sample string 2",
      "CustomData1": "sample string 3",
      "CustomData2": "sample string 4",
      "CustomData3": "sample string 5",
      "CheckVerificationDeptPositionId": 6,
      "BookingPaymentId": 7,
      "PaymentState": 0,
      "PaymentStateValue": "sample string 8",
      "TypeBookingBulletin": 50,
      "TypeBookingBulletinValue": "PagoPa",
      "TransferAmount": 9.0,
      "PayableOnlyWithPos": true,
      "Cause": "sample string 12",
      "PaymentReason": "sample string 13",
      "CustomerId": 1,
      "CustomerLastNameOrBusinessName": "sample string 14",
      "CustomerName": "sample string 15",
      "CustomerAddress": "sample string 16",
      "CustomerCity": "sample string 17",
      "CustomerProvince": "sample string 18",
      "CustomerCountry": "sample string 19",
      "CustomerZipCode": "sample string 20",
      "CustomerExecutorId": 1,
      "CustomerExecutorLastNameOrBusinessName": "sample string 21",
      "CustomerExecutorName": "sample string 22",
      "DateOfBooking": "2025-05-14T03:08:14.1124413+02:00",
      "FeesAmount": 24.0,
      "PaymentDate": "2025-05-14T03:08:14.1124413+02:00",
      "Creditor": "sample string 25",
      "NoticeNumber": "sample string 26",
      "LicensePlate": "sample string 27"
    },
    {
      "PayeeCcp": 1,
      "PayeeName": "sample string 1",
      "BankPaymentSlipCode": "sample string 2",
      "CustomData1": "sample string 3",
      "CustomData2": "sample string 4",
      "CustomData3": "sample string 5",
      "CheckVerificationDeptPositionId": 6,
      "BookingPaymentId": 7,
      "PaymentState": 0,
      "PaymentStateValue": "sample string 8",
      "TypeBookingBulletin": 50,
      "TypeBookingBulletinValue": "PagoPa",
      "TransferAmount": 9.0,
      "PayableOnlyWithPos": true,
      "Cause": "sample string 12",
      "PaymentReason": "sample string 13",
      "CustomerId": 1,
      "CustomerLastNameOrBusinessName": "sample string 14",
      "CustomerName": "sample string 15",
      "CustomerAddress": "sample string 16",
      "CustomerCity": "sample string 17",
      "CustomerProvince": "sample string 18",
      "CustomerCountry": "sample string 19",
      "CustomerZipCode": "sample string 20",
      "CustomerExecutorId": 1,
      "CustomerExecutorLastNameOrBusinessName": "sample string 21",
      "CustomerExecutorName": "sample string 22",
      "DateOfBooking": "2025-05-14T03:08:14.1124413+02:00",
      "FeesAmount": 24.0,
      "PaymentDate": "2025-05-14T03:08:14.1124413+02:00",
      "Creditor": "sample string 25",
      "NoticeNumber": "sample string 26",
      "LicensePlate": "sample string 27"
    }
  ],
  "DenominationUserRegistered": "sample string 1",
  "UniqueCodeOfCart": "sample string 2",
  "BookingCartState": 0,
  "BookingCartStateValue": "Booked",
  "CreatedOnDate": "2025-05-14T03:08:14.1124413+02:00",
  "TotalPayments": 4,
  "TotalAmountOfPayments": 5.0,
  "TotalPaymentsPaid": 6,
  "TotalPaymentsToPay": 7,
  "TotalAmountOfPaymentsToPay": 8.0,
  "TotalPaymentsExpired": 9
}

application/xml, text/xml

Sample:

<OuterBookingCartBulletinModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking">
  <BookingCartState>Booked</BookingCartState>
  <CreatedOnDate>2025-05-14T03:08:14.1124413+02:00</CreatedOnDate>
  <TotalAmountOfPayments>5</TotalAmountOfPayments>
  <TotalAmountOfPaymentsToPay>8</TotalAmountOfPaymentsToPay>
  <TotalPayments>4</TotalPayments>
  <TotalPaymentsExpired>9</TotalPaymentsExpired>
  <TotalPaymentsPaid>6</TotalPaymentsPaid>
  <TotalPaymentsToPay>7</TotalPaymentsToPay>
  <UniqueCodeOfCart>sample string 2</UniqueCodeOfCart>
  <BookingPayments>
    <OuterBookingPaymentsBulletinModelOut>
      <Amount>10</Amount>
      <BookingPaymentId>7</BookingPaymentId>
      <Cause>sample string 12</Cause>
      <CheckVerificationDeptPositionId>6</CheckVerificationDeptPositionId>
      <Creditor>sample string 25</Creditor>
      <CustomerAddress>sample string 16</CustomerAddress>
      <CustomerCity>sample string 17</CustomerCity>
      <CustomerCountry>sample string 19</CustomerCountry>
      <CustomerExecutorId>1</CustomerExecutorId>
      <CustomerExecutorLastNameOrBusinessName>sample string 21</CustomerExecutorLastNameOrBusinessName>
      <CustomerExecutorName>sample string 22</CustomerExecutorName>
      <CustomerId>1</CustomerId>
      <CustomerLastNameOrBusinessName>sample string 14</CustomerLastNameOrBusinessName>
      <CustomerName>sample string 15</CustomerName>
      <CustomerProvince>sample string 18</CustomerProvince>
      <CustomerZipCode>sample string 20</CustomerZipCode>
      <DateOfBooking>2025-05-14T03:08:14.1124413+02:00</DateOfBooking>
      <FeesAmount>24</FeesAmount>
      <LicensePlate>sample string 27</LicensePlate>
      <NoticeNumber>sample string 26</NoticeNumber>
      <PayableOnlyWithPos>true</PayableOnlyWithPos>
      <PaymentDate>2025-05-14T03:08:14.1124413+02:00</PaymentDate>
      <PaymentReason>sample string 13</PaymentReason>
      <PaymentState>Booked</PaymentState>
      <PaymentStateValue>sample string 8</PaymentStateValue>
      <TransferAmount>9</TransferAmount>
      <TypeBookingBulletin>PagoPa</TypeBookingBulletin>
      <BankPaymentSlipCode>sample string 2</BankPaymentSlipCode>
      <CustomData1>sample string 3</CustomData1>
      <CustomData2>sample string 4</CustomData2>
      <CustomData3>sample string 5</CustomData3>
      <PayeeCcp>1</PayeeCcp>
      <PayeeName>sample string 1</PayeeName>
    </OuterBookingPaymentsBulletinModelOut>
    <OuterBookingPaymentsBulletinModelOut>
      <Amount>10</Amount>
      <BookingPaymentId>7</BookingPaymentId>
      <Cause>sample string 12</Cause>
      <CheckVerificationDeptPositionId>6</CheckVerificationDeptPositionId>
      <Creditor>sample string 25</Creditor>
      <CustomerAddress>sample string 16</CustomerAddress>
      <CustomerCity>sample string 17</CustomerCity>
      <CustomerCountry>sample string 19</CustomerCountry>
      <CustomerExecutorId>1</CustomerExecutorId>
      <CustomerExecutorLastNameOrBusinessName>sample string 21</CustomerExecutorLastNameOrBusinessName>
      <CustomerExecutorName>sample string 22</CustomerExecutorName>
      <CustomerId>1</CustomerId>
      <CustomerLastNameOrBusinessName>sample string 14</CustomerLastNameOrBusinessName>
      <CustomerName>sample string 15</CustomerName>
      <CustomerProvince>sample string 18</CustomerProvince>
      <CustomerZipCode>sample string 20</CustomerZipCode>
      <DateOfBooking>2025-05-14T03:08:14.1124413+02:00</DateOfBooking>
      <FeesAmount>24</FeesAmount>
      <LicensePlate>sample string 27</LicensePlate>
      <NoticeNumber>sample string 26</NoticeNumber>
      <PayableOnlyWithPos>true</PayableOnlyWithPos>
      <PaymentDate>2025-05-14T03:08:14.1124413+02:00</PaymentDate>
      <PaymentReason>sample string 13</PaymentReason>
      <PaymentState>Booked</PaymentState>
      <PaymentStateValue>sample string 8</PaymentStateValue>
      <TransferAmount>9</TransferAmount>
      <TypeBookingBulletin>PagoPa</TypeBookingBulletin>
      <BankPaymentSlipCode>sample string 2</BankPaymentSlipCode>
      <CustomData1>sample string 3</CustomData1>
      <CustomData2>sample string 4</CustomData2>
      <CustomData3>sample string 5</CustomData3>
      <PayeeCcp>1</PayeeCcp>
      <PayeeName>sample string 1</PayeeName>
    </OuterBookingPaymentsBulletinModelOut>
  </BookingPayments>
  <DenominationUserRegistered>sample string 1</DenominationUserRegistered>
</OuterBookingCartBulletinModelOut>