Nessun risultato trovato

GET/contracts/customers/{customerId}

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/contracts/customers/{customerId}
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/contracts/customers/{customerId}

Ricerca contratti tramite l'identificativo del cliente. Per maggiori informazioni sui contratti fare riferimento alla pagina dedicata Contratti.

PARAM HEADER
NOME DESCRIZIONE FORMATO
X-Api-Key Chiave API d'autenticazione. String
Formato: uuid
Esempio: 625b4884-38f8-11ed-a261-0242ac120002
Correlation-Id Identificatore univoco della richiesta. String
Formato: uuid
Esempio: 4935e818-38e0-11ed-a261-0242ac120002
PARAM PATH
NOME DESCRIZIONE FORMATO
customerId Identificativo del cliente. String
Esempio: 36451278
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

NOME DESCRIZIONE FORMATO
No param body
Arrow RESPONSE 200
Richiesta elaborata con successo - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
customerId ID Cliente. String
Esempio: 36451278
contracts Array contenente la lista di contratti. Array
contractId ID contratto. String
Lunghezza min: 1
Lunghezza max: 18
Esempio: C2834987
contractType * MIT_UNSCHEDULED - una volta tokenizzata la carta, l'esercente eseguirà gli addebiti successivi con cadenza non definita
* MIT_SCHEDULED - una volta tokenizzata la carta, l'esercente eseguirà gli addebiti successivi con cadenza definita (es. primo di ogni mese)
* CIT - la carta viene tokenizzata per permettere al titolare di eseguire pagamenti successivi più rapidi. A differenza delle transazioni MIT l'esercente non avrà la possibilità di eseguire addebiti diretti su queste carte tokenizzate, in quanto il pagamento successivo CIT è sottoposto ad autenticazione (SCA) da parte del titolare carta
String
Esempio: MIT_UNSCHEDULED
contractExpiryDate Utilizzato con contractType MIT_SCHEDULED. String
Esempio: 2023-03-16
contractFrequency Utilizzato con contractType MIT_SCHEDULED. Numero di giorni. String
Lunghezza max: 4
Esempio: 120
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
Arrow RESPONSE 404
Cliente non trovato - Nessun header e body per questa risposta
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