tanner/spaceport
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document transaction reporting

Browse Source
This commit is contained in:
Tanner Collin 2020-02-01 01:38:12 +00:00
parent 9fd7e76486
commit baeda4acb9
1 changed files with 56 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
apiserver/docs/source/api.rst
View File

@ -464,27 +464,69 @@ Transaction Details
:requestheader Authorization: ``Token <token>`` :requestheader Authorization: ``Token <token>``
**Example user response**: **Example response**:
.. sourcecode:: json .. sourcecode:: json
{ {
"id": 9320, "id": 40720,
"account_type": "PayPal", "account_type": "PayPal",
"info_source": "Paypal IPN", "info_source": "PayPal IPN",
"member_id": 1685, "member_id": 1685,
"member_name": "Tanner Collin", "member_name": "Tanner Collin",
"date": "2017-01-30", "date": "2020-01-30",
"amount": "50.00", "report_type": null,
"reference_number": "2DS184750R9", "amount": "100.00",
"memo": "1685, email", "reference_number": "234236326",
"number_of_membership_months": null, "memo": "1685, text, email, etc",
"payment_method": null, "number_of_membership_months": 2,
"category": "Memberships:Paypal Payments", "payment_method": "instant",
"user": 113, "category": "Memberships:PayPal Payments",
"paypal_txn_id": "234236326",
"paypal_payer_id": "123ABCDEFGHIJ",
"report_memo": null,
"user": 2,
"recorder": null "recorder": null
} }
Reported Transactions
+++++++++++++++++++++
.. http:get:: /transactions/
Retrieve a list of reported transactions. Admins only.
Reported transactions are one with a report_type not null.
:requestheader Authorization: ``Token <token>``
**Example response**
Truncated.
.. sourcecode:: json
{
"count": 6,
"next": null,
"previous": null,
"results": [
{
"id": 40715,
"etc": "...",
},
{
"id": 40716,
"etc": "...",
},
{
"id": 40717,
"etc": "...",
}
]
}
Create Transaction Create Transaction
++++++++++++++++++ ++++++++++++++++++
@ -506,6 +548,9 @@ Create Transaction
:json memo: optional :json memo: optional
:json payment_method: optional :json payment_method: optional
:json category: optional :json category: optional
:json report_type: One of: ``null``, ``Unmatched Member``, ``Unmatched Purchase``,
``User Flagged``
:json report_memo: The reason for the report, optional.
:requestheader Authorization: ``Token <token>`` :requestheader Authorization: ``Token <token>``