Nessun risultato trovato

POST/operations/{operationId}/captures

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

Contabilizzazione parziale o totale. 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
Idempotency-Key Chiave di idempotenza per garantire richieste idempotenti. Viene utilizzato per prevenire operazioni duplicate in caso di problemi di rete o nuovi tentativi.
Il valore deve essere univoco per ogni richiesta e può contenere fino a 128 caratteri.
 String
X-Api-Key Chiave API di autenticazione. String
Formato: uuid
Esempio: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NOME DESCRIZIONE FORMATO
operationId Codice identificativo dell'operazione.
 String
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

captureRequest

NOME DESCRIZIONE FORMATO
amount Importo della transazione nell'unità monetaria più piccola. 5000 corrisponde a 50,00 €. Espresso nella valuta del pagamento.
 String
currency Valuta della transazione. Codice alfabetico ISO 4217
 String
Esempio: EUR
description Disponibile messaggio di testo gratuito per descrivere la logica dell'operazione post.
 String
Lunghezza max: 255
Arrow RESPONSE 200
Richiesta elaborata con successo - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
operationId Identificativo dell'operazione.
 String
Esempio: 3470744
operationTime Tempo successivo all'operazione.
 String
Esempio: 2022-09-01T01:20:00.001Z
Arrow RESPONSE 201
Creato - Nessun header e body per questa risposta
Arrow RESPONSE 400
Richiesta rifiutata - 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 403
Vietato - 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