Mike.robski: 1 revision: Release 93

2014-05-08T07:34:16Z

1 revision: Release 93

Angel.dinev: /* Examples */

2014-04-11T11:48:13Z

Examples

New page

= GET /accounts/''{accountId}''/transactions?sortField={sortField}&sortOrder={sortOrder} =
Gets a list of account's transactions sorted by sortField param
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/transactions?sortField={sortField}&sortOrder={sortOrder}</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

; sortField - ''string''
: sortField param. Possible values are: 'amount','type'.

; sortOrder - ''string''
: sortOrder param. Possible values are: 'asc','desc'.

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
;200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

;403 Forbidden
: The user lacks the necessary permissions to access the resource

;404 Not Found
: The accountId was not found.

=== Response Body ===
<nowiki>
{
{
"list": [{
"startDate": "{startDate}",
"endDate": "{endDate}",
"amount": {amount},
"description": "{description}",
"currency": "{currency}",
"date": "{date}",
"productSpecification": "",
"serviceNumber": "{serviceNumber}",
"type": "{type}",
"number": {number}
}],
"links" : [{
"href" : "https://api.hostway.com/accounts/{account_id}/transactions",
"rel" : "self"
}]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about transactions

:; startDate - ''string''
:: Start date of transaction

:; endDate - ''string''
:: End date of transaction

:; ammount - ''integer''
:: Amount of transaction

:; description - ''string''
:: Description of transaction

:; currency - ''string''
:: Currency symbol of transaction

:; date - ''string''
:: Date of transaction

:; productSpecification - ''link''
:: URL link to the product specification

:; serviceNumber - ''string''
:: Service number info

:; type - ''string''
:: Type of transaction. Possible values are: 'charge', 'charge_back', 'payment', 'fee', 'refund', 'credit', 'cc_chargeback', 'charge_adjustment', 'discount', 'credit_adjustment', 'credit_proration', 'charge_proration', 'payment_adjustment', 'tax', 'cc_chargeback_reversal', 'usage_charge', 'write_off', 'undo_write_off', 'usage_discount'

:; number - ''int''
:: Transaction's number

:; links - ''list''
:: [[Hypermedia]] for the individual payment method

; links - ''list''
: [[Hypermedia]] for this resource. Links to self

== Examples ==

=== GET sorted by amount value transaction list call ===
'''Request'''

<nowiki>
GET {{APIBaseURL}}/accounts/test731993/transactions?sortField=amount&sortOrder=asc
</nowiki>

'''Response'''
'''HTTP/1.1 200 OK'''
<nowiki>
{
"list" : [
{
"startDate": "2012-04-23",
"amount": 0.87,
"endDate": "2012-05-18",
"description": "Recurring fee Exchange 2010 Archiving, core.email.exchange2010.archiving 04/23/2012 through 05/18/2012",
"currency": "USD",
"date": "2012-04-23",
"productSpecification": "{{APIBaseURL}}/productSpecifications/test731993-00000137a32daee9e2b08715000a30fe33d32c",
"serviceNumber": "test731993-00000136dedf26dfd9ec22fd000a1ddba01da1",
"type": "payment",
"number": 101393524
},
{
"startDate": "2013-05-04",
"amount": 1.89,
"endDate": "2013-06-18",
"description": "Payment - Notes: - Reference: VUGTI5F6NL0IRJSA17OR CC# 1111 (ProcessSOPayment)",
"currency": "USD",
"date": "2013-05-04",
"productSpecification": "{{APIBaseURL}}/productSpecifications/test731993-00000737a32daee9e2b08715000a30fe13d32f",
"serviceNumber": "test731993-00000136dedf26dfd9ec22fd000a1ddba02da2",
"type": "payment",
"number": 101395701
}],
"links" : [
{
"href" : "{{APIBaseURL}}/accounts/test731993/transactions?sortField=amount&sortOrder=asc,
"rel" : "self"
}]
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

Accounts-accountId-transactionsInfo-sorted:GET - Revision history

Mike.robski: 1 revision: Release 93

Angel.dinev: /* Examples */