Nessun risultato trovato

POST/build/cancel

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/build/cancel
TEST
https://stg-ta.nexigroup.com/api/phoenix-0.0/psp/api/v1/build/cancel

Annulla un pagamento tramite la soluzione XPay Build.

PARAM HEADER
NOME DESCRIZIONE FORMATO
X-Api-Key Chiave API d'autenticazione. String
Formato: uuid
Correlation-Id Mandatory field to be valued with a UUID to be renewed at every call. The purpose of the field is to allow referring to a specific call for any integration or maintenance activity. String
Formato: uuid
PARAM PATH
NOME DESCRIZIONE FORMATO
No param path
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

NOME DESCRIZIONE FORMATO
sessionId Identificativo sessione. String
Esempio: 052211e8/+54cc/4e0a
Arrow RESPONSE 200
Richiesta elaborata con successo - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
state Stato della transazione. String
operation Oggetto contenente il dettaglio dell'operazione. Object
orderId ID ordine esercente, univoco nel dominio esercente. String
Lunghezza max: 18
Esempio: btid2384983
operationId ID operazione. String
Esempio: 3470744
channel "Indica il canale di origine:\n
* ECOMMERCE - il titolare carta ha eseguito l'operazione attraverso un canale online.
* POS - il titolare carta ha eseguito l'operazione attraverso un POS fisico.
* BACKOFFICE - l'esercente ha eseguito l'operazione. Include le operazioni tramite API e le MIT.
 String
Esempio: ECOMMERCE
operationType Indica la tipologia di operazione effettuata.
- AUTHORIZATION - qualsiasi autorizzazione con contabilizzazione esplicita.
- CAPTURE - autorizzazione contabilizzazione oppure un pagamento con contabilizzazione implicita.
- VOID - revoca di un'autorizzazione.
- REFUND - rimborso di una capture.
- CANCEL - il rollback di una capture, rimborso.
- CARD_VERIFICATION - operazione di verifica, senza nessun addebito, con il solo scopo di confermare la validità dei dati carta inseriti dal cliente.
- NOSHOW - operazione di noshow (riservato al servizio Incasso senza pensieri).
- INCREMENTAL - operazione di incremental (riservato al servizio Incasso senza pensieri).
- DELAY_CHARGE - operazione di delay charge (riservato al servizio Incasso senza pensieri).
 String
Esempio: CAPTURE
operationResult Esito dell'operazione:
* AUTHORIZED - Pagamento autorizzato
* EXECUTED - Pagamento confermato, verifica effettuata con successo
* DECLINED - Rifiutato dall'emittente durante la fase di autorizzazione
* DENIED_BY_RISK - Negativo esito dell'analisi di rischio della transazione
* THREEDS_VALIDATED - Autenticazione 3DS OK oppure 3DS saltata (pagamento non sicuro)
* THREEDS_FAILED - Cancellazione oppure autenticazione fallita durante il 3DS
* PENDING - Pagamento in corso. Sono previste notifiche
* CANCELED - Cancellato dal titolare carta
* VOIDED - Storno online dell'intero importo autorizzato
* REFUNDED - Importo intero o parziale rimborsato
* FAILED - Pagamento fallito per ragioni tecniche
 String
Esempio: AUTHORIZED
operationTime Data e ora dell'operazione. String
Esempio: 2022-09-01T01:20:00.001Z
paymentMethod * CARD - Qualsiasi circuito di carte
* APM - Metodo di pagamento alternativo
 String
Esempio: CARD
paymentCircuit Uno dei circuiti di pagamento ritornati dalla chiamata GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY ecc. String
Esempio: VISA
paymentInstrumentInfo Informazioni sullo strumento di pagamento. String
Esempio: ***6152
paymentEndToEndId È definito dal circuito per identificare in modo univoco la transazione. Richiesto per scopi di riconciliazione circuita. String
Lunghezza max: 35
Esempio: e723hedsdew
cancelledOperationId ID operazione da annullare. String
Esempio: 321312
operationAmount Importo dell'operazione nella valuta di pagamento. String
Esempio: 3545
operationCurrency Valuta della transazione nel codice ISO 4217. String
Esempio: EUR
customerInfo Oggetto contenente il dettaglio del cliente. Inviare il contenuto di questo oggetto aumenta il livello di sicurezza della transazione, aumentando così la probabilità che non venga richiesta l'autenticazione a due fattori nel pagamento. Object
cardHolderName Nome e cognome del titolare della carta. String
Lunghezza max: 255
Esempio: Mauro Morandi
cardHolderEmail Email del titolare della carta. String
Lunghezza max: 255
Esempio: mauro.morandi@nexi.it
billingAddress Oggetto contenente il dettaglio dell'indirizzo del cliente. Object
name Nome e cognome. String
Lunghezza max: 50
Esempio: Mario Rossi
street Indirizzo completo. String
Lunghezza max: 50
Esempio: Piazza Maggiore, 1
additionalInfo Informazioni aggiuntive sull'indirizzo, per esempio il piano. String
Lunghezza min: 1
Lunghezza max: 50
Esempio: Quinto Piano, Scala B
city Città. String
Lunghezza min: 1
Lunghezza max: 40
Esempio: Bologna
postCode Codice postale. String
Lunghezza min: 1
Lunghezza max: 10
Esempio: 40124
province Codice della provincia. String
Lunghezza max: 3
Esempio: BO
country Stato secondo il codice ISO 3166-1 alpha-3.
Il parametro è obbligatorio con i seguenti metodi di pagamento alternativi:
- Bancontact: valorizzare "country" con "BEL".
- Giropay: valorizzare "country" con "DEU".
- Multibanco: valorizzare "country" con "PRT".
 String
