API

Get Companies

Questo endpoint permette di recuperare l’elenco completo delle aziende associate a uno specifico portale di equity crowdfunding. È utile per ottenere informazioni sulle aziende che partecipano come emittenti di campagne o come portali stessi, insieme al loro stato attuale (attiva, sospesa, ecc.).

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/companies

Parametri della richiesta:

portalId: Identificativo del portale. È obbligatorio e deve essere una stringa che rappresenta il portale di interesse (esempio: "PRTU8AX02564061").

Esempio di risposta

{
  "list": [
    {
      "companyId": "USR035DXCJF1708000010",
      "type": "PORTAL",
      "businessName": "THE EQUITY CROWDFUNDING PORTAL LTD",
      "status": "ACTIVE"
    },
    {
      "companyId": "USR035DXCJF1708000011",
      "type": "LEGAL_PERSON",
      "businessName": "CAMPAIGN ISSUER LTD",
      "status": "ACTIVE"
    }
  ]
}

Parametri della risposta:

companyId: Identificativo univoco dell’azienda.
type: Tipologia dell’azienda. Può essere "LEGAL_PERSON" (azienda emittente di campagne) oppure "PORTAL" (il portale stesso).
businessName: Ragione sociale dell’azienda.
status: Stato dell’azienda. I valori possibili sono:
- "CREATED": L’azienda è stata creata ma non è ancora attiva.
- "ACTIVE": L’azienda è attiva.
- "SUSPENDED": L’azienda è sospesa.
- "BLOCKED": L’azienda è bloccata.
- "CLOSE": L’azienda è chiusa.

Get Company

Questo endpoint permette di recuperare un singolo elemento della lista delle companies.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/companies/{companyId}

Nella response verranno restituti i dettagli della company.

Create Campaign

Lo scopo di questo endpoint è permettere la creazione di una nuova campagna di equity crowdfunding all’interno della piattaforma Fabrick. Utilizzando questo endpoint, il portale può definire una nuova raccolta fondi associata a una specifica azienda, impostando obiettivi minimi e massimi, data di chiusura, descrizione e commissioni di successo. La chiamata è fondamentale per avviare il ciclo operativo di una campagna, consentendo la successiva gestione degli ordini di investimento e dei flussi finanziari.

Esempio di richiesta:

POST /equity-crowdfunding/v4.0/campaigns
{
  "companyId": "USR03VRXZ1726000668",
  "name": "Test Campaign E2E",
  "description": "Campagna di test integrazione",
  "targetAmountMin": 100000,
  "targetAmountMax": 120000,
  "currency": "EUR",
  "expectedClosingDate": "2026-02-28",
  "portalSuccessFee": {
    "fixedAmount": 1200,
    "variableAmountPercentage": 0.15
  }
}

Descrizione dei parametri della richiesta:

companyId identificativo dell’azienda associata alla campagna, rilasciato da Fabrick dopo l’onboarding.
name nome della campagna, utilizzato per identificarla nel portale.
description descrizione testuale della campagna, visibile agli investitori.
targetAmountMin importo minimo da raccogliere per considerare la campagna di successo.
targetAmountMax importo massimo che può essere raccolto nella campagna.
currency valuta della raccolta fondi (ad esempio, “EUR”).
expectedClosingDate data di chiusura prevista della campagna (formato YYYY-MM-DD).
portalSuccessFee oggetto opzionale che definisce le commissioni di successo applicate dal portale; può includere una quota fissa (fixedAmount) e una percentuale variabile (variableAmountPercentage) sul totale raccolto.

Esempio di risposta:

{
  "campaignId": "CMP17031405X2DY182241000067",
  "companyId": "USR03VRXZ1726000668",
  "name": "Test Campaign E2E",
  "description": "Campagna di test integrazione",
  "targetAmountMin": 100000,
  "targetAmountMax": 120000,
  "currency": "EUR",
  "expectedClosingDate": "2026-02-28",
  "portalSuccessFee": {
    "fixedAmount": 1200,
    "variableAmountPercentage": 0.15
  },
  "status": "CREATED",
  "createdDatetime": "2026-01-15T09:30:00.000Z"
}

Descrizione dei parametri della risposta:

campaignId identificativo univoco della campagna appena creata, da utilizzare per tutte le operazioni successive.
companyId identificativo dell’azienda associata alla campagna.
name nome della campagna.
description descrizione della campagna.
targetAmountMin importo minimo da raccogliere.
targetAmountMax importo massimo raccoglibile.
currency valuta della campagna.
expectedClosingDate data di chiusura prevista.
portalSuccessFee oggetto che riporta le commissioni di successo impostate.
status stato corrente della campagna (ad esempio, “CREATED”).
createdDatetime data e ora di creazione della campagna (formato ISO8601).

Search Campaigns

Questo endpoint consente di effettuare una ricerca tra le campagne di equity crowdfunding associate a un portale specifico. È pensato per filtrare e recuperare informazioni sulle campagne in base a diversi criteri come stato, azienda, obiettivi economici e altri parametri rilevanti.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/search

Parametri della richiesta:

portalId: Identificativo del portale. Obbligatorio, stringa che rappresenta il portale di interesse (esempio: "PRTU8AX02564061").
companyId: (opzionale) Filtra per l’ID dell’azienda collegata alla campagna.
name: (opzionale) Filtra per il nome della campagna.
description: (opzionale) Filtra per la descrizione della campagna.
status: (opzionale) Filtra per lo stato della campagna. I valori possibili sono:
- "CREATED": La campagna è stata creata; non può ricevere nuovi ordini.
- "OPEN": La campagna è aperta; si possono creare nuovi ordini.
- "CLOSED": La campagna è chiusa; non può ricevere nuovi ordini.
- "FINALIZED_SUCCESS": La campagna si è conclusa con successo.
- "FINALIZED_FAIL": La campagna è fallita.
- "CANCELLED": La campagna è stata cancellata.
targetAmountMin: (opzionale) Filtra per l’importo minimo obiettivo della campagna.
targetAmountMax: (opzionale) Filtra per l’importo massimo obiettivo della campagna.

Esempio corpo richiesta:

{
  "companyId": "USR03VRXZ1726000668",
  "name": null,
  "description": null,
  "status": "CREATED",
  "targetAmountMin": null,
  "targetAmountMax": null
}

Esempio di risposta

