REST API Documentation
/nexus/transactions
Get list of transactions
For requests using an OAuth Access Token for a particular member, only the members own transactions will be included
Parameters
Name | Type | Description |
---|---|---|
customers
|
string | Comma-delimited list of customer IDs - if provided, only transactions from those customers are returned. Ignored for requests using an OAuth Access Token for a particular member |
statuses
|
string | Comma-delimited list of statuses - if provided, only transactions with those statuses are returned - see transaction object for status keys |
gateways
|
string | Comma-delimited list of gateway IDs - if provided, only transactions from those gateways are returned |
sortBy
|
string | What to sort by. Can be 'date', 'amount' or do not specify for ID |
sortDir
|
string | Sort direction. Can be 'asc' or 'desc' - defaults to 'asc' |
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
This endpoint doesn't throw any exceptions.
Response
Name | Type | Description |
---|---|---|
page
|
int | The page number for the results being shown |
perPage
|
int | The number of results that will be on each page |
totalResults
|
int | The total number of results |
totalPages
|
int | The number of pages of results |
results
|
array of transaction objects | The results for this page |
transaction
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
status
|
string | Status: 'okay' = Paid; 'pend' = Pending, waiting for gateway; 'wait' = Pending, manual approval required; 'hold' = Held for manual approval; 'revw' = Flagged for review; 'fail' = Failed; 'rfnd' = Refunded; 'prfd' = Partially refunded |
invoiceId
|
int | Invoice ID Number |
amount
|
money object | Amount |
refundAmount
|
money object | If partially refunded, the amount that has been refunded |
credit
|
money object | If credited, the amount that has been credited |
gateway
|
gateway object | The gateway |
gatewayId
|
string | Any ID number provided by the gateway to identify the transaction on their end |
date
|
datetime | Date |
customer
|
customer object | Customer |
money
object
Name | Type | Description |
---|---|---|
currency
|
string | The currency code (e.g. 'USD') |
amount
|
string | The amount |
customer
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Username |
title
|
string | Member title |
timezone
|
string | Member timezone |
formattedName
|
string | Username with group formatting |
primaryGroup
|
group object | Primary group |
secondaryGroups
|
array of group objects | Secondary groups |
email
|
string | Email address |
joined
|
datetime | Registration date |
registrationIpAddress
|
string | IP address when registered |
warningPoints
|
int | Number of active warning points |
reputationPoints
|
int | Number of reputation points |
photoUrl
|
string | URL to photo (which will be the site's default if they haven't set one) |
photoUrlIsDefault
|
bool | Indicates if the value of photoUrl is the site's default |
coverPhotoUrl
|
string | URL to profile cover photo (will be blank if there isn't one) |
profileUrl
|
string|null | URL to profile |
validating
|
bool | Whether or not the validating flag is set on the member account |
posts
|
int | Number of content item submissions member has made |
lastActivity
|
datetime|null | Last activity date on the site. |
lastVisit
|
datetime|null | Last distinct visit date on the site. |
lastPost
|
datetime|null | Latest content submission date. |
profileViews
|
int | Number of times member's profile has been viewed |
birthday
|
string | Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied). |
customFields
|
array of fieldgroup objects | Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included |
rank
|
array of rank objects | Rank |
achievements_points
|
int | Points |
allowAdminEmails
|
bool | Whether or not this member wants to receive admin emails |
completed
|
bool | Whether or not the registration is completed |