Lunghezza min: 3
Lunghezza max: 3
Esempio: ITA
shippingAddress Oggetto contenente il dettaglio dell'indirizzo del cliente. Object
name Nome e cognome. String
Lunghezza max: 50
Esempio: Mario Rossi
street Indirizzo completo. String
Lunghezza min: 1
Lunghezza max: 50
Esempio: Piazza Maggiore, 1
additionalInfo Informazioni aggiuntive sull'indirizzo, per esempio il piano. String
Lunghezza min: 1
Lunghezza max: 50
Esempio: Quinto Piano, Scala B
city Città. String
Lunghezza min: 1
Lunghezza max: 40
Esempio: Bologna
postCode Codice postale. String
Lunghezza min: 1
Lunghezza max: 10
Esempio: 40124
province Codice della provincia. String
Lunghezza max: 3
Esempio: BO
country Stato secondo il codice ISO 3166-1 alpha-3. String
Lunghezza min: 3
Lunghezza max: 3
Esempio: ITA
mobilePhoneCountryCode Prefisso del numero di telefono. String
Lunghezza max: 4
Esempio: +39
mobilePhone Numero di cellulare. String
Lunghezza max: 15
Esempio: 3280987654
homePhone Telefono di casa fornito dal titolare carta. String
Lunghezza max: 18
Esempio: +391231234567
workPhone Numero di telefono lavorativo fornito dal titolare carta. String
Lunghezza max: 18
Esempio: 391231234567
cardHolderAcctInfo Oggetto contenente informazioni relative all'account dell'acquirente. Object
chAccDate Data di attivazione dell'account sul sito dell'esercente. String
Esempio: 2019-02-11
chAccAgeIndicator Indicatore dell'anzianità dell'account sul sito dell'esercente:
01 = Nessun account
02 = Creato durante questa transazione
03 = Creato negli ultimi 30 giorni
04 = Creato tra 30 e 60 giorni fa
05 = Creato prima di 60 giorni fa
 String
Esempio: 01
chAccChangeDate Data dell'ultima variazione dell'account sul sito dell'esercente, incluso l'indirizzo di fatturazione o spedizione, nuovo metodi di pagamento o l'aggiunta di nuovi utenti. String
Esempio: 2019-02-11
chAccChangeIndicator Tempo trascorso dall'ultima modifica delle informazioni sull'account dell'acquirente sul sito dell'esercente, incluso l'indirizzo di fatturazione o spedizione, nuovo metodo di pagamento o l'aggiunta di nuovi utenti.
01 = Creato durante questa transazione
02 = Creato negli ultimi 30 giorni
03 = Creato tra 30 e 60 giorni fa
04 = Creato prima di 60 giorni fa
 String
Esempio: 01
chAccPwChangeDate Data di ultimo cambio password dell'account (incluso reset password). String
Esempio: 2019-02-11
chAccPwChangeIndicator Tempo trascorso da quando l'account dell'acquirente ha eseguito una modifica della password o il ripristino dell'account:
01 = Nessun account
02 = Creato durante questa transazione
03 = Negli ultimi 30 giorni
04 = Tra 30 e 60 giorni fa
05 = Prima di 60 giorni fa
 String
Esempio: 01
nbPurchaseAccount Numero di acquisti di questo account negli ultimi 6 mesi. Integer
Lunghezza min: 1
Lunghezza max: 4
Esempio: 0
destinationAddressUsageDate Data di ultimo utilizzo di questo indirizzo di consegna. String
Esempio: 2019-02-11
destinationAddressUsageIndicator Indica quando l'indirizzo di spedizione utilizzato per questa transazione è stato utilizzato per la prima volta:
01 = Creato durante questa transazione
02 = Creato negli ultimi 30 giorni
03 = Creato tra 30 e 60 giorni fa
04 = Creato prima di 60 giorni fa
 String
Esempio: 01
destinationNameIndicator Indica se il nome associato all'account corrisponde al nome indicato per la spedizione:
01 = Nome dell'account identico al nome dell'indirizzo di spedizione.
02 = Nome dell'account diverso dal nome dell'indirizzo di spedizione.
 String