{
  "list": [
    {
      "campaignId": "COL1905176JGV104658000121",
      "status": "CREATED",
      "companyId": "USR03VRXZ1726000668",
      "name": "Name of the new campaign",
      "description": "Description of the new campaign",
      "minTargetAmount": 100000.00,
      "maxTargetAmount": 120000.00,
      "portalSuccessFee": {
        "fixedAmount": 1200.00,
        "variableAmountPercentage": 0.15
      },
      "currency": "EUR",
      "expectedClosingDate": "2019-12-31"
    }
  ]
}

Parametri della risposta:

campaignId: Identificativo univoco della campagna.
status: Stato della campagna. Può essere uno dei valori descritti sopra.
companyId: Identificativo dell’azienda collegata alla campagna.
name: Nome della campagna.
description: Descrizione della campagna.
minTargetAmount: Importo minimo obiettivo della campagna.
maxTargetAmount: Importo massimo obiettivo della campagna.
portalSuccessFee: Oggetto JSON con le informazioni sulla commissione di successo del portale.
portalSuccessFee.fixedAmount: Importo fisso della commissione di successo, valore assoluto che viene sottratto dai fondi raccolti in caso di successo.
portalSuccessFee.variableAmountPercentage: Percentuale variabile della commissione di successo, calcolata sui fondi raccolti (tra 0.00 e 100.00).
currency: Valuta della campagna.
expectedClosingDate: Data di chiusura prevista della campagna.

Get Campaign

Questo endpoint permette di recuperare un singolo elemento della lista delle campaigns..

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}

Nella response verranno restituti i dettagli della campaign.

Update Campaign

Questo endpoint permette di aggiornare i dati di una campagna di equity crowdfunding già esistente, modificando parametri come nome, descrizione, obiettivi economici, commissioni e data di chiusura prevista. È utile per gestire le variazioni che possono intervenire durante la vita di una campagna.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}

Parametri della richiesta:

portalId: Identificativo del portale. Obbligatorio, stringa che rappresenta il portale di interesse (esempio: "PRTU8AX02564061").
campaignId: Identificativo della campagna da aggiornare. Obbligatorio, stringa che rappresenta la campagna (esempio: "COL1905176JGV104658000121").
name: (opzionale) Nuovo nome della campagna.
description: (opzionale) Nuova descrizione della campagna.
minTargetAmount: (opzionale) Nuovo importo minimo obiettivo della campagna.
maxTargetAmount: (opzionale) Nuovo importo massimo obiettivo della campagna.
portalSuccessFee: (opzionale) Oggetto JSON con le nuove informazioni sulla commissione di successo del portale.
portalSuccessFee.fixedAmount: (opzionale) Nuovo importo fisso della commissione di successo, valore assoluto che viene sottratto dai fondi raccolti in caso di successo.
portalSuccessFee.variableAmountPercentage: (opzionale) Nuova percentuale variabile della commissione di successo, calcolata sui fondi raccolti (tra 0.00 e 100.00).
expectedClosingDate: (opzionale) Nuova data di chiusura prevista della campagna.

Esempio corpo richiesta:

{
  "name": "The new campaign name",
  "description": "The new campaign description",
  "minTargetAmount": 100000.00,
  "maxTargetAmount": 500000.00,
  "portalSuccessFee": {
    "fixedAmount": 1200,
    "variableAmountPercentage": 2.12
  },
  "expectedClosingDate": "2019-12-31"
}

Esempio di risposta

{
  "campaignId": "COL1905176JGV104658000121",
  "name": "The new campaign name",
  "description": "The new campaign description",
  "minTargetAmount": 100000.00,
  "maxTargetAmount": 500000.00,
  "portalSuccessFee": {
    "fixedAmount": 1200,
    "variableAmountPercentage": 2.12
  },
  "expectedClosingDate": "2019-12-31"
}

Parametri della risposta:

campaignId: Identificativo univoco della campagna aggiornata.
name: Nome aggiornato della campagna.
description: Descrizione aggiornata della campagna.
minTargetAmount: Importo minimo obiettivo aggiornato.
maxTargetAmount: Importo massimo obiettivo aggiornato.
portalSuccessFee: Oggetto JSON con le informazioni aggiornate sulla commissione di successo del portale.
portalSuccessFee.fixedAmount: Importo fisso aggiornato della commissione di successo.
portalSuccessFee.variableAmountPercentage: Percentuale variabile aggiornata della commissione di successo.
expectedClosingDate: Data di chiusura prevista aggiornata della campagna.

Get Campaign Available Amount

Questo endpoint consente di recuperare l’importo raccolto da una campagna di equity crowdfunding. La sua funzionalità principale è fornire, in tempo reale, il dettaglio degli importi già contabilizzati e quelli ancora in attesa, permettendo così di monitorare lo stato finanziario della campagna. È particolarmente utile per dashboard, reportistica e sistemi di controllo delle campagne.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/available-amount

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna di crowdfunding. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "campaignId": "COL17031405X2DY182241000067",
  "accountedAmount": 6000.00,
  "waitingAmount": 1000.00,
  "totalAmount": 7000.00,
  "currency": "EUR"
}

campaignId: L’ID della campagna per cui sono stati recuperati i dati.
accountedAmount: L’importo effettivamente contabilizzato per la campagna.
waitingAmount: L’importo ancora in attesa di contabilizzazione, corrispondente alla somma degli ordini in stato WAITING.
totalAmount: L’importo totale della campagna, dato dalla somma di accountedAmount e waitingAmount.
currency: La valuta della campagna (attualmente solo EUR).

Get Campaign Investors

Questo endpoint permette di recuperare la lista degli investitori che hanno effettuato ordini in una specifica campagna di equity crowdfunding. La sua funzionalità principale è fornire i dettagli identificativi e di contatto degli investitori, sia persone fisiche che giuridiche, associati alla campagna selezionata. È utile per analisi, reportistica e gestione delle relazioni con gli investitori.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/investors

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna di crowdfunding. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "list": [
    {
      "investorId": "INV2017112909534782VI",
      "name": "Mario",
      "surname": "Rossi",
      "businessName": null,
      "fiscalCode": "RSSMRA81L04A859O",
      "type": "NATURAL_PERSON",
      "address": "via dei Fori Imperiali, 34",
      "postalCode": "00100",
      "city": "Roma",
      "country": "Italia",
      "email": "mario.rossi@email.it",
      "phone": "+393471234567"
    }
  ]
}

investorId: L’ID univoco dell’investitore.
name: Il nome dell’investitore (se persona fisica).
surname: Il cognome dell’investitore (se persona fisica).
businessName: La ragione sociale dell’investitore (se persona giuridica).
fiscalCode: Il codice fiscale dell’investitore.
type: La tipologia dell’investitore, può essere NATURAL_PERSON (persona fisica) o LEGAL_PERSON (persona giuridica).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Get Campaign Orders

