Nessun risultato trovato

GET/operations/{operationId}/actions

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}/actions
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}/actions

Recupera le azioni consentite associate a un'operazione e l'intervallo di valori accettabili. Per maggiori informazioni sulle operazioni, consulta la pagina dedicata Operations.

PARAM HEADER
NOME DESCRIZIONE FORMATO
Correlation-Id Campo obbligatorio nel formato UUID v4.
Lo scopo di questo campo è tracciare la richiesta su diversi sistemi, semplificando il debug e il monitoraggio delle richieste.
 String
Formato: uuid
Esempio: 123e4567-e89b-12d3-a456-426614174000
X-Api-Key Chiave API di autenticazione. String
Formato: uuid
Esempio: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NOME DESCRIZIONE FORMATO
operationId Identificativo dell'operazione
 String
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

NOME DESCRIZIONE FORMATO
No param body
Arrow RESPONSE 200
Successo - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
actions Array contenente l'elenco delle azioni.
 Array
action Tipo di azione che può essere eseguita sull'ordine.
È l'operazione che il commerciante può eseguire sull'ordine, come cattura, rimborso, annullamento, ecc.
I valori possibili sono:
- CAPTURE: cattura di un ordine autorizzato. Può essere eseguito solo su un ordine autorizzato che non è stato ancora catturato. L'importo da riscuotere può essere inferiore o uguale all'importo autorizzato.
È possibile eseguire più prelievi sullo stesso ordine autorizzato fino a quando l'importo totale catturato non sarà pari all'importo autorizzato.
Successivamente, non sarà più possibile eseguire alcuna acquisizione su tale operazione.
È anche possibile effettuare un'acquisizione su un ordine parzialmente catturato, specificando un importo inferiore o uguale all'importo residuo autorizzato. Ad esempio, se un ordine è stato autorizzato per 100 e già catturato per 30, è possibile eseguire un'altra cattura per un importo inferiore o uguale a 70.
Successivamente, non sarà più possibile eseguire alcuna acquisizione su tale operazione.
- ANNULLA: annulla un'azione di cattura. Può essere eseguita solo su un'operazione di tipo CAPTURE. Questo è disponibile solo in caso di cattura di tipo ESPLICITA, mentre non è disponibile in caso di cattura IMPLICITA.
- RIMBORSO: rimborso di un ordine catturato. Può essere eseguito solo su un ordine catturato.
L'importo da rimborsare può essere inferiore o uguale all'importo catturato.
È possibile eseguire più rimborsi sullo stesso ordine acquisito fino a quando l'importo totale rimborsato non sarà pari all'importo acquisito.
Dopodiché non sarà più possibile effettuare alcun rimborso per quell'operazione.
È possibile eseguire il rimborso anche su un ordine parzialmente rimborsato, specificando un importo inferiore o uguale all'importo rimanente catturato.
Ad esempio, se un ordine è stato catturato per 100 e già rimborsato per 30, è possibile eseguire un altro rimborso per un importo inferiore o uguale a 70.
Dopodiché non sarà più possibile effettuare alcun rimborso per quell'operazione.
- NULLO: è l'annullamento di un'autorizzazione. Può essere eseguita su un ordine autorizzato che non è stato ancora catturato o su transazioni catturate. Dopo aver eseguito un'azione VOID, non è possibile eseguire altre azioni sull'operazione.
 String
currency Valuta nel formato ISO 4217.
 String
defaultAmount Importo predefinito per l'azione. È l'importo proposto dal gateway
per l'esecuzione dell'azione, ma può essere modificato dal commerciante entro l'intervallo consentito (tra minAmount e maxAmount).
 String
maxAmount Importo massimo consentito per l'esecuzione dell'azione. È il limite superiore dell'importo che il commerciante può specificare per l'esecuzione dell'azione.
 String
minAmount Importo minimo consentito per l'esecuzione dell'azione. È il limite inferiore dell'importo che il commerciante può specificare per l'esecuzione dell'azione.
 String
Arrow RESPONSE 400
Richiesta non valida - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
errors Array contenente l'elenco degli errori. I possibili valori sono riportati nella tabella Codici errore.
 Array
code Codice errore.
 String
Esempio: GW0001
description Descrizione dell'errore.
 String
Esempio: Invalid merchant URL
Arrow RESPONSE 401
Non autorizzato - Nessun header e body per questa risposta
Arrow RESPONSE 404
Operazione non trovata - Nessun header e body per questa risposta
Arrow RESPONSE 500
Errore interno del server - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
errors Array contenente l'elenco degli errori. I possibili valori sono riportati nella tabella Codici errore.
 Array
code Codice errore.
 String
Esempio: GW0001
description Descrizione dell'errore.
 String
Esempio: Invalid merchant URL