GET api/OuterGate/GetAllBankPayments?startDateRequest={startDateRequest}&endDateRequest={endDateRequest}

Ritorna tutti i pagamenti bollettini, i parametri in ingresso, le date, possono essere entrambe poste a null, in modo da ritornare tutte le transazioni oppure entrambe valorizzate a valori ammessi cosi come descritto nella specifica dei parametri, in caso solo una delle due sia posta a null, viene ritornata una eccezione

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDateRequest

Data iniziale per la ricerca, deve essere precedente alla data endDateRequest

date time

None.

endDateRequest

Data finale per la ricerca, deve essere successiva alla data startDateRequest

date time

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OuterBankTransactionModelOut
NameDescriptionTypeAdditional information
IdBulletin

Identificativo interno della transazione

integer

None.

CurrencyDate

Data di valuta calcolata

date time

None.

PaymentDate

Data di pagamento

date time

None.

PayeeName

Biller

string

None.

PayeePostalAccount

QUESTO CAMPO VERRA' DISMESSO IN QUANTO E' PRESENTE UN ALTRO CAMPO PER MOSTRARE IL NUMERO DI CONTO CORRENTE DEL BENEFICIARIO (PayeeCcp)

long integer

None.

PaymentReason

Causale

string

None.

CustomerName

cliente (nome)

string

None.

CustomerLastNameOrBusinessName

Cliente (cognome)

string

None.

CustomerAddress

Indirizzo

string

None.

CustomerCity

Città

string

None.

EmployeeUsername

Operatore

string

None.

UniqueKey

Codice univoco della transazione utilizzato per recuperare il bollettino da portale.

string

None.

TypeOfBullettin

tipologia di bollettino in formato testo

string

None.

CRO

identificativo CRO del pagamento risolto

string

None.

FeesAmount

Commissioni

decimal number

None.

PosPid

Codice univo del pagamento con POS

string

None.

CustomData1

Campo customizabile

string

None.

CustomData2

Campo customizabile

string

None.

CustomData3

Campo customizabile

string

None.

CustomerSepafinId

Id intestatario bollettino obbligatorio

integer

Required

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

PaymentType

Tipo di pagamento (Contanti o carta di credito/debito)

PaymentType

Required

PayeeCcp

Numero di conto corrente del beneficiario

long integer

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

BankPaymentSlipCode

Codice del bollettino

string

None.

BankPaymentSlipType

Tipo di bollettino

BankPaymentSlipType

Required

Range: inclusive between 123 and 2147483647

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

PosCode

Identificativo POS

integer

Range: inclusive between 0 and 99999999

Response Formats

application/json, text/json