Questo endpoint consente di recuperare la lista degli ordini associati a una specifica campagna di equity crowdfunding. La sua funzionalità principale è fornire tutti i dettagli relativi agli ordini effettuati dagli investitori, inclusi lo stato dell’ordine, gli importi, i dati dell’investitore e le informazioni di pagamento. È utile per monitorare il flusso degli investimenti, gestire la reportistica e verificare lo stato delle transazioni.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/orders

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna di crowdfunding. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "list": [
    {
      "orderId": "TRX2017112910135441O5",
      "investorId": "INV4387623841827364",
      "companyId": "USR035DXCJF1708000011",
      "campaignId": "COL17031405X2DY182241000067",
      "status": "CREATED",
      "investorAccount": {
        "iban": "IT08I0129518672180944821099",
        "holderName": "Mario",
        "holderSurname": "Rossi",
        "holderBusinessName": ""
      },
      "totalAmount": 1100,
      "orderAmount": 1000,
      "feeAmount": 100,
      "currency": "EUR",
      "channel": "MONEY_TRANSFER",
      "description": "Order KZ78/23/2017-CAMP56/2017",
      "portalOrderCode": "KZ78/23/2017",
      "portalOrderDatetime": "2019-06-12T12:45:12.234Z",
      "portalInvestorCode": "RSSMRA81L04A859O",
      "portalCompanyCode": "KZ78",
      "portalCampaignCode": "CAMP56/2017"
    }
  ]
}

orderId: L’ID dell’ordine.
investorId: L’ID dell’investitore che ha effettuato l’ordine.
companyId: L’ID della società che raccoglie i fondi.
campaignId: L’ID della campagna di crowdfunding.
status: Lo stato dell’ordine (CREATED, WAITING, ACCEPTED, SPLITTED, CANCELLED, INCORRECT_AMOUNT, FAILED, EXPIRED).
investorAccount: Oggetto JSON con le informazioni sull’account dell’investitore.
investorAccount.iban: Il codice IBAN dell’account dell’investitore.
investorAccount.holderName: Il nome del titolare dell’account (se persona fisica).
investorAccount.holderSurname: Il cognome del titolare dell’account (se persona fisica).
investorAccount.holderBusinessName: La ragione sociale del titolare dell’account (se società).
totalAmount: L’importo totale dell’ordine.
orderAmount: L’importo dell’ordine destinato alla campagna.
feeAmount: L’importo delle commissioni applicate dal portale.
currency: La valuta dell’ordine (EUR).
channel: Il canale di pagamento previsto (CARD, MONEY_TRANSFER).
description: La descrizione dell’ordine.
portalOrderCode: Codice specifico dell’ordine per il portale.
portalOrderDatetime: Timestamp della conferma dell’ordine da parte dell’investitore.
portalInvestorCode: Codice specifico dell’investitore per il portale.
portalCompanyCode: Codice specifico della società per il portale.
portalCampaignCode: Codice specifico della campagna per il portale.

Get Campaign Cashout

Questo endpoint consente di recuperare i dettagli di un cashout (prelievo) associato a una campagna di equity crowdfunding. La sua funzionalità principale è fornire tutte le informazioni relative al cashout, come stato, importo, date e identificativi, utili per la gestione finanziaria e la reportistica delle campagne.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/cashouts/{cashoutId}

portalId: L’ID del portale su cui è attivo il cashout. Esempio: PRTU8AX02564061
cashoutId: L’ID del cashout da recuperare. Esempio: CO190711094928NOQX000226

Esempio di risposta

{
  "cashoutId": "CO190711094928NOQX000226",
  "companyId": "USR03ZQMZ1820000321",
  "campaignId": "COL180410B64J104755000041",
  "status": "EXECUTED",
  "cro": "",
  "amount": 15000,
  "currency": "EUR",
  "createdDate": "2019-05-01",
  "scheduledDate": "2019-05-05",
  "executedDate": "2019-05-05"
}

cashoutId: L’ID del cashout.
companyId: L’ID della società destinataria del cashout.
campaignId: L’ID della campagna associata al cashout.
status: Lo stato del cashout (CREATED, SCHEDULED, EXECUTED, FAILED, REFUSED_BY_RECEIVER).
cro: Il CRO del cashout.
amount: L’importo del cashout.
currency: La valuta del cashout (EUR).
createdDate: La data di creazione del cashout.
scheduledDate: La data programmata per l’esecuzione del cashout.
executedDate: La data di esecuzione del cashout.

Open Campaign

Questo endpoint consente di impostare lo stato di una campagna come "aperta", permettendo la ricezione di nuovi ordini. La sua funzionalità principale è gestire il ciclo di vita della campagna, aggiornando lo stato e registrando la data di apertura. È utile per l’attivazione operativa delle campagne di crowdfunding.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/opened

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna da aprire. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "campaignId": "COL1905176JGV104658000121",
  "status": "OPEN",
  "openedDatetime": "2019-06-26T14:23:14.457Z"
}

campaignId: L’ID della campagna.
status: Lo stato della campagna (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
openedDatetime: La data e ora in cui la campagna è stata aperta.

Close Campaign

Questo endpoint consente di impostare lo stato di una campagna come "chiusa", impedendo la ricezione di nuovi ordini. La sua funzionalità principale è gestire il ciclo di vita della campagna, registrando la data di chiusura e aggiornando lo stato. È utile per la gestione operativa e amministrativa delle campagne di crowdfunding.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/closed

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna da chiudere. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "campaignId": "COL1905176JGV104658000121",
  "status": "CLOSED",
  "closedDatetime": "2019-07-19T14:23:14.457Z"
}

campaignId: L’ID della campagna.
status: Lo stato della campagna (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
closedDatetime: La data e ora in cui la campagna è stata chiusa.

Cancel Campaign

Questo endpoint consente di impostare lo stato di una campagna come "cancellata". La campagna deve essere in stato "CREATED" per poter essere cancellata. La sua funzionalità principale è gestire la cancellazione delle campagne non ancora avviate, registrando la data di cancellazione e aggiornando lo stato. È utile per la gestione amministrativa e per annullare campagne prima dell’apertura.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/cancelled

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna da cancellare. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "campaignId": "COL1905176JGV104658000121",
  "status": "CANCELLED",
  "cancelledDatetime": "2019-07-18T14:23:14.457Z"
}

