POST api/order/get-details

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
request_ref	string	None.
request_type	string	None.
mock_mode	string	None.
details	OrderDetailsLookupRequestDetails	None.

Request Formats

application/json, text/json

Sample:

{
  "request_ref": "sample string 1",
  "request_type": "sample string 2",
  "mock_mode": "sample string 3",
  "details": {
    "payer_id": "sample string 1",
    "payer_name": "sample string 2",
    "payer_type": "sample string 3",
    "amount": 4.1,
    "inflow_status": "sample string 5",
    "inflow_narration": "sample string 6",
    "transaction_ref": "sample string 7",
    "provider": "sample string 8",
    "meta": {}
  }
}

application/xml, text/xml

Sample:

<OrderDetailsLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <RequestRef>sample string 1</RequestRef>
  <RequestType>sample string 2</RequestType>
  <MockMode>sample string 3</MockMode>
  <Details>
    <PayerId>sample string 1</PayerId>
    <PayerName>sample string 2</PayerName>
    <PayerType>sample string 3</PayerType>
    <Amount>4.1</Amount>
    <InflowStatus>sample string 5</InflowStatus>
    <InflowNarration>sample string 6</InflowNarration>
    <TransactionRef>sample string 7</TransactionRef>
    <Provider>sample string 8</Provider>
    <Meta />
  </Details>
</OrderDetailsLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderDetailsLookupResponse

Name	Type	Additional information
status	string	None.
message	string	None.
data	OrderLookupDetailsData	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "message": "sample string 2",
  "data": {
    "errors": [
      "sample string 1",
      "sample string 2"
    ],
    "error": "sample string 1",
    "orders": [
      {
        "order_id": "sample string 1",
        "order_status": "sample string 2",
        "order_description": "sample string 3",
        "retailer_id": "sample string 4",
        "distributor_id": "sample string 5",
        "distributor_name": "sample string 6",
        "distributor_account_number": "sample string 7",
        "distributor_bank_code": "sample string 8",
        "amount_due": 9,
        "fee": 10,
        "currency": "sample string 11",
        "meta": {}
      },
      {
        "order_id": "sample string 1",
        "order_status": "sample string 2",
        "order_description": "sample string 3",
        "retailer_id": "sample string 4",
        "distributor_id": "sample string 5",
        "distributor_name": "sample string 6",
        "distributor_account_number": "sample string 7",
        "distributor_bank_code": "sample string 8",
        "amount_due": 9,
        "fee": 10,
        "currency": "sample string 11",
        "meta": {}
      }
    ],
    "reference": "sample string 2",
    "meta": {}
  }
}

application/xml, text/xml

Sample:

<OrderDetailsLookupResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Status>sample string 1</Status>
  <Message>sample string 2</Message>
  <Data>
    <Errors>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Errors>
    <Error>sample string 1</Error>
    <Orders>
      <OrderLookup>
        <Id>sample string 1</Id>
        <Status>sample string 2</Status>
        <Description>sample string 3</Description>
        <RetailerId>sample string 4</RetailerId>
        <DistributorId>sample string 5</DistributorId>
        <DistributorName>sample string 6</DistributorName>
        <DistributorAccountNumber>sample string 7</DistributorAccountNumber>
        <DistributorBankCode>sample string 8</DistributorBankCode>
        <AmountDue>9</AmountDue>
        <Fee>10</Fee>
        <Currency>sample string 11</Currency>
        <Meta />
      </OrderLookup>
      <OrderLookup>
        <Id>sample string 1</Id>
        <Status>sample string 2</Status>
        <Description>sample string 3</Description>
        <RetailerId>sample string 4</RetailerId>
        <DistributorId>sample string 5</DistributorId>
        <DistributorName>sample string 6</DistributorName>
        <DistributorAccountNumber>sample string 7</DistributorAccountNumber>
        <DistributorBankCode>sample string 8</DistributorBankCode>
        <AmountDue>9</AmountDue>
        <Fee>10</Fee>
        <Currency>sample string 11</Currency>
        <Meta />
      </OrderLookup>
    </Orders>
    <Reference>sample string 2</Reference>
    <Meta />
  </Data>
</OrderDetailsLookupResponse>