Controllo disponibilità

Utilizza questo endpoint per controllare se nel conto è disponibile la somma indicata.

Richiesta

Endpoint

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

Metodi accettati

GET

Autenticazione

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

Parametri

Parametro Obbligatorio Tipo Formato Descrizione
amount Intero Importo da controllare in centesimi di €

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}/availability?amount=20023' -H 'X-Auth-Token: {token}' -H 'Content-Type: application/json;charset=UTF-8'

Risposta

L'API restituisce un oggetto JSON.

Codici HTTP di risposta

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

Risposta valida

{
     "result": <booleano>,
     "message": <stringa>
}

Dove:

Parametro Tipo Descrizione
result Booleano Questo valore sarà true in caso di importo disponibile, false in caso contrario.
message Stringa Messaggio di conferma sulla disponibilità dell'imprto.

Risposta di errore

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

Errore 400

La richiesta inviata contiene degli errori. La descrizione dell'errore messaggio cambierà a seconda dell'errore generato

 {
     "error": " {messaggio}"
 }

Errore 403

La richiesta inviata contiene delle credenziali non valide.

 {
     "error": "Authentication Failed"
 }

Errore 404

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

 {
     "error": "Payment account not found"
 }