Sample:
[
  {
    "IdBulletin": 1,
    "CurrencyDate": "2025-05-14T03:58:57.0964783+02:00",
    "PaymentDate": "2025-05-14T03:58:57.0964783+02:00",
    "PayeeName": "sample string 2",
    "PayeePostalAccount": 1,
    "PaymentReason": "sample string 3",
    "CustomerName": "sample string 4",
    "CustomerLastNameOrBusinessName": "sample string 5",
    "CustomerAddress": "sample string 6",
    "CustomerCity": "sample string 7",
    "EmployeeUsername": "sample string 8",
    "UniqueKey": "sample string 9",
    "TypeOfBullettin": "sample string 10",
    "CRO": "sample string 11",
    "FeesAmount": 1.0,
    "PosPid": "sample string 12",
    "CustomData1": "sample string 13",
    "CustomData2": "sample string 14",
    "CustomData3": "sample string 15",
    "CustomerSepafinId": 1,
    "CustomerExecutorSepafinId": 1,
    "CreatedByIpAddress": "sample string 16",
    "PaymentType": 0,
    "PayeeCcp": 1,
    "TransferAmount": 17.0,
    "BankPaymentSlipCode": "sample string 18",
    "BankPaymentSlipType": 123,
    "Cause": "sample string 19",
    "PosCode": 1
  },
  {
    "IdBulletin": 1,
    "CurrencyDate": "2025-05-14T03:58:57.0964783+02:00",
    "PaymentDate": "2025-05-14T03:58:57.0964783+02:00",
    "PayeeName": "sample string 2",
    "PayeePostalAccount": 1,
    "PaymentReason": "sample string 3",
    "CustomerName": "sample string 4",
    "CustomerLastNameOrBusinessName": "sample string 5",
    "CustomerAddress": "sample string 6",
    "CustomerCity": "sample string 7",
    "EmployeeUsername": "sample string 8",
    "UniqueKey": "sample string 9",
    "TypeOfBullettin": "sample string 10",
    "CRO": "sample string 11",
    "FeesAmount": 1.0,
    "PosPid": "sample string 12",
    "CustomData1": "sample string 13",
    "CustomData2": "sample string 14",
    "CustomData3": "sample string 15",
    "CustomerSepafinId": 1,
    "CustomerExecutorSepafinId": 1,
    "CreatedByIpAddress": "sample string 16",
    "PaymentType": 0,
    "PayeeCcp": 1,
    "TransferAmount": 17.0,
    "BankPaymentSlipCode": "sample string 18",
    "BankPaymentSlipType": 123,
    "Cause": "sample string 19",
    "PosCode": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfOuterBankTransactionModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
  <OuterBankTransactionModelOut>
    <BankPaymentSlipCode>sample string 18</BankPaymentSlipCode>
    <BankPaymentSlipType>B123</BankPaymentSlipType>
    <Cause>sample string 19</Cause>
    <CreatedByIpAddress>sample string 16</CreatedByIpAddress>
    <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
    <CustomerSepafinId>1</CustomerSepafinId>
    <PayeeCcp>1</PayeeCcp>
    <PaymentType>Cash</PaymentType>
    <PosCode>1</PosCode>
    <TransferAmount>17</TransferAmount>
    <CRO>sample string 11</CRO>
    <CurrencyDate>2025-05-14T03:58:57.0964783+02:00</CurrencyDate>
    <CustomData1>sample string 13</CustomData1>
    <CustomData2>sample string 14</CustomData2>
    <CustomData3>sample string 15</CustomData3>
    <CustomerAddress>sample string 6</CustomerAddress>
    <CustomerCity>sample string 7</CustomerCity>
    <CustomerLastNameOrBusinessName>sample string 5</CustomerLastNameOrBusinessName>
    <CustomerName>sample string 4</CustomerName>
    <EmployeeUsername>sample string 8</EmployeeUsername>
    <FeesAmount>1</FeesAmount>
    <IdBulletin>1</IdBulletin>
    <PayeeName>sample string 2</PayeeName>
    <PayeePostalAccount>1</PayeePostalAccount>
    <PaymentDate>2025-05-14T03:58:57.0964783+02:00</PaymentDate>
    <PaymentReason>sample string 3</PaymentReason>
    <PosPid>sample string 12</PosPid>
    <TypeOfBullettin>sample string 10</TypeOfBullettin>
    <UniqueKey>sample string 9</UniqueKey>
  </OuterBankTransactionModelOut>
  <OuterBankTransactionModelOut>
    <BankPaymentSlipCode>sample string 18</BankPaymentSlipCode>
    <BankPaymentSlipType>B123</BankPaymentSlipType>
    <Cause>sample string 19</Cause>
    <CreatedByIpAddress>sample string 16</CreatedByIpAddress>
    <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
    <CustomerSepafinId>1</CustomerSepafinId>
    <PayeeCcp>1</PayeeCcp>
    <PaymentType>Cash</PaymentType>
    <PosCode>1</PosCode>
    <TransferAmount>17</TransferAmount>
    <CRO>sample string 11</CRO>
    <CurrencyDate>2025-05-14T03:58:57.0964783+02:00</CurrencyDate>
    <CustomData1>sample string 13</CustomData1>
    <CustomData2>sample string 14</CustomData2>
    <CustomData3>sample string 15</CustomData3>
    <CustomerAddress>sample string 6</CustomerAddress>
    <CustomerCity>sample string 7</CustomerCity>
    <CustomerLastNameOrBusinessName>sample string 5</CustomerLastNameOrBusinessName>
    <CustomerName>sample string 4</CustomerName>
    <EmployeeUsername>sample string 8</EmployeeUsername>
    <FeesAmount>1</FeesAmount>
    <IdBulletin>1</IdBulletin>
    <PayeeName>sample string 2</PayeeName>
    <PayeePostalAccount>1</PayeePostalAccount>
    <PaymentDate>2025-05-14T03:58:57.0964783+02:00</PaymentDate>
    <PaymentReason>sample string 3</PaymentReason>
    <PosPid>sample string 12</PosPid>
    <TypeOfBullettin>sample string 10</TypeOfBullettin>
    <UniqueKey>sample string 9</UniqueKey>
  </OuterBankTransactionModelOut>
</ArrayOfOuterBankTransactionModelOut>