Getting started
Overview
Per poter utilizzare il servizio TsPay si deve:
- Lato azienda: attivare il servizio all'interno di Digital ed effettuare poi l'onboarding.
- Lato applicativo integrante: configurare l'applicativo su NCS per ricevere le notifiche sulle operazioni effettuate.
Studio e Gestita
Nel caso di uno studio che vuole utilizzare i servizi di TsPay su una sua gestita, non è necessario che lo studia faccia l'onboarding, ma è sufficiente che estenda il servizio sulla gestita, e poi sia questa a fare l'onboarding su TsPay (riconducendosi quindi al caso precedente).
Azienda: Attivazione e Onboarding
1. Attivazione
Attivare il servizio all'interno di Digital, quindi entrare nella pagina di configurazione tramite la cta "Configura TS Pay" o tramite l'icona in alto a destra nella card:
Una volta dentro, seguire la cta "Registra azienda" che reindirizzerà l'utente su TsPay per permettere l'onboarding.
2. Onboarding
Atterrati su TsPay, fare login con l'utenza desiderata (o crearne una nuova) e procedere con l'onboarding.
Per dettagli sull'onboarding in ambiente di test seguire i passaggi dal punto 3 al punto 5 o 7 descritti a questo link.
3. Finalizzazione (solo test e dev)
Una volta completato l'onboarding, in ambiente di test e dev il processo va finalizzato tramite una chiamata API: qui dettagli. Se la chiamata va a buon fine si riceveranno due email, alla casella di posta dell'utente con cui ci si è loggati in TsPay:
- Conferma di onboarding azienda, con codice titolare (merchant ref).
- Conferma di creazione ApiKey, con link per l'attivazione della stessa.
4. Attivazione ApiKey
Seguire il link ricevuto nella seconda email, per l'attivazione dell'ApiKey.
Azienda: Finalizzazione Onboarding
SOLO TEST E DEV
Per finalizzare l'onboarding (step 3 di questo processo) va effettuata una chiamata ad uno dei due seguenti endpoint (sono alternativi):
1. Utilizzando la session-key dell'onboarding appena concluso:
[PUT] /internal/helpers/finalizeonboarding/by-sessionkey/{onboardingSessionKey}
2. Utilizzando l'itemUuid dell'azienda onboardata:
[PUT] /internal/helpers/finalizeonboarding/by-itemid/{itemId}
I due endpoint NON sono esposti dal pay-gateway ma dal servizio ts-pay-config-write e sono disponibili solo in ambiente di test e dev. Swagger:
Esito: se la chiamata va a buon fine si riceveranno due email, alla casella di posta dell'utente con cui ci si è loggati in TsPay:
- Conferma di onboarding azienda completato, con codice titolare (merchant ref).
- Conferma di creazione ApiKey, con link per l'attivazione della stessa.