Transactions Transactions
  1. Acorn Help Centre
  2. Developers
  3. REST-API

Transactions

Mounika Vukkadam Mounika Vukkadam

Transactions

Transactions include the details of all purchases within the LMS. The details of the user that made the purchase is included along with the LMS content the transaction is attached to.

 

Get transactions:

Description
 Returns all transactions within the tenancy.
Request Method GET
Request URL {{base_url}}/local/acorn_administration/index.php/api/1/transactions/{{tenancy_id}}
Authorisation Header Bearer {api_key}

 

Query String Parameters:

Parameter Data Type Details
requestid integer optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned

 

Example Response without requestId included:

{ 
  "requestid": 161, 
  "status": "Processing" 
}

Example Response with requestId included:

If request is still processing:

{ 
  "requestid": 161, 
  "status": "Processing" 
}

If request is complete:


{
  "requestid": 161,
  "status": "Complete",
  "data": [
     {
          "receiptid": "LMS0067",
          "amount": 10909,
          "transactionid": "ch_1HMjQEKJTDhvAbMEyigIgPCG",
          "transactiondate": "2020-09-02 00:01:55",
          "status": "succeeded",
          "user": {
             "id": 33,
             "firstname": "Hope",
             "lastname": "Renner",
             "username": "hope.renner@example.com"
           },
           "payment_application": {
              "contentname": "Safety Workshop: Day 1 ( 30/09/2020, 11:00 AM - 30/09/2020, 12:00 PM )",
              "contentid": 32,
              "contenttype": "Session"
            }
    },
    {
          "receiptid": "LMS0068",
          "amount": 12000,
          "transactionid": "ch_1HMSTJD7bSqcpr0cuuk6ObaS",
          "transactiondate": "2020-09-01 05:55:58",
          "status": "succeeded",
          "user": {
            "id": 29,
            "firstname": "Toni",
            "lastname": "Wardwina",
            "username": "toni54@example.com"
          },
          "payment_application": {
            "contentname": "Fraud Awareness",
            "contentid": 8,
            "contenttype": "Course"
         }
     }
  ]
}

Was this article helpful?

0 out of 0 found this helpful

Articles in this section

Add comment

Please sign in to leave a comment.