campaignId: L’ID della campagna.
status: Lo stato della campagna (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
cancelledDatetime: La data e ora in cui la campagna è stata cancellata.

Campaign Failure

Questo endpoint consente di impostare lo stato di una campagna come "fallita" e di rimborsare automaticamente tutti gli ordini agli investitori. La sua funzionalità principale è gestire la chiusura negativa delle campagne, restituendo i fondi agli investitori e registrando le operazioni di rimborso.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/failure

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna da impostare come fallita. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "campaignId": "COL1905176JGV104658000121",
  "status": "FINALIZED_FAIL",
  "ordersUndone": [
    {
      "orderId": "ORD2309823841827364",
      "refundId": "MB0650617080849NMG214000761"
    },
    {
      "orderId": "ORD2309823841827365",
      "refundId": "MB0650617080849NMG214000762"
    }
  ]
}

campaignId: L’ID della campagna.
status: Lo stato della campagna (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
ordersUndone: Array JSON con le informazioni sugli ordini rimborsati agli investitori.
ordersUndone[i].orderId: L’ID dell’ordine rimborsato.
ordersUndone[i].refundId: L’ID dell’operazione di rimborso.

Campaign Success

Questo endpoint consente di impostare lo stato di una campagna come "finalizzata con successo" ed eseguire il cashout dei fondi raccolti e delle eventuali commissioni del portale. La sua funzionalità principale è gestire la chiusura positiva delle campagne, eseguendo le operazioni finanziarie e registrando i dettagli degli ordini e degli importi gestiti.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/success

portalId: L’ID del portale su cui è attiva la campagna. Esempio: PRTU8AX02564061
campaignId: L’ID della campagna da impostare come finalizzata con successo. Esempio: COL1905176JGV104658000121

Esempio di risposta

{
  "campaignId": "COL1905176JGV104658000121",
  "status": "FINALIZED_SUCCESS",
  "ordersExecuted": [
    "TRX4387623841827947",
    "TRX4387623841827124",
    "TRX4387623841809974"
  ],
  "ordersUndone": [
    "TRX2309823841827364"
  ],
  "orderSplit": "TRX2309823842182736",
  "amounts": {
    "companyFunds": 300000,
    "portalSuccessFee": 15000,
    "portalInvestorFee": 20000,
    "investorsRefunds": 50000,
    "totalCampaignExecuted": 315000,
    "totalManagedFunds": 385000
  }
}

campaignId: L’ID della campagna.
status: Lo stato della campagna (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
ordersExecuted: Array JSON con gli ID degli ordini eseguiti.
ordersUndone: Array JSON con gli ID degli ordini rimborsati agli investitori.
orderSplit: L’ID dell’ordine suddiviso.
amounts: Oggetto JSON con i dettagli degli importi gestiti.
amounts.companyFunds: Fondi trasferiti alla società.
amounts.portalSuccessFee: Commissione di successo trasferita al portale.
amounts.portalInvestorFee: Commissione investitore trasferita al portale.
amounts.investorsRefunds: Totale dei rimborsi agli investitori.
amounts.totalCampaignExecuted: Totale dei fondi raccolti (companyFunds + portalSuccessFee).
amounts.totalManagedFunds: Totale dei fondi gestiti (companyFunds + portalSuccessFee + portalInvestorFee + investorsRefunds).

Create Investor

Questo endpoint consente di creare un nuovo investitore, sia persona fisica che giuridica, registrandone tutti i dati identificativi e di contatto. La sua funzionalità principale è permettere la registrazione di nuovi investitori per la partecipazione alle campagne di crowdfunding.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/investors

portalId: L’ID del portale su cui registrare l’investitore. Esempio: PRTU8AX02564061
name: Il nome dell’investitore (obbligatorio se NATURAL_PERSON).
surname: Il cognome dell’investitore (obbligatorio se NATURAL_PERSON).
businessName: La ragione sociale dell’investitore (obbligatorio se LEGAL_PERSON).
fiscalCode: Il codice fiscale dell’investitore (Codice Fiscale per persona fisica, Partita IVA per persona giuridica).
type: La tipologia dell’investitore (NATURAL_PERSON o LEGAL_PERSON).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Esempio di risposta

{
  "investorId": "INV2017112909534782VI",
  "name": "Mario",
  "surname": "Rossi",
  "businessName": "",
  "fiscalCode": "RSSMRA81L04A859O",
  "type": "NATURAL_PERSON",
  "address": "via dei Fori Imperiali, 34",
  "postalCode": "00100",
  "city": "Roma",
  "country": "Italia",
  "email": "mario.rossi@email.it",
  "phone": "+393471234567"
}

investorId: L’ID dell’investitore.
name: Il nome dell’investitore (se persona fisica).
surname: Il cognome dell’investitore (se persona fisica).
businessName: La ragione sociale dell’investitore (se persona giuridica).
fiscalCode: Il codice fiscale dell’investitore.
type: La tipologia dell’investitore, può essere NATURAL_PERSON (persona fisica) o LEGAL_PERSON (persona giuridica).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Search Investors

Questo endpoint consente di cercare investitori registrati su un portale, filtrando per nome, cognome, ragione sociale, codice fiscale o tipologia. La sua funzionalità principale è facilitare la ricerca e la selezione di investitori per analisi, gestione o invio di comunicazioni.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/investors/search

portalId: L’ID del portale su cui cercare gli investitori. Esempio: PRTU8AX02564061
name: Filtro per nome dell’investitore.
surname: Filtro per cognome dell’investitore.
businessName: Filtro per ragione sociale dell’investitore.
fiscalCode: Filtro per codice fiscale dell’investitore.
type: Filtro per tipologia dell’investitore (NATURAL_PERSON o LEGAL_PERSON).

Esempio di risposta

{
  "list": [
    {
      "investorId": "INV2017112909534782VI",
      "name": "Mario",
      "surname": "Rossi",
      "businessName": "",
      "fiscalCode": "RSSMRA81L04A859O",
      "type": "NATURAL_PERSON",
      "address": "via dei Fori Imperiali, 34",
      "postalCode": "00100",
      "city": "Roma",
      "country": "Italia",
      "email": "mario.rossi@email.it",
      "phone": "+393471234567"
    }
  ]
}

investorId: L’ID dell’investitore.
name: Il nome dell’investitore (se persona fisica).
surname: Il cognome dell’investitore (se persona fisica).
businessName: La ragione sociale dell’investitore (se persona giuridica).
fiscalCode: Il codice fiscale dell’investitore.
type: La tipologia dell’investitore, può essere NATURAL_PERSON (persona fisica) o LEGAL_PERSON (persona giuridica).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Get Investor

Questo endpoint consente di recuperare i dettagli di un investitore esistente. La sua funzionalità principale è fornire tutte le informazioni identificative e di contatto dell’investitore, sia persona fisica che giuridica, utili per la gestione e la reportistica.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/investors/{investorId}

portalId: L’ID del portale su cui è registrato l’investitore. Esempio: PRTU8AX02564061
investorId: L’ID dell’investitore da recuperare. Esempio: INV2017112909534782VI

Esempio di risposta

{
  "investorId": "INV2017112909534782VI",
  "name": "Mario",
  "surname": "Rossi",
  "businessName": "",
  "fiscalCode": "RSSMRA81L04A859O",
  "type": "NATURAL_PERSON",
  "address": "via dei Fori Imperiali, 34",
  "postalCode": "00100",
  "city": "Roma",
  "country": "Italia",
  "email": "mario.rossi@email.it",
  "phone": "+393471234567"
}

investorId: L’ID dell’investitore.
name: Il nome dell’investitore (se persona fisica).
surname: Il cognome dell’investitore (se persona fisica).
businessName: La ragione sociale dell’investitore (se persona giuridica).
fiscalCode: Il codice fiscale dell’investitore.
type: La tipologia dell’investitore, può essere NATURAL_PERSON (persona fisica) o LEGAL_PERSON (persona giuridica).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Update Investor

Questo endpoint consente di aggiornare i dati di un investitore esistente, sia persona fisica che giuridica. La sua funzionalità principale è permettere la modifica delle informazioni identificative e di contatto dell’investitore per mantenerle sempre aggiornate.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/investors/{investorId}

portalId: L’ID del portale su cui è registrato l’investitore. Esempio: PRTU8AX02564061
investorId: L’ID dell’investitore da aggiornare. Esempio: INV2017112909534782VI
name: Il nome dell’investitore (obbligatorio se NATURAL_PERSON).
surname: Il cognome dell’investitore (obbligatorio se NATURAL_PERSON).
businessName: La ragione sociale dell’investitore (obbligatorio se LEGAL_PERSON).
fiscalCode: Il codice fiscale dell’investitore (Codice Fiscale per persona fisica, Partita IVA per persona giuridica).
type: La tipologia dell’investitore (NATURAL_PERSON o LEGAL_PERSON).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Esempio di risposta

{
  "investorId": "INV2017112909534782VI",
  "name": "Mario",
  "surname": "Rossi",
  "businessName": "",
  "fiscalCode": "RSSMRA81L04A859O",
  "type": "NATURAL_PERSON",
  "address": "via dei Fori Imperiali, 34",
  "postalCode": "00100",
  "city": "Roma",
  "country": "Italia",
  "email": "mario.rossi@email.it",
  "phone": "+393471234567"
}

investorId: L’ID dell’investitore.
name: Il nome dell’investitore (se persona fisica).
surname: Il cognome dell’investitore (se persona fisica).
businessName: La ragione sociale dell’investitore (se persona giuridica).
fiscalCode: Il codice fiscale dell’investitore.
type: La tipologia dell’investitore, può essere NATURAL_PERSON (persona fisica) o LEGAL_PERSON (persona giuridica).
address: L’indirizzo (via e numero civico) dell’investitore.
postalCode: Il CAP dell’indirizzo dell’investitore.
city: La città dell’investitore.
country: Il paese dell’investitore.
email: L’indirizzo email dell’investitore.
phone: Il numero di telefono dell’investitore.

Create Order

Questo endpoint consente di creare un nuovo ordine di investimento su una campagna di equity crowdfunding. Permette di specificare tutti i dettagli dell’ordine, dell’investitore e della campagna, inclusi importi, canale di pagamento e dati identificativi.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders

portalId: L’ID del portale. Esempio: PRTU8AX02564061
investorId: L’ID dell’investitore.
companyId: L’ID della società che raccoglie i fondi.
campaignId: L’ID della campagna.
investorAccount: Oggetto JSON con le informazioni sull’account dell’investitore.
investorAccount.iban: IBAN dell’account.
investorAccount.holderName: Nome del titolare (se persona fisica).
investorAccount.holderSurname: Cognome del titolare (se persona fisica).
investorAccount.holderBusinessName: Ragione sociale del titolare (se società).
totalAmount: Importo totale dell’ordine.
orderAmount: Importo destinato alla campagna.
feeAmount: Importo delle commissioni del portale.
currency: Valuta dell’ordine (EUR).
channel: Canale di pagamento (CARD, MONEY_TRANSFER).
description: Descrizione dell’ordine (max 50 caratteri).
portalOrderCode: Codice specifico dell’ordine per il portale.
portalOrderDatetime: Timestamp della conferma dell’ordine.
portalInvestorCode: Codice specifico dell’investitore per il portale.
portalCompanyCode: Codice specifico della società per il portale.
portalCampaignCode: Codice specifico della campagna per il portale.

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "investorId": "INV4387623841827364",
  "companyId": "USR035DXCJF1708000011",
  "campaignId": "COL17031405X2DY182241000067",
  "status": "CREATED",
  "investorAccount": {
    "iban": "IT08I0129518672180944821099",
    "holderName": "Mario",
    "holderSurname": "Rossi",
    "holderBusinessName": ""
  },
  "totalAmount": 1100,
  "orderAmount": 1000,
  "feeAmount": 100,
  "currency": "EUR",
  "channel": "MONEY_TRANSFER",
  "description": "Order KZ78/23/2017-CAMP56/2017",
  "portalOrderCode": "KZ78/23/2017",
  "portalOrderDatetime": "2019-06-12T12:45:12.234Z",
  "portalInvestorCode": "RSSMRA81L04A859O",
  "portalCompanyCode": "KZ78",
  "portalCampaignCode": "CAMP56/2017"
}

orderId: L’ID dell’ordine.
investorId: L’ID dell’investitore.
companyId: L’ID della società.
campaignId: L’ID della campagna.
status: Stato dell’ordine (CREATED, WAITING, ACCEPTED, SPLITTED, CANCELLED, INCORRECT_AMOUNT, FAILED, EXPIRED).
investorAccount: Oggetto JSON con le informazioni sull’account dell’investitore.
investorAccount.iban: IBAN dell’account.
investorAccount.holderName: Nome del titolare (se persona fisica).
investorAccount.holderSurname: Cognome del titolare (se persona fisica).
investorAccount.holderBusinessName: Ragione sociale del titolare (se società).
totalAmount: Importo totale dell’ordine.
orderAmount: Importo destinato alla campagna.
feeAmount: Importo delle commissioni del portale.
currency: Valuta dell’ordine (EUR).
channel: Canale di pagamento.
description: Descrizione dell’ordine.
portalOrderCode: Codice specifico dell’ordine per il portale.
portalOrderDatetime: Timestamp della conferma dell’ordine.
portalInvestorCode: Codice specifico dell’investitore per il portale.
portalCompanyCode: Codice specifico della società per il portale.
portalCampaignCode: Codice specifico della campagna per il portale.

Search Orders

Questo endpoint consente di cercare ordini registrati su un portale, filtrando per vari parametri come investitore, società, campagna, stato, importi, canale e codici specifici.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/search

portalId: L’ID del portale. Esempio: PRTU8AX02564061
investorId: Filtro per l’ID dell’investitore.
companyId: Filtro per l’ID della società.
campaignId: Filtro per l’ID della campagna.
status: Filtro per lo stato dell’ordine.
investorAccount: Oggetto JSON per filtrare l’account dell’investitore.
investorAccount.iban: Filtro per IBAN.
investorAccount.holderName: Filtro per nome titolare.
investorAccount.holderSurname: Filtro per cognome titolare.
investorAccount.holderBusinessName: Filtro per ragione sociale titolare.
totalAmount: Filtro per importo totale.
orderAmount: Filtro per importo destinato alla campagna.
feeAmount: Filtro per importo commissioni.
currency: Filtro per valuta (EUR).
channel: Filtro per canale di pagamento (CARD, MONEY_TRANSFER).
description: Filtro per descrizione.
portalOrderCode: Filtro per codice ordine portale.
portalOrderDatetime: Filtro per timestamp conferma ordine.
portalInvestorCode: Filtro per codice investitore portale.
portalCompanyCode: Filtro per codice società portale.
portalCampaignCode: Filtro per codice campagna portale.

Esempio di risposta

{
  "list": [
    {
      "orderId": "TRX2017112910135441O5",
      "investorId": "INV4387623841827364",
      "companyId": "USR035DXCJF1708000011",
      "campaignId": "COL17031405X2DY182241000067",
      "status": "CREATED",
      "investorAccount": {
        "iban": "IT08I0129518672180944821099",
        "holderName": "Mario",
        "holderSurname": "Rossi",
        "holderBusinessName": ""
      },
      "totalAmount": 1100,
      "orderAmount": 1000,
      "feeAmount": 100,
      "currency": "EUR",
      "channel": "MONEY_TRANSFER",
      "description": "Order KZ78/23/2017-CAMP56/2017",
      "portalOrderCode": "KZ78/23/2017",
      "portalOrderDatetime": "2019-06-12T12:45:12.234Z",
      "portalInvestorCode": "RSSMRA81L04A859O",
      "portalCompanyCode": "KZ78",
      "portalCampaignCode": "CAMP56/2017"
    }
  ]
}

orderId: L’ID dell’ordine.
investorId: L’ID dell’investitore.
companyId: L’ID della società.
campaignId: L’ID della campagna.
status: Stato dell’ordine.
investorAccount: Oggetto JSON con le informazioni sull’account dell’investitore.
investorAccount.iban: IBAN dell’account.
investorAccount.holderName: Nome del titolare.
investorAccount.holderSurname: Cognome del titolare.
investorAccount.holderBusinessName: Ragione sociale del titolare.
totalAmount: Importo totale dell’ordine.
orderAmount: Importo destinato alla campagna.
feeAmount: Importo delle commissioni.
currency: Valuta dell’ordine.
channel: Canale di pagamento.
description: Descrizione dell’ordine.
portalOrderCode: Codice ordine portale.
portalOrderDatetime: Timestamp conferma ordine.
portalInvestorCode: Codice investitore portale.
portalCompanyCode: Codice società portale.
portalCampaignCode: Codice campagna portale.

Order

Questo endpoint consente di recuperare i dettagli di un ordine esistente, inclusi tutti i dati relativi all’investitore, alla campagna, agli importi e allo stato.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: L’ID dell’ordine. Esempio: TRX2017112910135441O5

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "investorId": "INV4387623841827364",
  "companyId": "USR035DXCJF1708000011",
  "campaignId": "COL17031405X2DY182241000067",
  "status": "CREATED",
  "investorAccount": {
    "iban": "IT08I0129518672180944821099",
    "holderName": "Mario",
    "holderSurname": "Rossi",
    "holderBusinessName": ""
  },
  "totalAmount": 1100,
  "orderAmount": 1000,
  "feeAmount": 100,
  "currency": "EUR",
  "channel": "MONEY_TRANSFER",
  "description": "Order KZ78/23/2017-CAMP56/2017",
  "portalOrderCode": "KZ78/23/2017",
  "portalOrderDatetime": "2019-06-12T12:45:12.234Z",
  "portalInvestorCode": "RSSMRA81L04A859O",
  "portalCompanyCode": "KZ78",
  "portalCampaignCode": "CAMP56/2017"
}