Esempio: 01
txnActivityDay Numero di transazioni (riuscite e abbandonate) per questo account nelle 24 ore precedenti. Integer
Lunghezza min: 1
Lunghezza max: 3
Esempio: 0
txnActivityYear Numero di transazioni (riuscite e abbandonate) per questo account nell'anno precedente. Integer
Lunghezza min: 1
Lunghezza max: 3
Esempio: 0
provisionAttemptsDay Numero di tentativi di aggiunta nuova carta nelle ultime 24 ore. Integer
Lunghezza min: 1
Lunghezza max: 3
Esempio: 0
suspiciousAccActivity Indica se l'esercente ha rilevato attività sospette (incluse precedenti frodi) sull'account dell'acquirente.
01 = Nessun attività sospetta verificata.
02 = Rilevate attività sospette.
 String
Esempio: 01
paymentAccAgeDate Data di attivazione dell'account di pagamento. String
Esempio: 2019-02-11
paymentAccIndicator Indica quando l'acquirente ha inserito l'account di pagamento sul sito del merchant:
0 = Nessun account
01 = Creato durante questa transazione
02 = Creato negli ultimi 30 giorni
03 = Creato tra 30 e 60 giorni fa
04 = Creato prima di 60 giorni fa
 String
Esempio: 0
merchantRiskIndicator Oggetto contenente informazioni relative all'acquisto effettuato. Object
deliveryEmail Nel caso di acquisto di prodotti virtuali/digitali: indirizzo mail verso cui viene inviato il prodotto. String
Esempio: john.doe@email.com
deliveryTimeframe Indicatore sul periodo di consegna della merce:
01 = Consegna immediata (prodotti virtuali/digitali).
02 = Consegna nello stesso giorno.
03 = Consegna notturna.
04 = Consegna in due o più giorni.
 String
Esempio: 01
giftCardAmount Oggetto contenente informazioni relative all'importo delle carte regalo o buoni. Object
value Valore della carta regalo o prepagata utilizzata per la transazione. L'importo deve essere espresso in centesimi. Number
Esempio: 100
currency Valuta della transazione nel codice ISO 4217. String
Esempio: EUR
giftCardCount Totale delle singole carte/codici prepagate o regalo acquistati. Integer
Esempio: 2
preOrderDate Per un acquisto preordinato, la data prevista in cui la merce sarà disponibile. String
Esempio: 2019-02-11
preOrderPurchaseIndicator Indica se l'acquirente sta effettuando un ordine per merce con disponibilità futura:
01 = Merce disponibile.
02 = Disponibilità futura.
 String
Esempio: 01
reorderItemsIndicator Indica se l'acquirente sta riordinando merce acquistata in precedenza:
01 = Primo ordine.
02 = Merce già acquistata in precedenza.
 String
Esempio: 01
shipIndicator Indicatore sulla tipologia di consegna:
01 = Spedizione all'indirizzo di fatturazione.
02 = Spedizione ad un altro indirizzo verificato dal merchant.
03 = Spedizione ad un indirizzo differente da quello di fatturazione.
04 = Spedizione o ritiro al negozio (l'indirizzo del negozio deve essere indicato nei campi di destinazione).
05 = Beni virtuali/digitali, inclusi servizi online, buoni regalo elettronici, codici di riscossione.
06 = Biglietti di viaggi ed eventi (non spediti).
07 = Altro: per esempio giochi, servizi digitali non spediti, abbonamenti a media elettronici.
 String
Esempio: 01
warnings Array contenente la lista di warning. Array
code Codice warning. String
Esempio: TRA001
description Descrizione warning. String
Esempio: 3DS warning
paymentLinkId ID PayByLink utilizzato per correlare questa operazione con il collegamento originale. String
Esempio: 234244353
additionalData Mappa dei campi aggiuntivi specifici per il metodo di pagamento scelto. Object
Esempio: {"authorizationCode":"647189","cardCountry":"ITA","threeDS":"FULL_SECURE","schemaTID":"MCS01198U","multiCurrencyConversion":{"amount":"2662","currency":"JPY","exchangeRate":"0.007510523"}}
Arrow RESPONSE 400
Dati della richiesta non validi - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
errors Array contenente la lista degli errori. I valori possibili sono riportati nella tabella Codici errore. Array
code Codice errore. String
Esempio: GW0001
description Descrizione errore. String
Esempio: Invalid merchant URL
Arrow RESPONSE 401
Non autorizzato - Nessun header e body per questa risposta
Arrow RESPONSE 500
Internal Server Error - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
errors Array contenente la lista degli errori. I valori possibili sono riportati nella tabella Codici errore. Array
code Codice errore. String
Esempio: GW0001
description Descrizione errore. String
Esempio: Invalid merchant URL