GunBroker.com REST API
DevKey: darkkermit    

/PaymentLog GET

Returns payment log information for a seller's orders as a List Response.

URL
/PaymentLog
Verb
Get

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string YES The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the query string of the request.

Parameter Data Type Valid Values Description
BuyerUserName string string UserName of the Buyer on the Order
Cleared boolean true/false Returns only Cleared payment log transactions if set to true
OrderID integer positive # ID belonging to the order
Sort integer 0 - DateTime

1 - Amount 		The field to sort on. Default = 0 - DateTime
SortOrder integer 0 - Ascending

1 - Descending 		Sort direction. Default = 1 - Descending
TimeFrame integer 1 - CreatedLast24

2 - CreatedLast48

3 - CreatedLastWeek

4 - CreatedLast2Weeks

5 - CreatedLast30Days

6 - CreatedLast60Days

7 - CreatedLast90Days 		Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 5 - CreatedLast30Days.

Optional PagingParameters

Output

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
Amount decimal positive # The amount of the transation in the payment log
Buyer User Summary User Summary The Buyer of the order
Cleared boolean true/false Indicates if the transaction in the payment log was cleared
DateTime DateTime Valid ISO 8601 DateTime format The datetime (in UTC) when the transaction occurred
FinancingProvider integer 0 - None, 1 - Gearfire Capital For financed payments, this is the financing provider.
OrderID integer positive # ID belonging to the order in the payment log
PaymentLogID integer positive # The id of the payment log
ResponseCode string string The response code for the payment log
TransactionID string string The transaction ID of the payment log