Skip to main content

API

Get Companies

This endpoint allows you to retrieve the complete list of companies associated with a specific equity crowdfunding portal. It is useful for obtaining information on companies participating as campaign issuers or portals themselves, along with their current status (active, suspended, etc.).

Example request:

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

Request parameters:

  • portalId: Portal identifier. Required, must be a string representing the portal of interest (example: "PRTU8AX02564061").

Example response:

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

Response parameters:

  • companyId: Unique identifier of the company.
  • type: Type of company. Can be "LEGAL_PERSON" (company issuing campaigns) or "PORTAL" (the portal itself).
  • businessName: Company name.
  • status: Status of the company. Possible values are:
    • "CREATED": The company has been created but is not yet active.
    • "ACTIVE": The company is active.
    • "SUSPENDED": The company is suspended.
    • "BLOCKED": The company is blocked.
    • "CLOSE": The company is closed.

Get Company

This endpoint allows you to retrieve a single item from the list of companies.

Example request:

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

The response will return the details of the company.


Create Campaign

The purpose of this endpoint is to enable the creation of a new equity crowdfunding campaign within the Fabrick platform. Using this endpoint, the portal can define a new fundraising campaign associated with a specific company, setting minimum and maximum targets, closing date, description, and success fees. The call is essential to start the operational cycle of a campaign, enabling the subsequent management of investment orders and financial flows.

Example request:

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

Request parameters:

  • companyId: identifier of the company associated with the campaign, issued by Fabrick after onboarding.
  • name: name of the campaign, used to identify it on the portal.
  • description: textual description of the campaign, visible to investors.
  • targetAmountMin: minimum amount to be raised for the campaign to be considered successful.
  • targetAmountMax: maximum amount that can be raised in the campaign.
  • currency: currency of the fundraising (e.g., "EUR").
  • expectedClosingDate: expected closing date of the campaign (YYYY-MM-DD format).
  • portalSuccessFee: optional field that defines the success fees applied by the portal; it can include a fixed amount (fixedAmount) and a variable percentage (variableAmountPercentage) of the total amount raised.

Example response:

{
"campaignId": "CMP17031405X2DY182241000067",
"companyId": "USR03VRXZ1726000668",
"name": "Test Campaign E2E",
"description": "Integration test campaign",
"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"
}

Response parameters:

  • campaignId: unique identifier of the newly created campaign, to be used for all subsequent operations.
  • companyId: identifier of the company associated with the campaign.
  • name: name of the campaign.
  • description: description of the campaign.
  • targetAmountMin: minimum amount to be raised.
  • targetAmountMax: maximum amount that can be raised.
  • currency: currency of the campaign.
  • expectedClosingDate: expected closing date.
  • portalSuccessFee: object reporting the set success fees.
  • status: current status of the campaign (e.g., "CREATED").
  • createdDatetime: date and time of creation of the campaign (ISO 8601 format).

Search Campaigns

This endpoint allows you to search among equity crowdfunding campaigns associated with a specific portal. It is designed to filter and retrieve information on campaigns based on various criteria such as status, company, financial objectives, and other relevant parameters.

Example request:

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

Request parameters:

  • portalId: Portal identifier. Required, string representing the portal of interest (example: "PRTU8AX02564061").
  • companyId: (optional) Filter by the ID of the company linked to the campaign.
  • name: (optional) Filter by campaign name.
  • description: (optional) Filter by campaign description.
  • status: (optional) Filter by campaign status. Possible values are:
    • "CREATED": The campaign has been created; it cannot receive new orders.
    • "OPEN": The campaign is open; new orders can be created.
    • "CLOSED": The campaign is closed; it cannot receive new orders.
    • "FINALIZED_SUCCESS": The campaign was successfully completed.
    • "FINALIZED_FAIL": The campaign failed.
    • "CANCELLED": The campaign has been cancelled.
  • targetAmountMin: (optional) Filter by the minimum target amount for the campaign.
  • targetAmountMax: (optional) Filter by the maximum target amount for the campaign.

Example request body:

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

Example response:

{
"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"
}
]
}

Response parameters:

  • campaignId: Unique campaign identifier.
  • status: Campaign status. Can be one of the values described above.
  • companyId: Identifier of the company associated with the campaign.
  • name: Campaign name.
  • description: Campaign description.
  • minTargetAmount: Minimum target amount of the campaign.
  • maxTargetAmount: Maximum target amount of the campaign.
  • portalSuccessFee: JSON object with information about the portal's success fee.
  • portalSuccessFee.fixedAmount: Fixed amount of the success fee, absolute value subtracted from the funds raised in case of success.
  • portalSuccessFee.variableAmountPercentage: Variable percentage of the success fee, calculated on the funds raised (between 0.00 and 100.00).
  • currency: Campaign currency.
  • expectedClosingDate: Expected closing date of the campaign.

