Payment history report

Returns a report of the payment history for the authenticated organization.

Request

  • HTTP Verb: GET
  • URI: /report/paymentHistory

Searchable Fields

start_date Example:

(start_date[eq]:2013-11-01)

display transactions on or after 2013-11-01

end_date Example:

(end_date[eq]:2014-11-01)

display transactions on or before 2014-11-01

seller_id Example:

(seller_id[eq]:123456)

display transactions of e-learning sold by user with id = 123456

buyer_id Example:

(buyer_id[eq]:123456)

display transactions of e-learning bought by user with id = 123456

coupon Example:

(coupon[eq]:coupon-code-1234)

display transactions where the following coupon code was used: 'coupon-code-1234'

elearning_id Example:

(elearning_id[eq]:4567)

display all transactions where e-learning 4567 was purchased

elearning_name Example:

(elearning_name[lk]:a brief history)

display all transactions where the e-learning name contains 'a brief history'

See Advanced queries for details on how to use Searchable Fields.

Request example

curl -H "Request-Time: Wed, 11 Dec 2013 13:15:04 +0000" \
     -H "Api-Key: 78b47a40f93378a6a487919edea6e92c" \
     -H "Signature: 0a035961fbf7d2ffdc5ca8780e0a33cb3d6c3a5f8fb0623e886c9933377d3e1e" \
     http://wceaapi.org/v1.1/report/paymentHistory

Output Example

{
  "_meta": {
   ...
  },
  "records": [
    {
      "date": "11 Dec 2013",
      "currency": "USD",
      "member_id": 1234,
      "member_name": "A Member Name"
      "e-learning_price": "USD 12.00",
      "e-learning_reference": 9876,
      "e-learning_name": "A e-learning name",
      "portal" => "ABBREV",
      "author_fee": "",
      "organization_fee": "",
      "transaction_fee": "",
      "coupon" => "",
      "e-learning_discounted_price": "",
      "e-learning_discount_percentage": ""
    },
    {
      "date": "12 Dec 2013",
      "currency": "EUR",
      "member_id": 2345,
      "member_name": "Another Member Name"
      "e-learning_price": "USD 10.00",
      "e-learning_reference": 9947,
      "e-learning_name": "Another e-learning name",
      "portal" => "ABBREV",
      "author_fee": "EUR 4.00",
      "organization_fee": "EUR 0.50",
      "transaction_fee": "EUR 0.50",
      "coupon" => "coupon-code-1234",
      "e-learning_discounted_price": "EUR 5.00",
      "e-learning_discount_percentage": "50%"
    },
    ...
  ]
}