orderId: L’ID dell’ordine.
investorId: L’ID dell’investitore.
companyId: L’ID della società.
campaignId: L’ID della campagna.
status: Stato dell’ordine.
investorAccount: Oggetto JSON con le informazioni sull’account dell’investitore.
investorAccount.iban: IBAN dell’account.
investorAccount.holderName: Nome del titolare.
investorAccount.holderSurname: Cognome del titolare.
investorAccount.holderBusinessName: Ragione sociale del titolare.
totalAmount: Importo totale dell’ordine.
orderAmount: Importo destinato alla campagna.
feeAmount: Importo delle commissioni.
currency: Valuta dell’ordine.
channel: Canale di pagamento.
description: Descrizione dell’ordine.
portalOrderCode: Codice ordine portale.
portalOrderDatetime: Timestamp conferma ordine.
portalInvestorCode: Codice investitore portale.
portalCompanyCode: Codice società portale.
portalCampaignCode: Codice campagna portale.

Update Order Campaign

Questo endpoint consente di aggiornare la campagna associata a un ordine esistente, spostando l’ordine da una campagna all’altra (la nuova campagna deve essere in stato OPEN).

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: L’ID dell’ordine. Esempio: TRX2017112910135441O5
fromCampaign: L’ID della campagna attuale dell’ordine.
toCampaign: L’ID della nuova campagna (deve essere OPEN).

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "campaignId": "COL2005385ULR253158475398"
}