Get Campaign

This endpoint allows you to retrieve a single item from the list of campaigns.

Example request:

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

The response will return the details of the campaign.


Update Campaign

This endpoint allows you to update the data of an existing equity crowdfunding campaign, modifying parameters such as name, description, financial objectives, commissions, and expected closing date. It is useful for managing changes that may occur during the life of a campaign.

Example request:

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

Request parameters:

  • portalId: Portal identifier. Required, string representing the portal of interest (example: "PRTU8AX02564061").
  • campaignId: Identifier of the campaign to be updated. Required, string representing the campaign (example: "COL1905176JGV104658000121").
  • name: (optional) New campaign name.
  • description: (optional) New campaign description.
  • minTargetAmount: (optional) New minimum campaign target amount.
  • maxTargetAmount: (optional) New maximum target amount for the campaign.
  • portalSuccessFee: (optional) JSON object with new information about the portal's success fee.
  • portalSuccessFee.fixedAmount: (optional) New fixed amount of the success fee, absolute value subtracted from the funds raised in case of success.
  • portalSuccessFee.variableAmountPercentage: (optional) New variable percentage of the success fee, calculated on the funds raised (between 0.00 and 100.00).
  • expectedClosingDate: (optional) New expected closing date of the campaign.

Example request body:

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

Example response:

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

Response parameters:

  • campaignId: Unique identifier of the updated campaign.
  • name: Updated name of the campaign.
  • description: Updated description of the campaign.
  • minTargetAmount: Updated minimum target amount.
  • maxTargetAmount: Updated maximum target amount.
  • portalSuccessFee: JSON object with updated information about the portal success fee.
  • portalSuccessFee.fixedAmount: Updated fixed amount of the success fee.
  • portalSuccessFee.variableAmountPercentage: Updated variable percentage of the success fee.
  • expectedClosingDate: Updated expected closing date of the campaign.

Get Campaign Available Amount

This endpoint allows you to retrieve the amount raised by an equity crowdfunding campaign. Its main feature is to provide, in real time, details of the amounts already accounted for and those still pending, thus allowing you to monitor the financial status of the campaign. It is particularly useful for dashboards, reporting, and campaign control systems.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/available-amount
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the crowdfunding campaign. Example: COL1905176JGV104658000121

Example response:

{
"campaignId": "COL17031405X2DY182241000067",
"accountedAmount": 6000.00,
"waitingAmount": 1000.00,
"totalAmount": 7000.00,
"currency": "EUR"
}
  • campaignId: The ID of the campaign for which the data was retrieved.
  • accountedAmount: The amount actually accounted for the campaign.
  • waitingAmount: The amount still awaiting accounting, corresponding to the sum of orders in WAITING status.
  • totalAmount: The total amount of the campaign, given by the sum of accountedAmount and waitingAmount.
  • currency: The currency of the campaign (currently only EUR).

Get Campaign Investors

This endpoint allows you to retrieve the list of investors who have placed orders in a specific equity crowdfunding campaign. Its main feature is to provide the identification and contact details of investors, both individuals and legal entities, associated with the selected campaign. It is useful for analysis, reporting, and investor relations management.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/investors
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the crowdfunding campaign. Example: COL1905176JGV104658000121

Example response:

{
"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: The unique ID of the investor.
  • name: The first name of the investor (if a natural person).
  • surname: The last name of the investor (if a natural person).
  • businessName: The investor's company name (if a legal entity).
  • fiscalCode: The investor's tax code.
  • type: The type of investor: NATURAL_PERSON (natural person) or LEGAL_PERSON (legal entity).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Get Campaign Orders

This endpoint allows you to retrieve the list of orders associated with a specific equity crowdfunding campaign. Its main feature is to provide all the details related to orders placed by investors, including order status, amounts, investor data, and payment information. It is useful for monitoring investment flows, managing reporting, and verifying transaction status.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/orders
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the crowdfunding campaign. Example: COL1905176JGV104658000121

Example response:

{
"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: The order ID.
  • investorId: The ID of the investor who placed the order.
  • companyId: The ID of the company raising funds.
  • campaignId: The ID of the crowdfunding campaign.
  • status: The status of the order (CREATED, WAITING, ACCEPTED, SPLIT, CANCELED, INCORRECT_AMOUNT, FAILED, EXPIRED).
  • investorAccount: JSON object with information about the investor's account.
  • investorAccount.iban: The IBAN code of the investor's account.
  • investorAccount.holderName: The name of the account holder (if a natural person).
  • investorAccount.holderSurname: The surname of the account holder (if a natural person).
  • investorAccount.holderBusinessName: The business name of the account holder (if a company).
  • totalAmount: The total amount of the order.
  • orderAmount: The amount of the order allocated to the campaign.
  • feeAmount: The amount of fees applied by the portal.
  • currency: The currency of the order (EUR).
  • channel: The expected payment channel (CARD, MONEY_TRANSFER).
  • description: The description of the order.
  • portalOrderCode: Specific order code for the portal.
  • portalOrderDatetime: Timestamp of the order confirmation by the investor.
  • portalInvestorCode: Specific investor code for the portal.
  • portalCompanyCode: Specific company code for the portal.
  • portalCampaignCode: Specific campaign code for the portal.

Get Campaign Cashout

This endpoint allows you to retrieve the details of a cashout associated with an equity crowdfunding campaign. Its main feature is to provide all information related to the cashout, such as status, amount, dates, and identifiers, which are useful for financial management and campaign reporting.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/cashouts/{cashoutId}
  • portalId: The ID of the portal on which the cashout is active. Example: PRTU8AX02564061
  • cashoutId: The ID of the cashout to retrieve. Example: CO190711094928NOQX000226

Example response:

{
"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: The cashout ID.
  • companyId: The ID of the company receiving the cashout.
  • campaignId: The ID of the campaign associated with the cashout.
  • status: The status of the cashout (CREATED, SCHEDULED, EXECUTED, FAILED, REFUSED_BY_RECEIVER).
  • cro: The CRO of the cashout.
  • amount: The amount of the cashout.
  • currency: The currency of the cashout (EUR).
  • createdDate: The creation date of the cashout.
  • scheduledDate: The scheduled date for the execution of the cashout.
  • executedDate: The execution date of the cashout.

Open Campaign

This endpoint allows you to set the status of a campaign as "open," enabling the receipt of new orders. Its main feature is to manage the campaign lifecycle, updating the status and recording the opening date. It is useful for the operational activation of crowdfunding campaigns.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/opened
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the campaign to open. Example: COL1905176JGV104658000121

Example response:

{
"campaignId": "COL1905176JGV104658000121",
"status": "OPEN",
"openedDatetime": "2019-06-26T14:23:14.457Z"
}
  • campaignId: The campaign ID.
  • status: The campaign status (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
  • openedDatetime: The date and time at which the campaign was opened.

Close Campaign

This endpoint allows you to set the status of a campaign to "closed," preventing the receipt of new orders. Its main feature is to manage the campaign lifecycle, recording the closing date and updating the status. It is useful for the operational and administrative management of crowdfunding campaigns.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/closed
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the campaign to close. Example: COL1905176JGV104658000121

Example response:

{
"campaignId": "COL1905176JGV104658000121",
"status": "CLOSED",
"closedDatetime": "2019-07-19T14:23:14.457Z"
}
  • campaignId: The campaign ID.
  • status: The campaign status (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
  • closedDatetime: The date and time at which the campaign was closed.

Cancel Campaign

This endpoint allows you to set the status of a campaign to "cancelled." The campaign must be in "CREATED" status in order to be cancelled. Its main feature is to manage the cancellation of campaigns that have not yet started, recording the cancellation date and updating the status. It is useful for administrative management and for cancelling campaigns before they start.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/cancelled
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the campaign to cancel. Example: COL1905176JGV104658000121

Example response:

{
"campaignId": "COL1905176JGV104658000121",
"status": "CANCELLED",
"cancelledDatetime": "2019-07-18T14:23:14.457Z"
}
  • campaignId: The campaign ID.
  • status: The campaign status (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
  • cancelledDatetime: The date and time at which the campaign was cancelled.

Campaign Failure

This endpoint allows you to set the status of a campaign as "failed" and automatically refund all orders to investors. Its main feature is to manage the negative closure of campaigns, returning funds to investors and recording refund transactions.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/failure
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the campaign to set as failed. Example: COL1905176JGV104658000121

Example response:

{
"campaignId": "COL1905176JGV104658000121",
"status": "FINALIZED_FAIL",
"ordersUndone": [
{
"orderId": "ORD2309823841827364",
"refundId": "MB0650617080849NMG214000761"
},
{
"orderId": "ORD2309823841827365",
"refundId": "MB0650617080849NMG214000762"
}
]
}
  • campaignId: The campaign ID.
  • status: The campaign status (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
  • ordersUndone: JSON array with information about orders refunded to investors.
  • ordersUndone[i].orderId: The ID of the refunded order.
  • ordersUndone[i].refundId: The ID of the refund transaction.

Campaign Success

This endpoint allows you to set the status of a campaign as "successfully completed" and run the cashout of the funds raised and any portal commissions. Its main feature is to manage the successful closure of campaigns, tracking financial transactions and recording the details of orders and amounts managed.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/campaigns/{campaignId}/success
  • portalId: The ID of the portal on which the campaign is active. Example: PRTU8AX02564061
  • campaignId: The ID of the campaign to set as successfully completed. Example: COL1905176JGV104658000121

Example response:

{
"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: The campaign ID.
  • status: The campaign status (CREATED, OPEN, CLOSED, FINALIZED_SUCCESS, FINALIZED_FAIL, CANCELLED).
  • ordersExecuted: JSON array with the IDs of the orders executed.
  • ordersUndone: JSON array with the IDs of the orders refunded to investors.
  • orderSplit: The ID of the split order.
  • amounts: JSON object with details of the amounts managed.
  • amounts.companyFunds: Funds transferred to the company.
  • amounts.portalSuccessFee: Success fee transferred to the portal.
  • amounts.portalInvestorFee: Investor fee transferred to the portal.
  • amounts.investorsRefunds: Total refunds to investors.
  • amounts.totalCampaignExecuted: Total funds raised (companyFunds + portalSuccessFee).
  • amounts.totalManagedFunds: Total funds managed (companyFunds + portalSuccessFee + portalInvestorFee + investorsRefunds).

Create Investor

This endpoint allows you to create a new investor, whether an individual or a legal entity, by registering their identification and contact details. Its main feature is to allow the registration of new investors to participate in crowdfunding campaigns.

Example request:

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

Request parameters:

  • portalId: The ID of the portal on which to register the investor. Example: PRTU8AX02564061
  • name: The investor's first name (required if NATURAL_PERSON).
  • surname: The investor's last name (required if NATURAL_PERSON).
  • businessName: The investor's company name (required if LEGAL_PERSON).
  • fiscalCode: The investor's tax code (tax code for individuals, VAT number for legal entities).
  • type: The type of investor (NATURAL_PERSON or LEGAL_PERSON).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Example response:

{
"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: The investor's ID.
  • name: The investor's first name (if a natural person).
  • surname: The investor's last name (if a natural person).
  • businessName: The investor's company name (if a legal entity).
  • fiscalCode: The investor's tax code.
  • type: The type of investor: NATURAL_PERSON (natural person) or LEGAL_PERSON (legal entity).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Search Investors

This endpoint allows you to search for investors registered on a portal, filtering by first name, last name, company name, tax ID number, or type. Its main feature is to facilitate the search and selection of investors for analysis, management, or sending communications.

Example request:

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

Request parameters:

  • portalId: The ID of the portal on which to search for investors. Example: PRTU8AX02564061
  • name: Filter by investor name.
  • surname: Filter by investor surname.
  • businessName: Filter by investor company name.
  • fiscalCode: Filter by investor's tax code.
  • type: Filter by investor type (NATURAL_PERSON or LEGAL_PERSON).

Example response:

{
"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: The investor's ID.
  • name: The investor's first name (if a natural person).
  • surname: The investor's last name (if a natural person).
  • businessName: The investor's company name (if a legal entity).
  • fiscalCode: The investor's tax code.
  • type: The type of investor: NATURAL_PERSON (natural person) or LEGAL_PERSON (legal entity).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Get Investor

This endpoint allows you to retrieve details of an existing investor. Its main feature is to provide all the identification and contact information of the investor, whether a natural or legal person, which is useful for management and reporting purposes.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/investors/{investorId}
  • portalId: The ID of the portal on which the investor is registered. Example: PRTU8AX02564061
  • investorId: The ID of the investor to retrieve. Example: INV2017112909534782VI

Example response:

{
"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: The investor's ID.
  • name: The investor's first name (if a natural person).
  • surname: The investor's last name (if a natural person).
  • businessName: The investor's company name (if a legal entity).
  • fiscalCode: The investor's tax code.
  • type: The type of investor: NATURAL_PERSON (natural person) or LEGAL_PERSON (legal entity).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Update Investor

This endpoint allows you to update the data of an existing investor, whether an individual or a legal entity. Its main feature is to allow the modification of the investor's identification and contact information to keep it up to date.

Example request:

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

Request parameters:

  • portalId: The ID of the portal on which the investor is registered. Example: PRTU8AX02564061
  • investorId: The ID of the investor to be updated. Example: INV2017112909534782VI
  • name: The name of the investor (required if NATURAL_PERSON).
  • surname: The surname of the investor (required if NATURAL_PERSON).
  • businessName: The investor's company name (required if LEGAL_PERSON).
  • fiscalCode: The investor's tax code (Tax Code for natural persons, VAT number for legal persons).
  • type: The type of investor (NATURAL_PERSON or LEGAL_PERSON).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Example response:

{
"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: The investor's ID.
  • name: The investor's first name (if a natural person).
  • surname: The investor's last name (if a natural person).
  • businessName: The investor's company name (if a legal entity).
  • fiscalCode: The investor's tax code.
  • type: The type of investor: NATURAL_PERSON (natural person) or LEGAL_PERSON (legal entity).
  • address: The investor's address (street and house number).
  • postalCode: The investor's postal code.
  • city: The investor's city.
  • country: The investor's country.
  • email: The investor's email address.
  • phone: The investor's phone number.

Create Order

This endpoint allows you to create a new investment order on an equity crowdfunding campaign. It allows you to specify all the details of the order, the investor, and the campaign, including amounts, payment channel, and identification data.

Example request:

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

Request parameters:

  • portalId: The portal ID. Example: PRTU8AX02564061
  • investorId: The investor ID.
  • companyId: The ID of the company raising the funds.
  • campaignId: The campaign ID.
  • investorAccount: JSON object with information about the investor's account.
  • investorAccount.iban: IBAN of the account.
  • investorAccount.holderName: Name of the account holder (if a natural person).
  • investorAccount.holderSurname: Surname of the account holder (if a natural person).
  • investorAccount.holderBusinessName: Company name of the account holder (if a company).
  • totalAmount: Total amount of the order.
  • orderAmount: Amount allocated to the campaign.
  • feeAmount: Amount of portal fees.
  • currency: Currency of the order (EUR).
  • channel: Payment channel (CARD, MONEY_TRANSFER).
  • description: Description of the order (max 50 characters).
  • portalOrderCode: Specific order code for the portal.
  • portalOrderDatetime: Timestamp of the order confirmation.
  • portalInvestorCode: Specific investor code for the portal.
  • portalCompanyCode: Specific company code for the portal.
  • portalCampaignCode: Specific campaign code for the portal.

Example response:

{
"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: The order ID.
  • investorId: The investor ID.
  • companyId: The company ID.
  • campaignId: The campaign ID.
  • status: Order status (CREATED, WAITING, ACCEPTED, SPLIT, CANCELED, INCORRECT_AMOUNT, FAILED, EXPIRED).
  • investorAccount: JSON object with information about the investor's account.
  • investorAccount.iban: IBAN of the account.
  • investorAccount.holderName: Name of the account holder (if a natural person).
  • investorAccount.holderSurname: Surname of the account holder (if a natural person).
  • investorAccount.holderBusinessName: Company name of the account holder (if a company).
  • totalAmount: Total amount of the order.
  • orderAmount: Amount allocated to the campaign.
  • feeAmount: Amount of portal fees.
  • currency: Currency of the order (EUR).
  • channel: Payment channel.
  • description: Description of the order.
  • portalOrderCode: Specific order code for the portal.
  • portalOrderDatetime: Timestamp of the order confirmation.
  • portalInvestorCode: Specific investor code for the portal.
  • portalCompanyCode: Specific company code for the portal.
  • portalCampaignCode: Specific campaign code for the portal.

Search Orders

This endpoint allows you to search for orders registered on a portal, filtering by various parameters such as investor, company, campaign, status, amounts, channel, and specific codes.

Example request:

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

Request parameters:

  • portalId: The portal ID. Example: PRTU8AX02564061
  • investorId: Filter for the investor ID.
  • companyId: Filter for the company ID.
  • campaignId: Filter for the campaign ID.
  • status: Filter for the order status.
  • investorAccount: JSON object to filter the investor account.
  • investorAccount.iban: Filter for IBAN.
  • investorAccount.holderName: Filter for account holder name.
  • investorAccount.holderSurname: Filter for account holder surname.
  • investorAccount.holderBusinessName: Filter for account holder business name.
  • totalAmount: Filter for total amount.
  • orderAmount: Filter for amount allocated to the campaign.
  • feeAmount: Filter for commission amount.
  • currency: Filter for currency (EUR).
  • channel: Filter for payment channel (CARD, MONEY_TRANSFER).
  • description: Filter by description.
  • portalOrderCode: Filter by portal order code.
  • portalOrderDatetime: Filter by order confirmation timestamp.
  • portalInvestorCode: Filter by portal investor code.
  • portalCompanyCode: Filter by portal company code.
  • portalCampaignCode: Filter by portal campaign code.

Example response:

{
"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: The order ID.
  • investorId: The investor ID.
  • companyId: The company ID.
  • campaignId: The campaign ID.
  • status: Order status.
  • investorAccount: JSON object with information about the investor's account.
  • investorAccount.iban: Account IBAN.
  • investorAccount.holderName: Account holder's first name.
  • investorAccount.holderSurname: Account holder's last name.
  • investorAccount.holderBusinessName: Account holder's business name.
  • totalAmount: Total amount of the order.
  • orderAmount: Amount allocated to the campaign.
  • feeAmount: Amount of fees.
  • currency: Currency of the order.
  • channel: Payment channel.
  • description: Description of the order.
  • portalOrderCode: Portal order code.
  • portalOrderDatetime: Order confirmation timestamp.
  • portalInvestorCode: Portal investor code.
  • portalCompanyCode: Portal company code.
  • portalCampaignCode: Portal campaign code.

Get Order

This endpoint allows you to retrieve the details of an existing order, including all data relating to the investor, the campaign, the amounts, and the status.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: The order ID. Example: TRX2017112910135441O5

Example response:

{
"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: The order ID.
  • investorId: The investor ID.
  • companyId: The company ID.
  • campaignId: The campaign ID.
  • status: Order status.
  • investorAccount: JSON object with information about the investor's account.
  • investorAccount.iban: Account IBAN.
  • investorAccount.holderName: Account holder's first name.
  • investorAccount.holderSurname: Account holder's last name.
  • investorAccount.holderBusinessName: Account holder's business name.
  • totalAmount: Total amount of the order.
  • orderAmount: Amount allocated to the campaign.
  • feeAmount: Amount of fees.
  • currency: Currency of the order.
  • channel: Payment channel.
  • description: Description of the order.
  • portalOrderCode: Portal order code.
  • portalOrderDatetime: Order confirmation timestamp.
  • portalInvestorCode: Portal investor code.
  • portalCompanyCode: Portal company code.
  • portalCampaignCode: Portal campaign code.

Update Order Campaign

This endpoint allows you to update the campaign associated with an existing order, moving the order from one campaign to another (the new campaign must be in OPEN status).

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: The order ID. Example: TRX2017112910135441O5
  • fromCampaign: The ID of the current campaign of the order.
  • toCampaign: The ID of the new campaign (must be OPEN).

Example response:

{
"orderId": "TRX2017112910135441O5",
"campaignId": "COL2005385ULR253158475398"
}
  • orderId: The order ID.
  • campaignId: The ID of the campaign associated with the order.

Cancel Order

This endpoint allows you to set the status of an order to "cancelled." If the order is in ACCEPTED status, it is also refunded to the investor; otherwise, no money flow is accepted.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/cancelled
  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: The order ID. Example: TRX2017112910135441O5

Example response:

{
"orderId": "TRX2017112910135441O5",
"status": "CANCELLED"
}
  • orderId: The order ID.
  • status: The order status.

Set Order to Waiting

This endpoint allows you to set the status of an order to "waiting." An order must be marked as waiting when the investor has agreed to send the money.

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/waiting
  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: The order ID. Example: TRX2017112910135441O5

Example response:

{
"orderId": "TRX2017112910135441O5",
"status": "WAITING"
}
  • orderId: The order ID.
  • status: The order status.

Set Order to Failed Status

This endpoint allows you to set the status of an order to "failed." An order must be marked as failed when an error occurs in the transaction (for example, unauthorized card or insufficient funds).

Example request:

PUT /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/failed
  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: The order ID. Example: TRX2017112910135441O5

Example response:

{
"orderId": "TRX2017112910135441O5",
"status": "FAILED"
}
  • orderId: The order ID.
  • status: The order status.

Get Order Payment

This endpoint allows you to retrieve the details of the payment associated with an order, including status, channel, amounts, dates, and references to moneyin, moneyout, cashout, and refund.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/orders/{orderId}/payment
  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: The order ID. Example: TRX2017112910135441O5

Example response:

{
"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: The order ID.
  • companyId: The company ID.
  • campaignId: The campaign ID.
  • orderStatus: The order status.
  • paymentStatus: The payment status.
  • channel: The payment channel.
  • moneyinId: The ID of the incoming payment.
  • moneyoutIds: List of outgoing payment IDs.
  • cashoutIds: List of cashout IDs.
  • refundIds: List of refund IDs.
  • createdDatetime: Date and time of order creation.
  • waitingDatetime: Date and time the order entered waiting status.
  • receivedDatetime: Date and time the payment was received.
  • accountedToCampaignDatetime: Date and time the payment was accounted to the campaign.
  • expiredDatetime: Date and time of expiry (if applicable).
  • failedDatetime: Date and time of failure (if applicable).

Order Payment Moneyin

This endpoint allows you to retrieve the details of an incoming payment (moneyin) associated with a crowdfunding order. Its main feature is to provide all information related to the money transfer received, including status, amount, channel, reconciliation codes, and payer details.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/moneyins/{moneyinId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • moneyinId: The ID of the moneyin to retrieve.

Example response:

{
"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: The ID of the incoming payment.
  • cro: CRO code (for moneyin via MONEY_TRANSFER).
  • rrn: RRN code (for moneyin via CARD).
  • status: Moneyin status (WAITING, REQUESTED_TO_PAYER, ACCEPTED, REJECTED, EXPIRED).
  • amount: Amount of the incoming payment.
  • currency: Currency of the payment.
  • channel: Payment channel (CARD, MONEY_TRANSFER).
  • datetime: Date and time of payment execution.
  • payerIban: IBAN of the payer.
  • payerName: Name of the payer.

Order Payment Moneyout

This endpoint allows you to retrieve the details of an outgoing payment (moneyout) associated with a crowdfunding order. Its main feature is to provide all information related to the transfer of money to the company, including status, amount, availability for cashout, and identification data.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/moneyouts/{moneyoutId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • moneyoutId: The ID of the moneyout to retrieve.

Example response:

{
"moneyoutId": "MO181951400555230W9V5001485",
"companyId": "USR02KZLN1827000201",
"status": "AVAILABLE",
"amount": 810.68,
"cashoutAvailableAmount": 810.68,
"currency": "EUR",
"createdDatetime": "2019-05-30T18:51:40.000Z",
"lastCashoutDatetime": ""
}
  • moneyoutId: The ID of the outgoing payment.
  • companyId: The ID of the recipient company.
  • status: Moneyout status (CREATED, AVAILABLE, WORK_IN_PROGRESS, BOOKED_FOR_CASHOUT, DEPLETED, FAILED, EXPIRED).
  • amount: Amount of the outgoing payment.
  • cashoutAvailableAmount: Amount available for cashout.
  • currency: Currency of the payment.
  • createdDatetime: Date and time of creation of the moneyout.
  • lastCashoutDatetime: Date and time of the last cashout (if applicable).

Order Payment Refund

This endpoint allows you to retrieve the details of a payment refund associated with a crowdfunding order. Its main feature is to provide all information related to the refund, including status, amount, currency, and creation and execution dates.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/refunds/{refundId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • refundId: The ID of the refund to retrieve.

Example response:

{
"refundId": "MB0287617555553OEKR12000041",
"status": "EXECUTED",
"createdDatetime": "2018-06-28T02:26:28.000Z",
"executedDatetime": "2018-06-28T06:00:25.000Z",
"amount": 40,
"currency": "EUR"
}
  • refundId: The refund ID.
  • status: Refund status (CREATED, SCHEDULED, WORK_IN_PROGRESS, EXECUTED, FAILED, REFUSED_BY_RECEIVER).
  • createdDatetime: Date and time of creation of the refund.
  • executedDatetime: Date and time of execution of the refund.
  • amount: Refund amount.
  • currency: Refund currency.

Search Unidentified Transfers

This endpoint allows you to search for unidentified transfers recorded on a portal, filtering by various parameters such as amount, currency, description, payer name, status, and dates.

Example request:

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

Request parameters:

  • portalId: The portal ID. Example: PRTU8AX02564061
  • amount: Filter by transfer amount.
  • currency: Filter by transfer currency.
  • description: Filter by transfer description.
  • payerName: Filter by payer name.
  • status: Filter by transfer status (RECEIVED, SENT_BACK).
  • receivedDatetime: Filter by receipt date.
  • refundedDatetime: Filter by refund date.

Example response:

{
"list": [
{
"unidentifiedTransferId": "UTR170309AHMC07172815000001",
"amount": 120,
"currency": "EUR",
"description": "TRXWRONGID",
"payerName": "John Doe",
"status": "RECEIVED",
"type": "UNIDENTIFIED",
"receivedDatetime": "2019-06-24T09:39:19Z",
"refundedDatetime": ""
}
]
}
  • unidentifiedTransferId: The ID of the unidentified transfer.
  • amount: Transfer amount.
  • currency: Transfer currency.
  • description: Transfer description.
  • payerName: Payer name.
  • status: Transfer status.
  • type: Transfer type.
  • receivedDatetime: Date and time of receipt.
  • refundedDatetime: Date and time of refund.

Get Unidentified Transfer

This endpoint allows you to retrieve details of an unidentified transfer associated with a crowdfunding portal. Its main feature is to provide all information related to the transfer, including status, amount, type, dates, and payer details.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/unidentified-transfers/{unidentifiedTransferId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • unidentifiedTransferId: The unidentified transfer ID. Example: UTR170309AHMC07172815000001

Example response:

{
"unidentifiedTransferId": "UTR170309AHMC07172815000001",
"amount": 120,
"currency": "EUR",
"description": "TRXWRONGID",
"payerName": "John Doe",
"status": "RECEIVED",
"type": "UNIDENTIFIED",
"receivedDatetime": "2019-06-24T09:39:19Z",
"refundedDatetime": ""
}
  • unidentifiedTransferId: The ID of the unidentified transfer.
  • amount: Transfer amount.
  • currency: Transfer currency.
  • description: Transfer description.
  • payerName: Payer name.
  • status: Transfer status (RECEIVED, SENT_BACK).
  • type: Transfer type (UNIDENTIFIED, WRONG_AMOUNT, WRONG_CHANNEL).
  • receivedDatetime: Date and time the transfer was received.
  • refundedDatetime: Date and time the transfer was refunded.

Search Disputes

This endpoint allows you to search for disputes recorded on a portal, filtering by various parameters such as order, RRN code, amount, creation date, and closing date.

Example request:

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

Request parameters:

  • portalId: The portal ID. Example: PRTU8AX02564061
  • orderId: Filter for the order ID.
  • rrnCode: Filter for the RRN code of the dispute.
  • paymentAmount: Filter for the order amount.
  • createdDate: Filter for the creation date of the dispute.
  • closedDate: Filter for the closing date of the dispute.

Example response:

{
"list": [
{
"disputeId": "DSP180123GJ2O000001",
"orderId": "TRX2018012307283521FG",
"rrnCode": "",
"description": "",
"paymentAmount": 30,
"status": "CLOSED_WON",
"createdDate": "2018-01-01",
"closedDate": "2018-01-30"
}
]
}
  • disputeId: The dispute ID.
  • orderId: The ID of the associated order.
  • rrnCode: RRN code of the dispute.
  • description: Description of the order.
  • paymentAmount: Amount of the order.
  • status: Status of the dispute.
  • createdDate: Creation date of the dispute.
  • closedDate: Closing date of the dispute.

Get Dispute

This endpoint allows you to retrieve the details of a dispute associated with a crowdfunding order. Its main feature is to provide all information related to the dispute, including status, amount, dates, and identifiers.

Example request:

GET /api/gbs/crowdfunding-equity/v4.0/portals/{portalId}/disputes/{disputeId}
  • portalId: The portal ID. Example: PRTU8AX02564061
  • disputeId: The ID of the dispute to retrieve. Example: DSP180123GJ2O000001

Example response:

{
"disputeId": "DSP180123GJ2O000001",
"orderId": "TRX2018012307283521FG",
"rrnCode": "",
"description": "",
"paymentAmount": 30,
"status": "CLOSED_WON",
"createdDate": "2018-01-01",
"closedDate": "2018-01-30"
}
  • disputeId: The dispute ID.
  • orderId: The ID of the associated order.
  • rrnCode: RRN code of the dispute.
  • description: Description of the order.
  • paymentAmount: Amount of the order.
  • status: Status of the dispute (OPEN, CLOSED_WON, CLOSED_LOST).
  • createdDate: Creation date of the dispute.
  • closedDate: Closing date of the dispute.