REST API Documentation
/nexus/withdrawals/{id}
Get information about a specific withdrawal request
Parameters
No parameters are accepted for this endpoint.
Exceptions
Code | Message | Description |
---|---|---|
2X307/1 |
INVALID_ID |
The withdrawal ID does not exist or the authorized user does not have permission to view it |
Response
Name | Type | Description |
---|---|---|
id
|
int | ID number |
status
|
string | Status: 'done' = Payment sent; 'pend' = Pending; 'canc' = Canceled |
amount
|
money object | Amount |
gateway
|
string | The gateway that will process the withdrawal |
data
|
string | The data provided by the member for the process. For example, if the gateway is PayPal, this will be their PayPal email address |
requestedDate
|
datetime | Date withdrawal was requested |
completedDate
|
datetime | Date withdrawal was completed |
gatewayId
|
string | Any ID number provided by the gateway to identify the transaction on their end |
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 |