POST api/account/task/stock-transfer-task

Submit Stock Transfer Request

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Source	Movement of stock from. This value can be either a HIN or a client account number. HIN value should have the format 'x' followed by numeric digits.	string	Required
Destination	Movement of stock to. This value can be either a HIN or a client account number. HIN value should have the format 'x' followed by numeric digits.	string	Required
Stock	Security code	string	Required
Quantity	Quantity	integer	Required
Reference	Reference associated with the task created from the stock transfer request	string	Required String length: inclusive between 1 and 100

Request Formats

application/json, text/json

Sample:

{
  "Source": "X1234567890",
  "Destination": "12345678",
  "Stock": "BHP",
  "Quantity": 1000,
  "Reference": "REFXVVX"
}

application/xml, text/xml

Sample:

<StockTransferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks">
  <Destination>12345678</Destination>
  <Quantity>1000</Quantity>
  <Reference>REFXVVX</Reference>
  <Source>X1234567890</Source>
  <Stock>BHP</Stock>
</StockTransferRequest>

Response Information

Resource Description

StockTransferResponse

Name	Description	Type	Additional information
TaskUID	Unique identifier of the task created for the request. Can be used to search specifically for the task of this request.	globally unique identifier	None.
Reference	Reference tagged to the task created for the request. Can be used to search all tasks with this reference.	string	None.
Status	Status of the task created for the request	enTaskStatus	None.
RejectedReason	Error message when failed to create the CHESS message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TaskUID": "9d4e91cd-494b-44e6-b638-2267d6c027ea",
  "Reference": "REFXVVX",
  "Status": 0,
  "RejectedReason": ""
}

application/xml, text/xml

Sample:

<StockTransferResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Tasks">
  <Reference>REFXVVX</Reference>
  <RejectedReason></RejectedReason>
  <Status>New</Status>
  <TaskUID>9d4e91cd-494b-44e6-b638-2267d6c027ea</TaskUID>
</StockTransferResponse>

Error Response Information

Resource Description

StockTransferResponse

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Code": 1,
      "Description": "sample string 1"
    },
    {
      "Code": 1,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<BadRequestResultOfenStockTransferTaskCreateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse">
  <Errors>
    <ErrorOfenStockTransferTaskCreateErrorYd1IcMMv>
      <Code>SourceRequired</Code>
      <Description>sample string 1</Description>
    </ErrorOfenStockTransferTaskCreateErrorYd1IcMMv>
    <ErrorOfenStockTransferTaskCreateErrorYd1IcMMv>
      <Code>SourceRequired</Code>
      <Description>sample string 1</Description>
    </ErrorOfenStockTransferTaskCreateErrorYd1IcMMv>
  </Errors>
</BadRequestResultOfenStockTransferTaskCreateErrorYd1IcMMv>