API > GET /contracts/customers/{customerId}

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}

Recupera contratti per ID cliente

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

customerId

ID cliente

String
Esempio: 36451278

PARAM QUERY

NOME

DESCRIZIONE

FORMATO

No param query

PARAM BODY

NOME

DESCRIZIONE

FORMATO

No param body

RESPONSE 200

Richiesta elaborata con successo - Nessun header per questa risposta

BODY

NOME

DESCRIZIONE

FORMATO

contracts

Array contenente l'elenco dei contratti.

Array

contractExpiryDate	Utilizzato con contractType MIT_SCHEDULED.	String
contractFrequency	Utilizzato con contractType MIT_SCHEDULED. Numero di giorni.	String Lunghezza max: 4 Esempio: 120
contractId	Identificatore del contratto. Il valore deve essere lungo tra 1 e 18 caratteri. Per mantenerlo unico, utilizza un commerciante stabile o un prefisso di canale insieme a una sequenza monotona, un timestamp o un riferimento al contratto della piattaforma, evitando il riutilizzo per diversi contratti ricorrenti.	String Lunghezza min: 1 Lunghezza max: 18 Esempio: C2834987
contractType	Indica le opzioni disponibili per i pagamenti successivi: * CIT - il contratto può essere utilizzato solo per i pagamenti successivi disposti dal * MIT_SCHEDULED - il contratto può essere utilizzato per transazioni programmate avviate dal commerciante. Il numero di giorni tra un pagamento e l'altro deve essere uguale o maggiore del valore di `contractFrequency` * MIT_UNSCHEDULED - il contratto può essere utilizzato per transazioni non programmate avviate dal commerciante. Il valore contractFrequency non ha alcun effetto in questo caso.	String Esempio: CIT
paymentCircuit	uno dei valori del circuito di pagamento restituiti dal web service GET payment_methods VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY ecc.	String
paymentInstrumentInfo	Informazioni sullo strumento di pagamento.	String
paymentMethod	* CARD - Qualsiasi circuito di scheda * APM - Metodo di pagamento alternativo	String Esempio: CARD

customerId

Identificatore del cliente calcolato dal commerciante per corrispondere al cliente registrato sulla piattaforma di e-commerce.
Utilizzare solo lettere, cifre, trattino basso (_) o trattino (-).

String
Lunghezza max: 27
Esempio: mcid97295873

RESPONSE 401

Non autorizzato - Nessun header e body per questa risposta

RESPONSE 403

Vietato - Nessun header e body per questa risposta

RESPONSE 404

Cliente non trovato - Nessun header e body per questa risposta

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