Nessun risultato trovato

POST/reservations/{reservationId}/paybylink

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/reservations/{reservationId}/paybylink
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/reservations/{reservationId}/paybylink

Genera PayByLink per una prenotazione specifica. In caso di primo pagamento per la prenotazione, viene creato un contractId. In caso di pagamento successivo viene utilizzato l'Id del contratto di prenotazione esistente. Il contractId viene creato in automatico dall'API, per essere utilizzato successivamente per eventuali noshow, incremental; non è necessario inviare un oggetto specifico per la sua creazione. Il contractId non viene restituito in risposta all'API, non può essere quindi utilizzato per eseguire operazioni MIT.

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
reservationId ID prenotazione esercente, univoco nel dominio esercente String
Formato: uuid
PARAM QUERY
NOME DESCRIZIONE FORMATO
No param query
PARAM BODY

NOME DESCRIZIONE FORMATO
linkExpirationDate Data di scadenza per Paybylink. String
Esempio: 2022-09-01
captureType Sovrascrive il metodo di conferma predefinito del terminale, per solo carte di pagamento:
* IMPLICIT - conferma automatica
* EXPLICIT - solo autorizzazione

Il valore predefinito dipende dalla configurazione del terminale:
    1. Terminale impostato su ESPLICITO:
        a. se il captureType è EXPLICIT l'acquisizione sarà esplicita
        b. se il captureType è nullo l'acquisizione sarà ESPLICITA
        c. se il captureType è IMPLICIT l'acquisizione sarà implicita

    2. Terminale impostato su IMPLICITO:
        a. se il captureType è EXPLICIT l'acquisizione restituirà un errore
        b. se il captureType è nullo l'acquisizione sarà implicita
        c. se il captureType è IMPLICIT l'acquisizione sarà implicita 		String
Esempio: EXPLICIT
Arrow RESPONSE 200
Success - Nessun header per questa risposta
BODY
NOME DESCRIZIONE FORMATO
paymentLink Oggetto contenente il dettaglio sul link di pagamento. Object
linkId Identificatore univoco per questo link. String
Esempio: 92864835
amount Importo della transazione nell'unità monetaria più piccola. 50 EUR sono rappresentati come 5000 (2 decimali) 50 JPY sono rappresentati come 50 (0 decimali). String
Esempio: 3545
expirationDate Data di scadenza. String
Esempio: 2022-09-01
link Link da condividere con il cliente per effettuare il pagamento. String
Esempio: https://{gateway_hosted_page}
paidByOperationId ID operazione che identifica il pagamento andato a buon fine relativo a questo link. String
Esempio: 3470744
securityToken Token che può essere utilizzato per convalidare le notifiche relative a questo pagamento. String
Esempio: 2f0ea5059b41414ca3744fe672327d85
Arrow RESPONSE 400
Invalid request data - 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
Unauthorized - 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