API getCheckoutList

[API OPZIONALE]

Recupero lista dei pagamenti e rimborsi eseguiti presso un esercente (Server dell’esercente > Tinaba).

Spiegazione degli attributi

Nome campo	Tipo	Mandatorio	Descrizione
merchantId	String	Yes	Identificativo dell’esercente assegnato da TINABA.
dateFrom	String	Yes	Data di inizio della ricerca. Formato ‘yyyy-MM-dd’.
dateTo	String	Yes	Data di fine della ricerca. Formato ‘yyyy-MM-dd’.
signature	String	Yes	Firma di autenticazione e integrità dei dati.

La firma d’integrità dei dati, scambiata nel campo “signature”, è basata su un segreto condiviso, scambiato offline, ed è generata utilizzando il protocollo SHA256.

signature = base64(SHA256(<merchantId><externalId><secret>))

Per maggiori informazioni su come generare la firma d’integrità consultare:

Integrità dei dati >

Spiegazione degli attributi – Risposta

Nome campo	Tipo	Mandatorio	Descrizione
status	String	Yes	000 = OK 001 = KO.
errorCode	String	No	Valorizzato solo se status = 001. Codice di errore.
checkoutList	List	No	Lista dei pagamenti e rimborsi completati.
merchantId	checkout	Yes	Identificativo dell’esercente assegnato da TINABA.
externalId	checkout	Yes	Identificativo del pagamento pendente sul server dell’esercente.
amount	checkout	Yes	Importo del pagamento in centesimi.
currency	checkout	Yes	Divisa del pagamento.
authTime	checkout	Yes	Data del pagamento. Formato ‘yyyy-MM-dd-HH.mm.ss’.
transactionType	checkout	Yes	PAYMENT = pagamento REFUND = rimborso.
state	checkout	Yes	EXECUTED = completato con successo FAILED = completato con errore (pagamento fallito, o annullato dall’esercente) PENDING = non completato (pagamento pendente) PREAUTH = pagamento preautorizzato da confermare.
internalTransactionId	checkout	No	Id operazione interna Tinaba in caso di pagamento effettuato.

Richiesta

{
   "data":{
      "request":{
         "getCheckoutListRequest":{
            "merchantId":"4198",
            "dateFrom":"2018-02-05",
            "dateTo":"2018-02-06",
            "signature":"AAIR12345"
         }
      }
   }
}

Risposte

200 Success

{
   " response":{
      "getCheckoutListResponse":{
         "status":"000",
         "checkoutList":[
            {
               "externalId":"xWTGDUVrZB",
               "merchantId":"4198",
               "amount":"15",
               "currency":"EUR",
               "authTime":"2018-02-05-15.26.35",
               "transactionType":"PAYMENT",
               "state":"PENDING"
            },
            {
               "externalId":"EP_29",
               "merchantId":"4198",
               "amount":"10",
               "currency":"EUR",
               "authTime":"2018-02-05-15.24.15",
               "transactionType":"PAYMENT",
               "state":"PREAUTH",
               "internalTransactionId":"46284"
            },
            {
               "externalId":"DetelVp520",
               "merchantId":"4198",
               "amount":"15",
               "currency":"EUR",
               "authTime":"2018-02-05-15.08.17",
               "transactionType":"REFUND",
               "state":"EXECUTED",
               "internalTransactionId":"45603"
            },
            {
               "externalId":"DetelVp520",
               "merchantId":"4198",
               "amount":"15",
               "currency":"EUR",
               "authTime":"2018-02-05-15.06.48",
               "transactionType":"PAYMENT",
               "state":"EXECUTED",
               "internalTransactionId":"45599"
            }
         ]
      }
   }
}

400 Errore Validazione

{
   " response":{
      "getCheckoutListResponse":{
         "status":"001",
         "errorCode":"XXX"
      }
   }
}