orderId: L’ID dell’ordine.
campaignId: L’ID della campagna associata all’ordine.

Cancel Order

Questo endpoint consente di impostare lo stato di un ordine come "cancellato". Se l’ordine è in stato ACCEPTED, viene anche rimborsato all’investitore; altrimenti, nessun flusso di denaro viene accettato.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/cancelled

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: L’ID dell’ordine. Esempio: TRX2017112910135441O5

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "status": "CANCELLED"
}

orderId: L’ID dell’ordine.
status: Stato dell’ordine.

Set Order in Waiting

Questo endpoint consente di impostare lo stato di un ordine come "waiting". Un ordine deve essere marcato come waiting quando l’investitore ha accettato di inviare il denaro.

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/waiting

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: L’ID dell’ordine. Esempio: TRX2017112910135441O5

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "status": "WAITING"
}

orderId: L’ID dell’ordine.
status: Stato dell’ordine.

Set Order in failed status

Questo endpoint consente di impostare lo stato di un ordine come "failed". Un ordine deve essere marcato come failed quando si verifica un errore nella transazione (ad esempio, carta non autorizzata o fondi insufficienti).

Esempio di richiesta

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/failed

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: L’ID dell’ordine. Esempio: TRX2017112910135441O5

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "status": "FAILED"
}

