Visualizza dati conto

Utilizza questo endpoint per visualizzare i dati del conto di pagamento.

Richiesta

Endpoint

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

Metodi accettati

GET

Autenticazione

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

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}' -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
403 Impossibile autenticare la richiesta
404 Risorsa non trovata
500 Errore di sistema

Risposta valida

{
  "paymentAccountId": <stringa>,
  "userId": <stringa>,
  "ledgerEntries": [
    {
      "amount": <stringa>,
      "date": <stringa>,
      "ledgerEntryPublicId": <stringa>,
      "causal": {
        "id": <intero>,
        "description": <stringa>
      },
      "details": <stringa>,
      "sign": <intero>,
      "counterpart": <stringa>
    },
    ...
  ],
  "balance": <intero>,
  "pagination": {
      "limit": <intero>,
      "offset": <intero>,
      "total": <intero>
    }
  }

Risposta di errore

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

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": "Authentication Failed"
 }

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}
 }