FAQs

How do allocations take place when we send subscriptions to the test server?

In general, allocations happen after an offer has been closed. Within our testing environments, please contact your PrimaryBid solution engineer if you need allocations to be populated for an offer for downstream testing purposes.

When will allocations trigger?

In a testing scenario, allocations are manually triggered by PrimaryBid, once the test offer has been closed. In a production scenario, allocations would typically be announced the day after the deal closes once we have finalised them. Allocation data can also be sent via webhooks and we will require a separate web service endpoint from you to facilitate this transfer.

In the test environment, are there any amount restrictions for allocations for the provided subscriptions?

Allocations in PrimaryBid's case refer to the number of shares granted for each order as part of an offer by the issuer. For testing, there is no need to restrict the amount as we can allocate as much as needed - either full or partial for various test cases.

Will the offer and allocation payloads be represented in a single record or an array of records?

For offers:

• The GET/offer call retrieves all accessible PrimaryBid offers in an array.
• The GET/offer/{offerId}call only returns one offer.

For allocations:

• The GET/allocation call retrieves all allocations in an array.
• The GET/allocation/{offerId} returns all allocations for a specific offer in an array.

For GET/offer, GET/allocation, and GET/allocation/{offerId} you can also opt for a paginated response by using the query parameters offset and limit in the initial request.

For webhooks:

• The Offer webhook payload only contains a single offer. This is generated when an individual offer has been made public. The payload will be the same as calling the GET/offer/{offerId} endpoint.
• The Allocation webhook payload contains an array with all allocations for a given offer. The payload is identical to the one received by calling the GET/allocation/{offerId} endpoint. You can also get just a notification with the allocations count - in this case, you should subsequently poll our GET/allocation endpoint for all allocations, or GET/allocation/{offerId} endpoint to retrieve allocations for a specific offer.

When an offer closes, will we get notified via the webhooks interface with an offer message that has an updated status?

Yes, we fire out an offer_closed webhook as soon as the offer closes, or in rare cases when we close an offer early. The payload is the same as the offer_open one, with one difference in the status field (value has changed from open_for_subscription to closed_for_subscription).

Will the subscription API call return standard HTTP statuses with no other information?

For the POST endpoint, it will return a response body which includes all submitted fields as well as a subscriptionId field which is uniquely generated by PrimaryBid. For community offers, it will return additional HTTP statuses about the membership code validation.