orderId: L’ID dell’ordine.
status: Stato dell’ordine.

Get Order Payment

Questo endpoint consente di recuperare i dettagli del pagamento associato a un ordine, inclusi stato, canale, importi, date e riferimenti a moneyin, moneyout, cashout e refund.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/payment

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: L’ID dell’ordine. Esempio: TRX2017112910135441O5

Esempio di risposta

{
  "orderId": "TRX2017112910135441O5",
  "companyId": "USR03VRXZ1726000668",
  "campaignId": "COL1905176JGV104658000121",
  "orderStatus": "ACCOUNTED",
  "paymentStatus": "ACCOUNTED",
  "channel": "MONEY_TRANSFER",
  "moneyinId": "MI171210380014810840908WM5M",
  "moneyoutIds": ["MO08972174242234BKA04000001", "MO08972174242234BKA04000002"],
  "cashoutIds": [],
  "refundIds": [],
  "createdDatetime": "2019-01-23T12:12:11Z",
  "waitingDatetime": "2019-01-23T12:13:54Z",
  "receivedDatetime": "2019-01-25T16:11:13Z",
  "accountedToCampaignDatetime": "2019-01-25T16:11:23Z",
  "expiredDatetime": "",
  "failedDatetime": ""
}

orderId: L’ID dell’ordine.
companyId: L’ID della società.
campaignId: L’ID della campagna.
orderStatus: Stato dell’ordine.
paymentStatus: Stato del pagamento.
channel: Canale del pagamento.
*moneyin

Order Payment Moneyin

