Operazioni

Un'operazione rappresenta un'azione eseguita su un ordine, ad esempio un pagamento o uno storno. L'operazione viene codificato nelle API tramite il parametro "operationId", il cui valore viene sempre assegnato da XPay e restituito in risposta nelle chiamate di:

• Hosted Payment Page
• Pay-by-Link
• XPay Build
• Server to Server
• Storno
• Contabilizzazione
• Annullo

Di seguito vengono presentate le API messe a disposizione per la gestione delle operazioni.

• Ricerca operazione (GET /operations/{operationId}): restituisce le informazioni relative ad un'operazione.
• Elenco operazioni (GET /operations): restituisce l’elenco delle operazioni che soddisfano i filtri impostati nella richiesta.
• Elenco azioni (GET/operations/{operationId}/actions): recupera le azioni consentite (es. Storno, Contabilizzazione) associate ad un'operazione e l'intervallo di valori accettabili.
• Storno (POST /operations/{operationId}/refunds): effettua un'operazione di storno. Uno storno è l'annullo di un pagamento, con conseguente accredito dell'importo verso il cliente.
• Contabilizzazione (POST /operations/{operationId}/captures): effettua un'operazione di contabilizzazione. La contabilizzazione è la conferma di un pagamento autorizzato.
  È necessario distinguere tra due modalità di contabilizzazione:
  • Implicita: contestualmente alla fase di pagamento, ogni transazione autorizzata viene implicitamente contabilizzata. Non sarà quindi necessario utilizzare l'API di contabilizzazione.
  • Esplicita: dopo la fase di pagamento sarà necessario procedere alla conferma esplicita delle transazioni autorizzate che si desidera vengano contabilizzate e liquidate tramite l'API di contabilizzazione.
• Annullo (POST /operations/{operationId}/cancels): annulla un'operazione di contabilizzazione. Non si applica a nessun altro tipo di operazione.

NOTE:

Le operazioni eseguite attraverso il pannello di backoffice non risultano visibili tramite API. Ad esempio, nel caso di un'operazione di storno eseguita nel back office, tale attività non sarà rilevabile tramite l'API di interrogazione ordine.