Trasferimento diretto

Utilizza questo endpoint per trasferire denaro dal tuo conto di pagamento ad un altro conto interno a Soisy.

Richiesta

Endpoint

Sandbox: http://api.sandbox.soisy.it/api/users/{userId}/payment-accounts/{paymentAccountId}/direct-transfers
Produzione: https://api.soisy.it/api/users/{userId}/payment-accounts/{paymentAccountId}/direct-transfers

Metodi accettati

POST

Autenticazione

Questa API richiede l'autenticazione tramite header X-Auth-Token.

Parametri

Parametro Richiesto Tipo Formato Descrizione
amount Si Stringa Valore del trasferimento in euro
userId Si Stringa Id utente
paymentAccountId Si Stringa Id conto di pagamento
otp Si Stringa One time password utilizzato per confermare il trasferimento
counterpart Si Stringa Email della controparte
date No Stringa Data della richiesta (se omessa viene usata la data corrente

Esempio da utilizzare per la sandbox

Di seguito l'esempio di una richiesta:

    curl 'http://api.sandbox.soisy.it/api/users/{userId}/payment-accounts/{paymentAccountId}/direct-transfers' -H 'X-Auth-Token: {token}' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"amount":"100","date":"2019-03-12","paymentAccountId":"{paymentAccountId}","userId":"{userId}","otp":"0000000","counterpart":"carlo@example.com","details":"test"}'

Risposta

L'API restituisce un oggetto JSON.

Codici HTTP di risposta

Codice Descrizione
200 Richiesta completata con successo
400 Errore di sintassi o di dominio
403 Impossibile autenticare la richiesta
404 Risorsa non trovata
500 Errore di sistema

Risposta valida

{
  "userId": <stringa>,
  "paymentAccountId": <stringa>,
  "counterpart": <stringa>,
  "amount": <stringa>,
  "details": <stringa>
}

Risposta di errore

L'oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta.

Errore 400

Le risposte con questo codice HTTP indicano un errore lato client.

 {
     "errors": {errorMessage}
 }

Errore 403

La richiesta inviata contiene delle credenziali non valide. Controlla l'header X-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell'autenticazione.

 {
     "errors": "Access denied"
 }

Errore 404

Le risposte con questo codice HTTP indicano che la risorsa non è stata trovata.

 {
     "errors": {errorMessage}
 }

Errore 500

Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.

 {
     "errors": {errorMessage}
 }