OuterGatePayments
| API | Description |
|---|---|
| GET api/OuterGatePayments/GetMultiPaymentCart?uniqueCodeOfCart={uniqueCodeOfCart} |
In funzione del codice univoco del carrello ritorna tutte le informazioni sul carrello e una lista dei pagamenti. |
| GET api/OuterGatePayments/GetAllBookedCart?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i carrelli in stato prenotato o parzialmente pagato, le date, possono essere entrambe poste a null, in modo da ritornare tutti i carrelli 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 |
| GET api/OuterGatePayments/GetReceiptBase64?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna il base64 della ricevuta di pagamento di tutti i pagamenti correttamente pagati |
| GET api/OuterGatePayments/GetReceiptJson?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna lo scontrino in formato JSon |
| GET api/OuterGatePayments/SummaryCarts?dateFrom={dateFrom}&dateTo={dateTo}&applicationDomain={applicationDomain} |
Ritorna la lista dei carrelli |
OuterGateAutomaticOnboarding
| API | Description |
|---|---|
| POST api/AutomaticOnBoarding/Agency |
Agency creation |
| PUT api/AutomaticOnBoarding/Activation |
Perform the activation of the specified services with the corresponding service parameters. |
| GET api/AutomaticOnBoarding/State?ServiceName={ServiceName}&AgencyId={AgencyId}&DdsCode={DdsCode} |
Return at least five activations in order of request date |
OuterGatePagoPa
Controller dedicato ai pagamenti PagoPa e Bollo
| API | Description |
|---|---|
| GET api/OuterGatePagoPa/GetPaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
/// Ritorno lo stato della transazione con il relativo errore in caso la transazione non sia completata. Con esito positivo, ritorna i dati dello scontrino. |
| GET api/OuterGatePagoPa/PaymentStatus?checkId={checkId} |
GetDocument status |
| GET api/OuterGatePagoPa/GetPagoPAReceipt?idPagoPA={idPagoPA} |
Return only a PagoPA type receipt data |
| GET api/OuterGatePagoPa/GetPagoBolloReceipt?idPagoBollo={idPagoBollo} |
Return only a PagoPA Bollo type receipt data |
| GET api/OuterGatePagoPa/GetCustomerFee?typeOfBulletin={typeOfBulletin}&paymentType={paymentType} |
Ritorna le commissioni che verranno applicate ai pagamenti di tipo Bollo Aci e PagoPa |
| POST api/OuterGatePagoPa/CheckVerificationDebtPositionForPagoPa |
Messaggio di richiesta di Verifica Posizione Debitoria per tributi PagoPa, PagoPa PRA e PagoPa Bollo. Nel modello in ingresso i parametri NoticeNumber(numero di avviso) e PAIdentifier(codice fiscale o partita IVA ente) sono indispensabili per poter effettuare la richiesta. Invece per distinguere il tipo di PagoPa bisognerà valorizzare la proprietà TypeOfBulletin. Valori ammessi per TypesOfBulletin: TypesOfBulletin.PagoPa (PagoPa generico [50]), TypesOfBulletin.PagoPaBollo (PagoPa Bollo [53]), TypesOfBulletin.PagoPaPra (PagoPa PRA [52]). In caso di risposta positiva si dovrà confermare la richiesta con la chiamata "api/OuterGatePagoPa/ConfirmTransaction" oppure annullare la richiesta con la chiamata "api/OuterGatePagoPa/CancelCheckVerificationDebtPosition". Sempre in caso di risposta positiva si otterranno tutte le informazioni relative a questo pagamento: importo, commissioni, totale, tipologia e info cliente. In caso di esito negativo si avrà una risposta http con stato 4xx o 5xx a seconda dei vari esiti problemi riscontrati |
| POST api/OuterGatePagoPa/CheckVerificationDebtPositionForVehicleTax |
Messaggio di richiesta di Verifica Posizione Debitoria per pagamento del bollo veicoli ACI.Nel modello di input abbiamo 4 proprietà che non sono required (TypeOfVehicle, LicensePlate, FrameNumber, FiscalCodeOfTheOwner) queste proprietà servono per ricomporre "il numero di avviso", quindi a seconda della tipologia del veicolo sarà necessario popolare alcuni di essi:- se TypeOfVehicle(tipologia) è uguale a TypeOfVehicleEnum.Car(automobile), TypeOfVehicleEnum.Trailer(rimorchio), TypeOfVehicleEnum.Motorcycle(motoveicolo) allora è required il parametro LicensePlate(Numero di targa del veicolo)- se TypeOfVehicle(tipologia) è uguale a TypeOfVehicleEnum.Moped(ciclomotore), TypeOfVehicleEnum.Quadricycle(quadriciclo) allora saranno required i parametri FrameNumber(Numero di telaio del veicolo) e FiscalCodeOfTheOwner(Codice fiscale del proprietario del veicolo). In caso di risposta positiva si dovrà confermare la richiesta con la chiamata "api/OuterGatePagoPa/ConfirmTransaction" oppure annullare la richiesta con la chiamata "api/OuterGatePagoPa/CancelCheckVerificationDebtPosition". Sempre in caso di risposta positiva si otterranno tutte le informazioni relative a questo pagamento: importo, commissioni, totale, tipologia e info cliente. In caso di esito negativo si avrà una risposta http con stato 4xx o 5xx a seconda dei vari esiti problemi riscontrati |
| GET api/OuterGatePagoPa/CheckAntiMoneyLaunderingExecutor?customerExecutorId={customerExecutorId}&amount={amount}&paymentType={paymentType} |
IL METODO VERRA' DIMESSO IN QUANTO TALE CONTROLLO NON è PIU' OBBLIGATORIO Verifica che per il dato cliente esecutore del pagamento PagoPa o Bollo non abbia superato i limiti imposti per l'antiriciclaggio. Tale chiamata va effettua necessariamente dopo una richiesta di posizione debitoria e quindi aver ottenuto l'ammontare dell'importo da pagare e in caso di esito negativo va annullata la richiesta della posizione debitoria effettuata in precedenza |
| POST api/OuterGatePagoPa/CancelCheckVerificationDebtPosition |
Permette la cancellazione della verifica della posizione debitoria effettuata con le chiamate 'CheckVerificationDebtPositionForVehicleTax' e 'api/OuterGatePagoPa/CheckVerificationDebtPositionForPagoPa' Bisognerà chiamare questo metodo ogni volta che si effettua una verifica e non si intende confermare il pagamento |
| POST api/OuterGatePagoPa/ConfirmTransaction |
In caso di verifica della posizione debitoria con esito positivo, permette di confermare il pagamento del PagoPa o del Bollo. Ritorna un esito positivo o uno stato di errore |
| GET api/OuterGatePagoPa/GetAllPagoPaBolloPayments?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i pagamenti PagoPa Bollo effettuati, 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. Le date passate devono rispettare il formato ISO-8601 es. 2017-05-23 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 |
| GET api/OuterGatePagoPa/GetReceipt?checkVerificationDebtPositionId={checkVerificationDebtPositionId} |
Ritorna un stream di dati di tipo PDF (La ricevuta) |
| POST api/OuterGatePagoPa/QueuePraFlow |
Accoda la richiesta di un flusso PRA |
OuterGatePrePaid
| API | Description |
|---|---|
| POST api/OuterGatePrePaid/Add |
No documentation available. |
| GET api/OuterGatePrePaid/{prepaidID} |
No documentation available. |
| GET api/OuterGatePrePaid/Find/{date} |
No documentation available. |
OuterGatePrepaidCreditor
| API | Description |
|---|---|
| POST api/OuterGatePrePaidCreditor/Add |
No documentation available. |
| GET api/OuterGatePrePaidCreditor/Debtor/{debtorId} |
No documentation available. |
| GET api/OuterGatePrePaidCreditor/AllMandates?page={page} |
No documentation available. |
| GET api/OuterGatePrePaidCreditor/Find/{debtorId}/{date} |
No documentation available. |
| GET api/OuterGatePrePaidCreditor/Pending/{debtorId} |
No documentation available. |
| GET api/OuterGatePrePaidCreditor/Unpaid?dateFrom={dateFrom}&dateTo={dateTo} |
No documentation available. |
OuterGateBookingBulletin
Controller per il salvataggio e pagamento dei bollettini in bozza
| API | Description |
|---|---|
| POST api/OuterGateBookingBulletin/GetSessionID |
Ritorno l'id della sessione che è utilizzato per la generazione del HttpRequestTransactionId |
| GET api/OuterGateBookingBulletin/GetBillerByPostalAccount?postalAccount={postalAccount}&typeBookingBulletin={typeBookingBulletin} |
Ritorna un biller in funzione del codice postale. |
| 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 |
| GET api/OuterGateBookingBulletin/GetBookingCart?uniqueCodeOfCart={uniqueCodeOfCart} |
In funzione del codice univoco del carrello ritorna tutte le informazioni sul carrello e una lista dei bollettini prenotati solo se ci sono bollettini da pagare |
| GET api/OuterGateBookingBulletin/GetBookingReceiptBase64?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna il base64 della ricevuta della prenotazione in funzione del codice univoco della prenotazione |
| GET api/OuterGateBookingBulletin/GetBookingReceiptJson?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna un modello json di output della ricevuta della prenotazione in funzione del codice univoco della prenotazione |
| POST api/OuterGateBooking/PayBookingCart |
In funzione del codice univoco della prenotazione è possibile pagare in blocco tutti i bollettini presenti nella prenotazione. |
| POST api/OuterGateBookingBulletin/PayBookingCart |
In funzione del codice univoco della prenotazione è possibile pagare in blocco tutti i bollettini presenti nella prenotazione. |
| GET api/OuterGateBookingBulletin/GetReceiptBase64?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna il base64 della ricevuta di pagamento di tutti i bollettini correttamente pagati |
| GET api/OuterGateBookingBulletin/GetReceiptJson?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna il Json della ricevuta di pagamento di tutti i bollettini correttamente pagati |
OuterGateMultiPaymentPagoPa
| API | Description |
|---|---|
| POST api/OuterGateMultiPayment/PagoPa/CreateCartOrAddToCart |
No documentation available. |
OuterGateMultiPayment
Controller per il salvataggio e pagamento di più bollettini contemporaneamente
| API | Description |
|---|---|
| GET api/OuterGateMultiPayment/GetBillerByPostalAccount?postalAccount={postalAccount}&typeBookingBulletin={typeBookingBulletin} |
Ritorna un biller in funzione del codice postale. |
| POST api/OuterGateMultiPayment/CreateCartOrAddToCartBulletin |
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 |
| GET api/OuterGateMultiPayment/GetBookedCartReceipt?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna il base64 della ricevuta del carrello, non ancora pagato, in funzione del codice univoco del carrello |
| GET api/OuterGateMultiPayment/GetAllBookedCart?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i carrelli in stato prenotato o parzialmente pagato, le date, possono essere entrambe poste a null, in modo da ritornare tutti i carrelli 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 |
| GET api/OuterGateMultiPayment/GetMultiPaymentCart?uniqueCodeOfCart={uniqueCodeOfCart} |
In funzione del codice univoco del carrello ritorna tutte le informazioni sul carrello e una lista dei pagamenti. |
| POST api/OuterGateMultiPayment/PayMultiPaymentCart |
In funzione del codice univoco della prenotazione è possibile pagare in blocco tutti i bollettini presenti nella prenotazione. |
| GET api/OuterGateMultiPayment/GetReceiptBase64?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna il base64 della ricevuta di pagamento di tutti i pagamenti correttamente pagati |
| GET api/OuterGateMultiPayment/GetReceiptJson?uniqueCodeOfCart={uniqueCodeOfCart} |
No documentation available. |
OutgateCashIn
| API | Description |
|---|---|
| POST IdentityTransferOrder |
No documentation available. |
| GET IsValidIdentity?FiscalCode={FiscalCode} |
No documentation available. |
| GET ValidateDocuments?FiscalCode={FiscalCode}&PhoneNumber={PhoneNumber} |
No documentation available. |
| GET Receipt?idTransferOrder={idTransferOrder} |
No documentation available. |
| POST Movements |
No documentation available. |
| GET PaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
No documentation available. |
OuterGateDebtPosition
OuterGateCommon
Controller in comune a tutti Servizi API: creazione e aggiornamento anagrafiche, lista di tutti gli id dei POS dell'agenzia, lista di tutti mi clienti agenzia e ricerca del cliente
| API | Description |
|---|---|
| GET api/OuterGateCommon/GetPlafond |
Ritorna il plafond in funzione dell'agenzia che sta effettuando la richiesta |
| GET api/OuterGateCommon/CheckPlafondEnough?amount={amount} |
Verifica che il plafond per il pagamento sia sufficiente |
| POST api/OuterGateCommon/CreateNewCustomer |
Crea un nuovo cliente pagatore. N.b. Se viene inserito un C.F.(FiscalCode) corretto verranno popolati automaticamente i seguenti campi DateOfBirth PlaceOfBirth Gender |
| PUT api/OuterGateCommon/UpdateCustomer?id={id} |
Aggiorna i dati dell'anagrafica del cliente. N.b. Se viene inserito un C.F.(FiscalCode) corretto verranno popolati automaticamente i seguenti campi DateOfBirth PlaceOfBirth Gender |
| DELETE api/OuterGateCommon/DeleteCustomer?id={id} |
Elimina un cliente, se non ha pagamenti effettuati |
| GET api/OuterGateCommon/GetIdentifyngTinyClients?denomination={denomination}&cap={cap}&maxResult={maxResult} |
Ottiene le informazioni principali del cliente. Nel campo denomination è possibile passare il nome e cognome, il codice anagrafica, l' e-mail, il numero telefonico o il codice fiscale. Potrà essere applicato un filtro per CAP |
| GET api/OuterGateCommon/GetCustomerById?id={id} |
Ritorna le informazioni del cliente in funzione dell'id |
| POST api/OuterGateCommon/CreateCustomerAddress |
Crea un nuovo indirizzo ad un cliente già registrato sulla piattaforma |
| POST api/OuterGateCommon/UpdateCustomerAddress |
Aggiorna un indirizzo già esistente di un cliente registrato |
| GET api/OuterGateCommon/GetCustomerAddresses?customerId={customerId} |
Ritorna tutti gli indirizzi del cliente richiesto. |
| GET api/OuterGateCommon/GetAllCustomersAgency |
Ritorna tutti i clienti che hanno effettuato un pagamento di bollettini, Mav e Rav nell'agenzia che sta effettuando la richiesta |
| GET api/OuterGateCommon/GetArchivePosByAgency |
Ritorna la lista degli Id dei pos disponibili per l'agenzia corrente |
| GET api/OuterGateCommon/CheckAntiMoneyLaunderingExecutor?customerExecutorId={customerExecutorId}&amount={amount} |
IL METODO VERRA' DIMESSO IN QUANTO TALE CONTROLLO NON è PIU' OBBLIGATORIO Verifica che per il dato cliente esecutore del pagamento non ci siano problemi di antiriciclaggio |
| POST api/OuterGateCommon/ResetPassword |
Permette di recuperare o cambiare la password dell'account, inserendo la username |
| GET api/OuterGateCommon/Actors |
No documentation available. |
OuterGatePos
| API | Description |
|---|---|
| GET api/Pos264/{pid} |
No documentation available. |
| GET api/Pos264?from={from}&to={to} |
No documentation available. |
| POST api/Pos264/Pay |
No documentation available. |
OuterGateMultiPaymentPagoPaA2APos
| API | Description |
|---|---|
| POST api/OuterGateMultiPayment/PagoPaA2APos/Pay |
This endpoint will called on A2APOS payment result |
| GET api/OuterGateMultiPayment/PagoPaA2APos/GetReceiptJson?uniqueCodeOfCart={uniqueCodeOfCart} |
Ritorna lo scontrino in formato JSon |
| GET api/OuterGateMultiPayment/PagoPaA2APos/GetReceiptPdf?uniqueCodeOfCart={uniqueCodeOfCart} |
No documentation available. |
| POST api/OuterGateMultiPayment/PagoPaA2APos/CancelCheckVerificationDebtPosition |
Permette la cancellazione della verifica della posizione debitoria effettuata con le chiamate 'CheckVerificationDebtPositionForVehicleTax' e 'api/OuterGatePagoPa/CheckVerificationDebtPositionForPagoPa' Bisognerà chiamare questo metodo ogni volta che si effettua una verifica e non si intende confermare il pagamento |
OuterGate
OuterGate per i servizi di pagamento Bollettini, MAV e RAV
| API | Description |
|---|---|
| GET api/OuterGate/GetAllMavTransactions?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i pagamenti MAV, 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 |
| GET api/OuterGate/GetAllFrecciaTransactions?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i pagamenti FRECCIA, 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 |
| GET api/OuterGate/GetAllRavTransactions?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i pagamenti RAV, 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 |
| 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 |
| GET api/OuterGate/GetCustomerFeeForBulletin?typeOfBulletin={typeOfBulletin}&postalAccount={postalAccount}&paymentType={paymentType} |
Ritorna le commissioni che verranno applicate ai pagamenti di tipo bollettino: 123, 451, 674, 896 |
| GET api/OuterGate/GetCustomerFeeForMavRav?typeOfBulletin={typeOfBulletin}&paymentType={paymentType} |
Ritorna le commissioni che verranno applicate ai pagamenti di tipo Mav / Rav |
| GET api/OuterGate/GetCustomerFeeForFreccia?paymentType={paymentType} |
Ritorna le commissioni che verranno applicate ai pagamenti di tipo Freccia |
| GET api/OuterGate/GetReceipt?idBulletin={idBulletin}&typeOfBulletin={typeOfBulletin} |
Ritorna lo stream della ricevuta in formato PDF, in funzione dell'id della stessa e del tipo di bollettino |
| GET api/OuterGate/GetPaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
/// Ritorno lo stato della transazione con il relativo errore in caso la transazione non sia completata. Con esito positivo, ritorna i dati dello scontrino. Se RequestTransactioPaymentStatusType non è specificato nella richiesta, il valore di default sarà 0 (Bulletin) |
| GET api/OuterGate/GetBulletinReceipt?idBulletin={idBulletin}&typeOfBulletin={typeOfBulletin} |
Return only a bullettin type receipt data |
| GET api/OuterGate/GetMavReceipt?idMav={idMav} |
Return only a Mav type receipt data |
| GET api/OuterGate/GetRavReceipt?idRav={idRav} |
Return only a Rav type receipt data |
| GET api/OuterGate/GetFrecciaReceipt?idFreccia={idFreccia} |
Return only a Freccia type receipt data |
| POST api/OuterGate/RequestNewBiller |
Permette la richiesta di creazione di un nuovo biller |
| GET api/OuterGate/RequestNewBillerJustMaded?postalAccount={postalAccount} |
In funzione del C/C postale verifica se la richiesta del nuovo Biller è già stata inviata a Sepafin. Ritorna "true" se la richiesta è stata inviata, non ancora approvata, o se il biller è già censito, altrimenti "false". |
| GET api/OuterGate/GetBillersByPostalAccount?postalAccount={postalAccount}&typeOfBulletin={typeOfBulletin} |
Ritorna un biller in funzione del codice postale. |
| GET api/OuterGate/CheckFiscalCodeOrVatNumberIsRequiredForCustomer?billerPostalAccount={billerPostalAccount}&customerId={customerId} |
Verifica se il cliente intestatario del bollettino deve avere il codice fiscale oppure no. Tale verifica va effettuata in funzione del PostalAccount del Biller selezionato e dell'id del cliente intestatario. Metodo da utilizzare in fase di pagamento di un bollettino (api/OuterGate/PayBankPaymentSlip) per verificare se bisogna richiedere obbligatoriamente il codice fiscale al cliente intestatario. |
| POST api/OuterGate/PayMav |
Permette il pagamento di un MAV |
| POST api/OuterGate/PayRav |
Permette il pagamento di un RAV |
| POST api/OuterGate/PayFreccia |
Permette il pagamento di un Freccia |
| POST api/OuterGate/PayBankPaymentSlip |
Permette il pagamento di un bollettino 896, 674, 123, 451 |
| POST api/OuterGate/CheckBankPaymentSlipAlreadyPaid |
Verifica se il ballettino che si sta pagando è già stato pagato nella giornata. Metodo da richiamare prima di un pagamento bollettino (PayBankPaymentSlip), se ritorna true allora il bollettino è già stato pagato nella giornata e bisogna mostrare al PO un messaggio di allerta: "Attenzione! è stato pagato un bollettino identico nella giornata, se conferma, il pagamento non potrà essere stornato!" |
| GET api/OuterGate/GetAllBillerMetaTagsAvailable |
Ritorna tutti i MetaTag disponibili |
OuterGateTransfer
| API | Description |
|---|---|
| POST api/OuterGateTransfer/TransferOrder |
Crea una disposizione di bonifico |
| GET api/OuterGateTransfer/GetReceipt?idTransferOrder={idTransferOrder} |
Recupera la contabile della disposizione di bonifico |
| POST api/OuterGateTransfer/GetMovements |
Recupera i movimenti |
| GET api/OuterGateTransfer/GetPaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
Ritorna lo stato della transazione con il relativo errore in caso la transazione non sia completata. Con esito positivo, la contabile. |
OuterGateAis
OuterGateMultiPaymentPagoPaVPos
| API | Description |
|---|---|
| POST api/OuterGateMultiPayment/PagoPaVPOS/CreateCartOrAddToCart |
This endpoint create the cart. Check operative limit and plafond. |
| POST api/v{version}/OuterGateMultiPayment/PagoPaVPOS/CreateCartOrAddToCart |
CreateCartOrAddToCart v.1.1 Return a light response with recap informations about cart |
| POST api/OuterGateMultiPayment/PagoPaVPOS/PayCartVPOS |
This endpoint get link or qrcode for pay |
OuterGateAgencyService
Controller per tutte le operazioni dedicate all'amministratore di agenzia
| API | Description |
|---|---|
| GET api/OuterGateAgencyService/GetAllPlafoundMovements |
Ritorna tutti i movimenti di ricarica plafond |
| GET api/OuterGateAgencyService/GetAllDirectAccreditsOrDebitsTransactions?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i movimenti di denaro effettuati o ricevuti nel circuito privativo, 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, nel caso in cui una delle due date sia posta a null, viene ritornata una eccezione |
| GET api/OuterGateAgencyService/GetAllArchivePos |
Ritorna tutti pos in dotazione all'agenzia e indica a quale operatore sono stati associati |
| GET api/OuterGateAgencyService/GetBalance |
Ritorna il saldo contabile dell'agenzia |
| GET api/OuterGateAgencyService/DailySddMaxAmount |
Return the daily available sdd amount for agency. |
| POST api/OuterGateAgencyService/UpdatePlafond |
Ricarica il plafond dell'agenzia con possibilità di impostare automaticamente il plafond uguale al saldo |
| GET api/OuterGateAgencyService/GetAgencyReportDraft?membershipEmail={membershipEmail}&startDate={startDate}&endDate={endDate} |
Ritorna il rendiconto per agenzia di tutte le transazioni in bozza, dato l'id della agenzia, l'operatore ed eventualmente dell'intervallo temporale definito dal StartDate e EndDate. Esempio di chiamate valide al metodo API: [api/OuterGate/GetAgencyReportDraft] -> ritorna la rendicontazione in funzione dell'agenzia [api/OuterGate/GetAgencyReportDraft?membershipUserName=admin@nomail.com] -> ritorna la rendicontazione in funzione dell'agenzia e dell'operatore [api/OuterGate/GetAgencyReportDraft?membershipUserName=admin@nomail.com&startDate=2019-10-24&endDate=2019-10-25] -> ritorna la rendicontazione in funzione dell'agenzia, dell'operatore e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diversi da null [api/OuterGate/GetAgencyReportDraft?startDate=2019-10-24&endDate=2019-10-25] -> ritorna la rendicontazione in funzione dell'agenzia e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diverse da null Le date passate devono rispettare il formato ISO-8601 es. 2019-10-25 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 . Questo metodo non potrà mostrare il profitto del punto operativo in quanto le transazioni ritornate non sono state ancora rendicontate. |
| GET api/OuterGateAgencyService/GetAgencyReport?membershipEmail={membershipEmail}&startDate={startDate}&endDate={endDate} |
Ritorna il rendiconto per agenzia dato l'id della agenzia, l'operatore ed eventualmente dell'intervallo temporale definito dal StartDate e EndDate. Esempio di chiamate valide al metodo API: [api/OuterGate/GetAgencyReport] -> ritorna la rendicontazione in funzione dell'agenzia [api/OuterGate/GetAgencyReport?membershipEmail=admin@nomail.com] -> ritorna la rendicontazione in funzione dell'agenzia e dell'operatore [api/OuterGate/GetAgencyReport?membershipEmail=admin@nomail.com&startDate=2000-05-25&endDate=2017-05-25] -> ritorna la rendicontazione in funzione dell'agenzia, dell'operatore e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diversi da null [api/OuterGate/GetAgencyReport?startDate=2000-05-25&endDate=2017-05-25] -> ritorna la rendicontazione in funzione dell'agenzia e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diverse da null Le date passate devono rispettare il formato ISO-8601 es. 2017-05-23 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 |
| GET api/OuterGateAgencyService/GetAgencyReportMultilevel?membershipEmail={membershipEmail}&startDate={startDate}&endDate={endDate} |
Ritorna il rendiconto per agenzie appartenenti alla stessa rete o per agenzia. Esempio di chiamate valide al metodo API: [api/OuterGate/GetAgencyReportMultilevel] -> ritorna la rendicontazione in funzione dell'agenzia o delle agenzie se l'utente ha ruolo di capo-rete [api/OuterGate/GetAgencyReportMultilevel?membershipEmail=admin@nomail.com] -> ritorna la rendicontazione in funzione dell'agenzia e dell'operatore [api/OuterGate/GetAgencyReportMultilevel?membershipEmail=admin@nomail.com&startDate=2000-05-25&endDate=2017-05-25] -> ritorna la rendicontazione in funzione dell'agenzia, dell'operatore e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diversi da null [api/OuterGate/GetAgencyReportMultilevel?startDate=2000-05-25&endDate=2017-05-25] -> ritorna la rendicontazione in funzione dell'agenzia e dell'intervallo di tempo [startDate, endDate] con startDate minore uguale a endDate entrambe diverse da null Le date passate devono rispettare il formato ISO-8601 es. 2017-05-23 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 |
OuterGateSimpleF
OuterGate per i servizi di pagamento F24
| API | Description |
|---|---|
| POST api/OuterGateF24/Validate |
Valida la richiesta di un pagamento F24 semplice, se l'operazione riesce viene restituisce il pre-scontrino. |
| POST api/OuterGateF24/Confirm |
Conferma la validazione dell'F24 Semplificato, sel l'operazione riesce viene ritornato lo scontrino. |
| GET api/OuterGateF24/AccountingProof?idSimpleOrder={idSimpleOrder} |
Ritorna la quietanza del pagamento F24 Semplificato |
| GET api/OuterGateF24/Receipt?idSimpleOrder={idSimpleOrder} |
Ritorna un stream di dati di tipo PDF (La ricevuta) |
| GET api/OuterGateF24/CustomerFee?paymentType={paymentType} |
Ritorna le commissioni che verranno applicate ai pagamenti di tipo F24 semplificato |
| GET api/OuterGateF24/AllPayments?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutti i pagamenti, 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. Le date passate devono rispettare il formato ISO-8601 es. 2017-05-23 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 |
| GET api/OuterGateF24/GetPaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
Ritorno lo stato della transazione con il relativo errore in caso la transazione non sia completata. Con esito positivo, ritorna i dati dello scontrino. |
| GET api/OuterGateF24/ReceiptJson?idSimpleF24={idSimpleF24} |
Return only a Simple F24 type receipt data |
Plafond
Api per la gestione del plafond con gli strumenti pos e cash
| API | Description |
|---|---|
| GET api/Plafond/GetVersion |
Metodo get di prova per il controller |
| POST api/Plafond/IsPlafondAvailablePos?amount={amount} |
No documentation available. |
| POST api/Plafond/DebitOnPlafondPos?amount={amount}&movementReason={movementReason} |
No documentation available. |
| POST api/Plafond/IsPlafondAvailableCash?agencyId={agencyId}&amount={amount} |
No documentation available. |
| POST api/Plafond/DebitOnPlafondCash?agencyId={agencyId}&amount={amount}&movementReason={movementReason} |
No documentation available. |
OuterGatePagoPaPis
| API | Description |
|---|---|
| POST api/OuterGatePagoPaPis/PaymentRequest |
Generate payment link for PagoPa with PIS |
| POST api/OuterGatePagoPaPis/TryConfirm |
No documentation available. |
| GET api/OuterGatePagoPaPis/GetPaymentTransactionStatus?checkId={checkId}&paymentOrderId={paymentOrderId} |
No documentation available. |
OuterGateVoucher
| API | Description |
|---|---|
| POST api/OuterGateVoucher/TransferOrder |
Crea una disposizione di bonifico |
| GET api/OuterGateVoucher/GetReceipt?idTransferOrder={idTransferOrder} |
Recupera la contabile della disposizione di bonifico |
| POST api/OuterGateVoucher/GetMovements |
Recupera i movimenti |
| GET api/OuterGateVoucher/GetPaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
Ritorna lo stato della transazione con il relativo errore in caso la transazione non sia completata. Con esito positivo, la contabile. |
Account
| API | Description |
|---|---|
| GET api/Account/UserInfo |
Api deprecata, utilizzare /api/OuterGateUsers/ |
OuterGateDDS
| API | Description |
|---|---|
| GET api/Dds/{ddsCode} |
Recupera un documento di sintesi tramite un codice Dds di un'agenzia specifica. |
OuterGateMultiPaymenBollo
| API | Description |
|---|---|
| POST api/OuterGateMultiPayment/Bollo/CreateCartOrAddToCart |
No documentation available. |
HttpTransaction
| API | Description |
|---|---|
| POST api/GetSessionID |
Ritorno l'id della sessione che è utilizzato per la generazione del HttpRequestTransactionId |
OuterGateLinkToPayment
| API | Description |
|---|---|
| POST api/OuterGateLinkToPayment/order |
Request a link to pay |
| POST api/OuterGateLinkToPayment/payRecurring |
No documentation available. |
| GET api/OuterGateLinkToPayment/infoPayment?IdPaymentOrder={IdPaymentOrder} |
Request informations about a payment with IdPaymentOrder |
OuterGatePaPay
| API | Description |
|---|---|
| GET api/OuterGatePaPay/GetVersion |
Permette di richiamare il metodo GSPATM_GetVersion del servizio PAPay; ritorna una stringa che indica la versione del servizio PAPay |
| GET api/OuterGatePaPay/GetCustomerFee?inputValue={inputValue} |
Ritorna le commissioni che verranno applicate ai pagamenti di tipo ricarica dei servizi scolastici. |
| POST api/OuterGatePaPay/IdentificationAsync |
Effettua l'identificazione e ritorna un token utile ad effettuare i pagamenti e informazioni dell’utente a cui verrà ricaricata la mensa (il bambino) |
| GET api/OuterGatePaPay/GetPaymentTransactionStatus?TransactionID={TransactionID}&RequestTransactioPaymentStatusType={RequestTransactioPaymentStatusType}&IdBulletin={IdBulletin} |
/// Ritorno lo stato della transazione con il relativo errore in caso la transazione non sia completata. Con esito positivo, ritorna i dati dello scontrino. |
| POST api/OuterGatePaPay/CheckFiscalCodeOrVatNumberIsRequiredForCustomer |
Verifica se per il cliente ordinante deve essere obbligatorio il Codice Fiscale oppure la P.IVA o il Codice Fiscale. Tale verifica va effettuata in funzione del Token di autenticazione PaPay e dell'id del cliente ordinante. Metodo da utilizzare prima di effettuare la prenotazione al pagamento (api/OuterGatePaPay/ExecTransactionAsync) per verificare se bisogna richiedere obbligatoriamente il codice fiscale al cliente intestatario. |
| POST api/OuterGatePaPay/ExecTransactionAsync |
Richiama il metodo GSPATM_ExecTransaction del servizio PAPay. E’ da considerarsi una prenotazione del pagamento. Il pagamento ancora non è stato fatto e nessun movimento bancario viene effettuato. |
| POST api/OuterGatePaPay/ConfirmTransactionAsync |
Richiama il metodo GSPATM_ConfirmTransaction del servizio PAPay. Viene effettuato il pagamento della ricarica mensa. Prima di richiamare PaPay viene eseguito il bonifico. Solo in caso di successo viene richiamato PaPay. |
| POST api/OuterGatePaPay/CancelTransactionAsync |
Richiama il metodo GSPATM_CancelTransaction del servizio PAPay. Annulla la chiamata fatta precedentemente con la Exec quindi annulla la prenotazione al pagamento. |
| GET api/OuterGatePaPay/GetReceipt?idBulletin={idBulletin} |
Ritorna uno stream di dati (la ricevuta in formato PDF) |
| POST api/OuterGatePaPay/CheckConfirmTransactionAsyncAlreadyPaid |
Verifica se è stata effettuata un'altra ricarica simile nella stessa giornata. Da richiamare prima del metodo api/OuterGatePaPay/ConfirmTransactionAsync, se ritorna true allora la ricarica mensa è già stata effettuata nella giornata e bisogna mostrare al PO un messaggio di allerta: "Attenzione! è stato effettuata una ricarica mensa identica nella giornata, se conferma, il pagamento non potrà essere stornato!" |
OuterGateCircuitoPrivativo
Controller per tutte le operazioni del circuito privativo
| API | Description |
|---|---|
| GET api/OuterGateCircuitoPrivativo/GetAllCreditOrDebtorAgenciesAuthorized?debtorOrCreditorAgencyUniqueCode={debtorOrCreditorAgencyUniqueCode}&agencyFiscalCode={agencyFiscalCode} |
Ritorna la lista di tutte le agenzie che hanno dato l'autorizzazione ad essere addebitate o accreditate da un agenzia in base al codice mandato. |
| POST api/OuterGateCircuitoPrivativo/InitiateDirectAccreditsToAgency |
Accredita all'agenzia indicata tramite codice univoco l'importo impostato. |
| POST api/OuterGateCircuitoPrivativo/InitiateDirectDebitsToAgency |
Addebita all'agenzia indicata tramite codice univoco l'importo impostato. |
| GET api/OuterGateCircuitoPrivativo/GetPaymentTransactionStatus?transactionId={transactionId} |
Recupera lo stato di un movimento del circuito privativo |
OuterGateRecharges
Metodi API per i pagamenti delle ricariche tecnologiche
| API | Description |
|---|---|
| POST api/OuterGateRecharges/CheckRechargeRequest |
Questa chiamata permetterà di verificare se è possibile effettuare la ricarica. Se la ricarica che si vuole verificare NON può essere annullata, allora questa chiamata ha la stessa valenza della chiamata "ConfirmRecharge". I parametri in ingresso sono l'id del fornitore, l'id del taglio e il numero telefonico nel caso in cui si vuole fare una ricarica Online. Il parametro in uscita è l'id della ricarica che bisognerà salvare internamente per poterlo utilizzare in tutte le altre chiamate. Bisognerà in ogni caso effettuare una conferma per poter generare la ricevuta. |
| POST api/OuterGateRecharges/CancelRechargeRequest |
Se la ricarica può essere annullata, con questa chiamata potrà essere annullata la chiamata CheckRechargeRequest appena effettuata. Il parametro in ingresso è l'id della ricarica ritornato dalla CheckRechargeRequest. |
| POST api/OuterGateRecharges/ConfirmRecharge |
Dopo aver effettuato la check della ricarica (api/OuterGateRecharges/CheckRechargeRequest), questa chiamata permetterà di confermare la ricarica passandogli l'id della ricarica restituito dalla chiamata CheckRechargeRequest. |
| GET api/OuterGateRecharges/GetRechargesProduct?rechargesCategory={rechargesCategory} |
Ritorna la lista dei gestori e per ogni gestore il suo formato. E' possibile filtrare per categoria. |
| GET api/OuterGateRecharges/GetAllRechargesProduct |
Ritorna la lista di tutti i gestori e per ogni gestore il suo taglio. |
| GET api/OuterGateRecharges/GetAllRechargePayments?startDateRequest={startDateRequest}&endDateRequest={endDateRequest} |
Ritorna tutte le ricariche effettuate, 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. Le date passate devono rispettare il formato ISO-8601 es. 2017-05-23 (AAAA-MM-GG) rif. https://en.wikipedia.org/wiki/ISO_8601 |
| GET api/OuterGateRecharges/GetReceipt?idCheckRecharge={idCheckRecharge} |
Ritorna lo stream della ricevuta in formato PDF, in funzione dell'id della ricarica ricevuto dalla chiamata api/OuterGateRecharges/CheckRechargeRequest. Lo scontrino potrà essere generato solamente dopo aver effettuato la conferma della ricarica (api/OuterGateRecharges/ConfirmRecharge). |
OuterGateUsers
| API | Description |
|---|---|
| GET api/OuterGateUsers?username={username} |
No documentation available. |