Questo endpoint consente di recuperare i dettagli di un pagamento in entrata (moneyin) associato a un ordine di crowdfunding. La sua funzionalità principale è fornire tutte le informazioni relative al trasferimento di denaro ricevuto, inclusi stato, importo, canale, codici di riconciliazione e dati del pagatore.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/moneyins/{moneyinId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
moneyinId: L’ID del moneyin da recuperare.

Esempio di risposta

{
  "moneyinId": "MI171210380014810840908WM5M",
  "cro": "",
  "rrn": "",
  "status": "ACCEPTED",
  "amount": 105,
  "currency": "EUR",
  "channel": "CARD",
  "datetime": "2017-03-14T17:54:59.000Z",
  "payerIban": "IT23A0336844430150000004660",
  "payerName": "JOHN DOE"
}

moneyinId: L’ID del pagamento in entrata.
cro: Codice CRO (per moneyin tramite MONEY_TRANSFER).
rrn: Codice RRN (per moneyin tramite CARD).
status: Stato del moneyin (WAITING, REQUESTED_TO_PAYER, ACCEPTED, REJECTED, EXPIRED).
amount: Importo del pagamento in entrata.
currency: Valuta del pagamento.
channel: Canale del pagamento (CARD, MONEY_TRANSFER).
datetime: Data e ora di esecuzione del pagamento.
payerIban: IBAN del pagatore.
payerName: Nome del pagatore.

Order Payment Moneyout

Questo endpoint consente di recuperare i dettagli di un pagamento in uscita (moneyout) associato a un ordine di crowdfunding. La sua funzionalità principale è fornire tutte le informazioni relative al trasferimento di denaro verso la società, inclusi stato, importo, disponibilità per cashout e dati identificativi.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/moneyouts/{moneyoutId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
moneyoutId: L’ID del moneyout da recuperare.

Esempio di risposta

{
  "moneyoutId": "MO181951400555230W9V5001485",
  "companyId": "USR02KZLN1827000201",
  "status": "AVAILABLE",
  "amount": 810.68,
  "cashoutAvailableAmount": 810.68,
  "currency": "EUR",
  "createdDatetime": "2019-05-30T18:51:40.000Z",
  "lastCashoutDatetime": ""
}

moneyoutId: L’ID del pagamento in uscita.
companyId: L’ID della società destinataria.
status: Stato del moneyout (CREATED, AVAILABLE, WORK_IN_PROGRESS, BOOKED_FOR_CASHOUT, DEPLETED, FAILED, EXPIRED).
amount: Importo del pagamento in uscita.
cashoutAvailableAmount: Importo disponibile per cashout.
currency: Valuta del pagamento.
createdDatetime: Data e ora di creazione del moneyout.
lastCashoutDatetime: Data e ora dell’ultimo cashout (se presente).

Order Payment Refund

Questo endpoint consente di recuperare i dettagli di un rimborso di pagamento associato a un ordine di crowdfunding. La sua funzionalità principale è fornire tutte le informazioni relative al rimborso, inclusi stato, importo, valuta e date di creazione ed esecuzione.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/refunds/{refundId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
refundId: L’ID del rimborso da recuperare.

Esempio di risposta

{
  "refundId": "MB0287617555553OEKR12000041",
  "status": "EXECUTED",
  "createdDatetime": "2018-06-28T02:26:28.000Z",
  "executedDatetime": "2018-06-28T06:00:25.000Z",
  "amount": 40,
  "currency": "EUR"
}

refundId: L’ID del rimborso.
status: Stato del rimborso (CREATED, SCHEDULED, WORK_IN_PROGRESS, EXECUTED, FAILED, REFUSED_BY_RECEIVER).
createdDatetime: Data e ora di creazione del rimborso.
executedDatetime: Data e ora di esecuzione del rimborso.
amount: Importo del rimborso.
currency: Valuta del rimborso.

Search Unidentified Transfers

Questo endpoint consente di cercare trasferimenti non identificati registrati su un portale, filtrando per vari parametri come importo, valuta, descrizione, nome pagatore, stato e date.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/unidentified-transfers/search

portalId: L’ID del portale. Esempio: PRTU8AX02564061
amount: Filtro per importo del trasferimento.
currency: Filtro per valuta del trasferimento.
description: Filtro per descrizione del trasferimento.
payerName: Filtro per nome del pagatore.
status: Filtro per stato del trasferimento (RECEIVED, SENT_BACK).
receivedDatetime: Filtro per data di ricezione.
refundedDatetime: Filtro per data di rimborso.

Esempio di risposta

{
  "list": [
    {
      "unidentifiedTransferId": "UTR170309AHMC07172815000001",
      "amount": 120,
      "currency": "EUR",
      "description": "TRXWRONGID",
      "payerName": "John Doe",
      "status": "RECEIVED",
      "type": "UNIDENTIFIED",
      "receivedDatetime": "2019-06-24T09:39:19Z",
      "refundedDatetime": ""
    }
  ]
}

unidentifiedTransferId: L’ID del trasferimento non identificato.
amount: Importo del trasferimento.
currency: Valuta del trasferimento.
description: Descrizione del trasferimento.
payerName: Nome del pagatore.
status: Stato del trasferimento.
type: Tipo di trasferimento.
receivedDatetime: Data e ora di ricezione.
refundedDatetime: Data e ora di rimborso.

Unidentified Transfer (GET)

Questo endpoint consente di recuperare i dettagli di un trasferimento non identificato associato a un portale di crowdfunding. La sua funzionalità principale è fornire tutte le informazioni relative al trasferimento, inclusi stato, importo, tipo, date e dati del pagatore.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/unidentified-transfers/{unidentifiedTransferId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
unidentifiedTransferId: L’ID del trasferimento non identificato. Esempio: UTR170309AHMC07172815000001

Esempio di risposta

{
  "unidentifiedTransferId": "UTR170309AHMC07172815000001",
  "amount": 120,
  "currency": "EUR",
  "description": "TRXWRONGID",
  "payerName": "John Doe",
  "status": "RECEIVED",
  "type": "UNIDENTIFIED",
  "receivedDatetime": "2019-06-24T09:39:19Z",
  "refundedDatetime": ""
}

unidentifiedTransferId: L’ID del trasferimento non identificato.
amount: Importo del trasferimento.
currency: Valuta del trasferimento.
description: Descrizione del trasferimento.
payerName: Nome del pagatore.
status: Stato del trasferimento (RECEIVED, SENT_BACK).
type: Tipo di trasferimento (UNIDENTIFIED, WRONG_AMOUNT, WRONG_CHANNEL).
receivedDatetime: Data e ora di ricezione del trasferimento.
refundedDatetime: Data e ora di rimborso del trasferimento.

Search Disputes (POST)

Questo endpoint consente di cercare contestazioni registrate su un portale, filtrando per vari parametri come ordine, codice RRN, importo, date di creazione e chiusura.

Esempio di richiesta

POST /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/disputes/search

portalId: L’ID del portale. Esempio: PRTU8AX02564061
orderId: Filtro per l’ID dell’ordine.
rrnCode: Filtro per il codice RRN della contestazione.
paymentAmount: Filtro per l’importo dell’ordine.
createdDate: Filtro per la data di creazione della contestazione.
closedDate: Filtro per la data di chiusura della contestazione.

Esempio di risposta

{
  "list": [
    {
      "disputeId": "DSP180123GJ2O000001",
      "orderId": "TRX2018012307283521FG",
      "rrnCode": "",
      "description": "",
      "paymentAmount": 30,
      "status": "CLOSED_WON",
      "createdDate": "2018-01-01",
      "closedDate": "2018-01-30"
    }
  ]
}

disputeId: L’ID della contestazione.
orderId: L’ID dell’ordine associato.
rrnCode: Codice RRN della contestazione.
description: Descrizione dell’ordine.
paymentAmount: Importo dell’ordine.
status: Stato della contestazione.
createdDate: Data di creazione della contestazione.
closedDate: Data di chiusura della contestazione.

Dispute (GET)

Questo endpoint consente di recuperare i dettagli di una contestazione (dispute) associata a un ordine di crowdfunding. La sua funzionalità principale è fornire tutte le informazioni relative alla contestazione, inclusi stato, importo, date e identificativi.

Esempio di richiesta

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/disputes/{disputeId}

portalId: L’ID del portale. Esempio: PRTU8AX02564061
disputeId: L’ID della contestazione da recuperare. Esempio: DSP180123GJ2O000001

Esempio di risposta

{
  "disputeId": "DSP180123GJ2O000001",
  "orderId": "TRX2018012307283521FG",
  "rrnCode": "",
  "description": "",
  "paymentAmount": 30,
  "status": "CLOSED_WON",
  "createdDate": "2018-01-01",
  "closedDate": "2018-01-30"
}

disputeId: L’ID della contestazione.
orderId: L’ID dell’ordine associato.
rrnCode: Codice RRN della contestazione.
description: Descrizione dell’ordine.
paymentAmount: Importo dell’ordine.
status: Stato della contestazione (OPEN, CLOSED_WON, CLOSED_LOST).
createdDate: Data di creazione della contestazione.
closedDate: Data di chiusura della contestazione.

Get Companies​

Get Company​

Create Campaign​

Search Campaigns​

Get Campaign​

Update Campaign​

Get Campaign Available Amount​

Get Campaign Investors​

Get Campaign Orders​

Get Campaign Cashout​

Open Campaign​

Close Campaign​

Cancel Campaign​

Campaign Failure​

Campaign Success​

Create Investor​

Search Investors​

Get Investor​

Update Investor​

Create Order​

Search Orders​

Order​

Update Order Campaign​

Cancel Order​

Set Order in Waiting​

Set Order in failed status​

Get Order Payment​

Order Payment Moneyin​

Order Payment Moneyout​

Order Payment Refund​

Search Unidentified Transfers​

Unidentified Transfer (GET)​

Search Disputes (POST)​

Dispute (GET)​

Get Companies

Get Company

Create Campaign

Search Campaigns

Get Campaign

Update Campaign

Get Campaign Available Amount

Get Campaign Investors

Get Campaign Orders

Get Campaign Cashout

Open Campaign

Close Campaign

Cancel Campaign

Campaign Failure

Campaign Success

Create Investor

Search Investors

Get Investor

Update Investor

Create Order

Search Orders

Order

Update Order Campaign

Cancel Order

Set Order in Waiting

Set Order in failed status

Get Order Payment

Order Payment Moneyin

Order Payment Moneyout

Order Payment Refund

Search Unidentified Transfers

Unidentified Transfer (GET)

Search Disputes (POST)

Dispute (GET)