POST api/v1/PaymentsReceived

Return a list of all payments received between 2 dates

Request Information

URI Parameters

None.

Body Parameters

PaymentsReceivedParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
DateFrom

List payments created on and since YYYYMMDD. If supplied empty then all payments will be returned

 string

None.
DateTo

List payments created on and before YYYYMMDD. If supplied empty then all payments will be returned

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "DateFrom": "sample string 1",
  "DateTo": "sample string 2",
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample: 
<PaymentsReceivedParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateFrom>sample string 1</DateFrom>
  <DateTo>sample string 2</DateTo>
  <apiKey>sample string 1</apiKey>
</PaymentsReceivedParams>

Response Information

Resource Description

Returns:
200 OK Returns error list if failed
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

PaymentsReceived
NameDescriptionTypeAdditional information
ReceivedPaymentList

Collection of ReceivedPayment

None.

Response Formats

application/json, text/json

Sample: 
{
  "ReceivedPaymentList": [
    {
      "DateCreated": "sample string 1",
      "Amount": 2.0,
      "Currency": "sample string 3",
      "OrderNo": 4,
      "AccountNo": "sample string 5",
      "CustomerName": "sample string 6",
      "Method": "sample string 7",
      "ProcessedBy": "sample string 8"
    },
    {
      "DateCreated": "sample string 1",
      "Amount": 2.0,
      "Currency": "sample string 3",
      "OrderNo": 4,
      "AccountNo": "sample string 5",
      "CustomerName": "sample string 6",
      "Method": "sample string 7",
      "ProcessedBy": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample: 
<PaymentsReceived xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReceivedPayment>
    <DateCreated>sample string 1</DateCreated>
    <Amount>2</Amount>
    <Currency>sample string 3</Currency>
    <OrderNo>4</OrderNo>
    <AccountNo>sample string 5</AccountNo>
    <CustomerName>sample string 6</CustomerName>
    <Method>sample string 7</Method>
    <ProcessedBy>sample string 8</ProcessedBy>
  </ReceivedPayment>
  <ReceivedPayment>
    <DateCreated>sample string 1</DateCreated>
    <Amount>2</Amount>
    <Currency>sample string 3</Currency>
    <OrderNo>4</OrderNo>
    <AccountNo>sample string 5</AccountNo>
    <CustomerName>sample string 6</CustomerName>
    <Method>sample string 7</Method>
    <ProcessedBy>sample string 8</ProcessedBy>
  </ReceivedPayment>
</PaymentsReceived>