...
Attributes of the HTTP request
HTTP Request Header | |||
|---|---|---|---|
Authorization | string | required | A security token provided from Authentication endpoint. |
X-Account-Token | string | required | An unique identifier of the account. |
Broker Parameters
The initial set of parameters pertains to broker data. Only specific elements within this data subset are mandatory for delivery. These required elements assist the API in providing critical information for the broker creation.
...
Attributes of the HTTP response
Success response | |||
|---|---|---|---|
JSON array of objects object containing: | |||
status | string | required | A text providing more information on the succesful operation. |
bToken | string | required | An identifier for the new broker. |
Failed response | |||
error | string | required | It contains a reason for the failed request. |
...
As previously stated, to execute Broker Create, it is imperative to dispatch a POST HTTP request to the /api/broker/set/{:token}ipn/brokers endpoint of the API. Below, instances of potential communication between the API and consumers are provided.
...