Passa al contenuto principale

API

Flusso endpoints​

virutalIbanFlowpng

Create Virtual IBAN​

Questo endpoint permette di creare un nuovo Virtual IBAN associato a un conto principale. Consente di generare un identificativo virtuale per incassi, riconciliazioni e categorizzazioni, con eventuale descrizione testuale.

Esempio di richiesta:

POST /api/gbs/banking/v4.0/accounts/{accountId}/virtual-ibans

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto su cui creare il Virtual IBAN
  • description – opzionale; descrizione del Virtual IBAN nel body JSON

Body esempio:

{
  "description": "My new virtual IBAN."
}

Esempio di risposta:

{
  "virtualIban": "IT16L03268223000VR000000042",
  "parentAccountId": "14527670",
  "status": "ACTIVE",
  "activatedDate": "2019-07-04",
  "deactivatedDate": null,
  "description": "My new virtual IBAN."
}

Parametri della risposta:

  • virtualIban – Virtual IBAN creato
  • parentAccountId – ID del conto principale
  • status – stato del Virtual IBAN
  • activatedDate – data di attivazione
  • deactivatedDate – data di disattivazione
  • description – descrizione assegnata

Get Virtual IBANs list​

Questo endpoint restituisce l’elenco dei Virtual IBAN associati a un conto, con possibilità di includere quelli inattivi.

Esempio di richiesta:

GET /api/gbs/banking/v4.0/accounts/{accountId}/virtual-ibans?showInactive=true

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto
  • showInactive – opzionale; se true include anche i Virtual IBAN inattivi

Esempio di risposta:

{
  "list": [
    {
      "virtualIban": "IT16L03268223000VR000000042",
      "parentAccountId": "14527670",
      "status": "ACTIVE",
      "activationDate": "2019-07-04",
      "deactivationDate": null,
      "description": "My new virtual IBAN."
    }
  ]
}

Parametri della risposta:

  • list – elenco dei Virtual IBAN
  • virtualIban – IBAN virtuale
  • parentAccountId – ID del conto principale
  • status – stato del Virtual IBAN
  • activationDate – data di attivazione
  • deactivationDate – data di disattivazione
  • description – descrizione

Get Virtual IBAN​

Questo endpoint recupera le informazioni di un singolo Virtual IBAN identificato dal suo valore.

Esempio di richiesta:

GET /api/gbs/banking/v4.0/accounts/{accountId}/virtual-ibans/{virtualIban}

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto
  • virtualIban – obbligatorio; IBAN virtuale da consultare

Esempio di risposta:

{
  "virtualIban": "IT16L03268223000VR000000042",
  "parentAccountId": "14527670",
  "status": "ACTIVE",
  "activationDate": "2019-07-04",
  "deactivationDate": null,
  "description": "My new virtual IBAN."
}

Parametri della risposta:

  • virtualIban – IBAN virtuale
  • parentAccountId – ID conto principale
  • status – stato del Virtual IBAN
  • activationDate – data di attivazione
  • deactivationDate – data di disattivazione
  • description – descrizione

Deactivate Virtual IBAN​

Questo endpoint permette di disattivare un Virtual IBAN esistente.

Esempio di richiesta:

PUT /api/gbs/banking/v4.0/accounts/{accountId}/virtual-ibans/{virtualIban}/inactive

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto
  • virtualIban – obbligatorio; IBAN virtuale da disattivare

Esempio di risposta:

{
  "result": "OK"
}

Parametri della risposta:

  • result – esito dell’operazione

Create Virtual IBAN Money Transfer​

Questo endpoint esegue un trasferimento di denaro utilizzando un Virtual IBAN come sorgente.

Esempio di richiesta:

POST /api/gbs/banking/v4.0/accounts/{accountId}/virtual-ibans/{virtualIban}/money-transfers

Body esempio:

{
  "amount": 100,
  "currency": "EUR",
  "receiverIban": "IT00A0000000000000000000000",
  "description": "Transfer from virtual IBAN"
}

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto
  • virtualIban – obbligatorio; IBAN virtuale sorgente
  • amount – importo del trasferimento
  • currency – valuta
  • receiverIban – IBAN destinatario
  • description – descrizione del trasferimento

Esempio di risposta:

{
  "transferId": "123456789"
}

Parametri della risposta:

  • transferId – ID della transazione

Get Parent Account​

Restituisce le informazioni del conto principale associato a un Virtual IBAN.

Esempio di richiesta:

GET /api/gbs/banking/v4.0/accounts/{accountId}/parent

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto

Esempio di risposta:

{
  "accountId": "14527670",
  "iban": "IT00A0000000000000000000000",
  "status": "ACTIVE"
}

Parametri della risposta:

  • accountId – ID del conto principale
  • iban – IBAN del conto
  • status – stato del conto

Get Parent Account Transactions​

Restituisce la lista delle transazioni del conto principale.

Esempio di richiesta:

GET /api/gbs/banking/v4.0/accounts/{accountId}/parent/transactions

Parametri della richiesta:

  • accountId – obbligatorio; ID del conto

Esempio di risposta:

{
  "transactions": [
    {
      "transactionId": "987654321",
      "amount": 150,
      "currency": "EUR",
      "date": "2024-02-01",
      "description": "Payment received"
    }
  ]
}

Parametri della risposta:

  • transactions – elenco delle transazioni
  • transactionId – identificativo della transazione
  • amount – importo
  • currency – valuta
  • date – data della transazione
  • description – descrizione