Nessun risultato trovato

POST/v3/paybylink/{id}/modify

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v3/paybylink/{id}/modify
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v3/paybylink/{id}/modify

Modifica un PayByLink

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
id L'identificativo univoco del Pay By Link. String
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

modifyPayByLinkRequest

NOME DESCRIZIONE FORMATO
expirationDateTime La data e l'ora in cui il Pay By Link scadrà. È in formato ISO 8601. Fino a 90 giorni dalla data corrente.
 String
Esempio: 2023-12-31T23:59:59Z
maxNumberOfPayments Il numero massimo di pagamenti che possono essere effettuati utilizzando questo Pay By Link. Se impostato a null, non c'è alcun limite al numero di pagamenti.
 Integer
status Lo stato del Pay By Link. Può essere ACTIVE, INACTIVE o DELETED. ACTIVE significa che il link è attivo e può essere utilizzato per i pagamenti, INACTIVE significa che il link non è attivo e non può essere utilizzato per i pagamenti, DELETED significa che il link è stato eliminato.
 String
Arrow RESPONSE 200
OK - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
executedPayments Il numero di pagamenti che sono stati eseguiti utilizzando questo Pay By Link.
 Integer
expirationDateTime La data e l'ora in cui il Pay By Link scadrà. È in formato ISO 8601. Fino a 90 giorni dalla data corrente.
 String
Esempio: 2023-12-31T23:59:59Z
linkId L'identificativo univoco del Pay By Link che è stato modificato.
 String
maxNumberOfPayments Il numero massimo di pagamenti che possono essere effettuati utilizzando questo Pay By Link. Se impostato a null, non c'è alcun limite al numero di pagamenti.
 Integer
pendingPayments Il numero di pagamenti in sospeso per questo Pay By Link.
 Integer
status Lo stato del Pay By Link. Può essere ACTIVE, INACTIVE o DELETED. ACTIVE significa che il link è attivo e può essere utilizzato per i pagamenti, INACTIVE significa che il link non è attivo e non può essere utilizzato per i pagamenti, DELETED significa che il link è stato eliminato.
 String
Arrow RESPONSE 201
Creato - Nessun header e body per questa risposta
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
Non trovato - Nessun header e body per questa risposta