Skip to main content
GET
/
api
/
sys
/
resellerpayouts
/
{id}
Get one ResellerPayout
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/resellerpayouts/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "ResellerId": 123,
  "ResellerUserId": 123,
  "ResellerUserFullName": "<string>",
  "ResellerCurrencyId": 123,
  "ResellerCurrencyCode": "<string>",
  "Approved": true,
  "PaidOut": true,
  "PaidOutDate": "<string>",
  "PaidOutReference": "<string>",
  "Amount": 123,
  "ErrorDescription": "<string>",
  "LastPaymentAttempt": "<string>",
  "ResellerInvoiceDataFileName": "<string>",
  "NewResellerInvoiceDataUrl": "<string>",
  "ClearResellerInvoiceDataFile": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A ResellerPayout records a payment made to or received from a reseller partner, tracking payout amounts, dates, and associated invoices.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ResellerPayout-Read role.

​
Path Parameters

​
id
integer
required
The Id of the ResellerPayout record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/resellerpayouts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
ResellerId
integer
ID of the reseller linked to this record.
​
ResellerUserId
integer
ID of the reseller user associated with this record.
​
ResellerUserFullName
string
Display name of the linked reseller user full (read-only).
​
ResellerCurrencyId
integer
ID of the reseller currency associated with this record.
​
ResellerCurrencyCode
string
The reseller currency code value for this reseller payout.
​
Approved
boolean
Whether approved is enabled.
​
PaidOut
boolean
Whether paid out is enabled.
​
PaidOutDate
string
Date/time value for paid out date.
​
PaidOutReference
string
The paid out reference value for this reseller payout.
​
Amount
number
The amount value for this reseller payout.
​
ErrorDescription
string
The error description value for this reseller payout.
​
LastPaymentAttempt
string
Date/time value for last payment attempt.
​
ResellerInvoiceDataFileName
string
Current file name of the reseller invoice data (read-only; upload via the corresponding URL field).
​
NewResellerInvoiceDataUrl
string
URL of a new file to upload as the reseller invoice data.
​
ClearResellerInvoiceDataFile
boolean
Set to true to remove the current reseller invoice data file.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "ResellerId": 0,
  "ResellerUserId": null,
  "ResellerUserFullName": null,
  "ResellerCurrencyId": null,
  "ResellerCurrencyCode": null,
  "Approved": false,
  "PaidOut": false,
  "PaidOutDate": null,
  "PaidOutReference": null,
  "Amount": 0,
  "ErrorDescription": null,
  "LastPaymentAttempt": null,
  "ResellerInvoiceDataFileName": null,
  "NewResellerInvoiceDataUrl": null,
  "ClearResellerInvoiceDataFile": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ResellerPayout Example",
  "LocalizationDetails": null,
  "CustomFields": null
}