POST api/OuterGateBooking/PayBookingCart

In funzione del codice univoco della prenotazione è possibile pagare in blocco tutti i bollettini presenti nella prenotazione.

Request Information

URI Parameters

None.

Body Parameters

Modello di input per il pagamento della prenotazione

OuterPayBookingCartModelIn
NameDescriptionTypeAdditional information
BookingPaymentIds

Lista degli identificativi dei pagamenti che si vuole pagare

Collection of integer

None.

AxerveTransactionId

Gedea vpos multipayment id

string

None.

AppCarteTransactionId

App Carte id per pagamenti con AppPos

string

None.

PrePaidIdentification

Pre-Paid identificaton

globally unique identifier

None.

UniqueCodeOfCart

Codice univo della prenotazione

string

Required

PaymentType

Tipo di pagamento (Contanti, POS, Virtual POS, Virtual Cash)

PaymentType

Required

PosCode

Identificativo POS

integer

Range: inclusive between 0 and 99999999

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

CustomData1

string

None.

CustomData2

string

None.

CustomData3

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BookingPaymentIds": [
    1,
    2
  ],
  "AxerveTransactionId": "sample string 1",
  "AppCarteTransactionId": "sample string 2",
  "PrePaidIdentification": "d2c2bcaa-3b97-4a2b-975d-8bf3e007c41e",
  "UniqueCodeOfCart": "sample string 3",
  "PaymentType": 0,
  "PosCode": 1,
  "CreatedByIpAddress": "sample string 4",
  "CustomData1": "sample string 5",
  "CustomData2": "sample string 6",
  "CustomData3": "sample string 7"
}

application/xml, text/xml

Sample:
<OuterPayBookingCartModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking">
  <CreatedByIpAddress>sample string 4</CreatedByIpAddress>
  <CustomData1>sample string 5</CustomData1>
  <CustomData2>sample string 6</CustomData2>
  <CustomData3>sample string 7</CustomData3>
  <PaymentType>Cash</PaymentType>
  <PosCode>1</PosCode>
  <UniqueCodeOfCart>sample string 3</UniqueCodeOfCart>
  <AppCarteTransactionId>sample string 2</AppCarteTransactionId>
  <AxerveTransactionId>sample string 1</AxerveTransactionId>
  <BookingPaymentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BookingPaymentIds>
  <PrePaidIdentification>d2c2bcaa-3b97-4a2b-975d-8bf3e007c41e</PrePaidIdentification>
</OuterPayBookingCartModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Modello di output della prenotazione pagata con tutti i riferimenti ai singoli bollettini

OuterPayBookingCartModelOut
NameDescriptionTypeAdditional information
TotalPayments

Numero totale di pagamenti

integer

None.

TotalPaymentsPaid

Numero totale dei pagamenti correttamente pagati

integer

None.

TotalPaymentsInError

Numero totale dei pagamenti non pagati andati in errore

integer

None.

BulletinTransactions

Lista di tutti i bollettini prenotati che sono stati correttamente pagati

Collection of IBookingPayment

None.

CustomData1

Custom Data

string

None.

CustomData2

Custom Data

string

None.

CustomData3

Custom Data

string

None.

UniqueCodeOfCart

Codice univo della prenotazione

string

None.

Errors

Lista di tutti i bollettini prenotati che NON sono stati pagati in seguito a dei problemi riscontrati in fase di pagamento

Collection of OuterPaymentErrorModelOut

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalPayments": 1,
  "TotalPaymentsPaid": 2,
  "TotalPaymentsInError": 3,
  "BulletinTransactions": null,
  "CustomData1": "sample string 4",
  "CustomData2": "sample string 5",
  "CustomData3": "sample string 6",
  "UniqueCodeOfCart": "sample string 7",
  "Errors": [
    {
      "BookingPaymentId": 1,
      "TypeBookingBulletin": "sample string 2",
      "ResponseErrorMessage": {
        "Message": "sample string 1"
      }
    },
    {
      "BookingPaymentId": 1,
      "TypeBookingBulletin": "sample string 2",
      "ResponseErrorMessage": {
        "Message": "sample string 1"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<OuterPayBookingCartModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.Booking">
  <Errors>
    <OuterPaymentErrorModelOut>
      <BookingPaymentId>1</BookingPaymentId>
      <ResponseErrorMessage>
        <Message>sample string 1</Message>
      </ResponseErrorMessage>
      <TypeBookingBulletin>sample string 2</TypeBookingBulletin>
    </OuterPaymentErrorModelOut>
    <OuterPaymentErrorModelOut>
      <BookingPaymentId>1</BookingPaymentId>
      <ResponseErrorMessage>
        <Message>sample string 1</Message>
      </ResponseErrorMessage>
      <TypeBookingBulletin>sample string 2</TypeBookingBulletin>
    </OuterPaymentErrorModelOut>
  </Errors>
  <UniqueCodeOfCart>sample string 7</UniqueCodeOfCart>
  <BulletinTransactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <CustomData1>sample string 4</CustomData1>
  <CustomData2>sample string 5</CustomData2>
  <CustomData3>sample string 6</CustomData3>
  <TotalPayments>1</TotalPayments>
  <TotalPaymentsInError>3</TotalPaymentsInError>
  <TotalPaymentsPaid>2</TotalPaymentsPaid>
</OuterPayBookingCartModelOut>