Member transactions

Returns one page of a single group member’s transactions, matched by their code (case-insensitive) or their Nexus id passed as memberSlugOrID. A member who has never had a code generated or linked cannot be found through this route, even by a correct id, because the lookup requires at least one linked code to exist; it returns 404, the same as for an unknown member.

This route applies no default sort order when sort is omitted. When sort=transactionDate is passed without an explicit direction, it defaults to ascending.

NOTE: This method uses secret (nexus_sk_...) API keys and should never be called from or embedded into the gaming client. These routes should ONLY be accessed from your back-end services.

Authorizations

X-SHARED-SECRET

required

stringheader

Send your secret API key (nexus_sk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

Parameters

Path Parameters

memberSlugOrID

required

string

Example

popcornfrog

The member’s code (matched case-insensitively) or their Nexus id. A member with no linked code returns 404 even by a correct id.

Query Parameters

page

integer format: int32

>= 1 <= 9999

Example

Page of records to return. Defaults to 1.

pageSize

integer format: int32

>= 1 <= 100

Example

Maximum number of records to return. Defaults to 100.

sort

string

Property and sort direction. If omitted, results are returned in unspecified order; if a direction is omitted, ascending is used.

Example

sort=transactionDate:desc

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Group to retrieve transactions for. If your API key is scoped to a single attribution group, that group is always used regardless of this value. If omitted and your key is not group-scoped, the publisher must have a default attribution group (a request without one returns 400); that group confirms the member is discoverable, and the response includes the member’s transactions across every attribution group they belong to.

Responses

200

Results matching criteria

application/json

object

string

name

string

nexusUrl

Url of this creators nexus. Ie, https://nexus.gg/{nexusUrl}

string

code

Creator’s support-a-creator code

string

profileImage

string

currentPage

integer format: int32

currentPageSize

integer format: int32

transactions

Array<object>

object

Nexus’s generated id for this transaction

string

code

Code provided for this transaction

string

transactionId

TransactionId provided for this transaction

string

transactionDate

string format: date-time

transactionStatus

string

Allowed values: Normal Fraud Refund Chargeback

creatorPaid

Whether the creator has been paid for this transaction

boolean

subtotal

number format: cents

currency

string

total

number format: cents

totalCurrency

string

memberShareAmount

Amount of the transaction that went to the member

number

memberSharePercent

Percent of this transaction subtotal that the member recieved

number

memberShareOverride

MemberSharePercent received on transaction creation.

number

memberShareDetails

object

defaultSharePercent

Default share percent for this group

number

tier

Tier share details

object

name

Name of the tier this member was in when this transaction was processed

string

sharePercent

Share percent for this tier when this transaction was processed

number

sku

Sku share details

object

SkuId included for this transaction

string

sharePercent

Sku share percent at the time this transaction was processed

number

scheduled

object

group

Scheduled revenue share for the group that was active when this transaction was processed

object

sharePercent

number

sku

Sku specific scheduled revenue share for the group that was active when this transaction was processed

Array<object>

object

sharePercent

number

description

string

skuId

string

playerId

string

playerName

string

404

Not found

GET

/attributions/transactions/member/{memberSlugOrID}

const url = 'https://api.nexus.gg/v1/attributions/transactions/member/popcornfrog?page=1&pageSize=100&sort=sort%3DtransactionDate%3Adesc&groupId=V1StGXR8_Z5jdHi6B1LiO';
const options = {method: 'GET', headers: {'X-SHARED-SECRET': 'nexus_sk_your_key_here'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.nexus.gg/v1/attributions/transactions/member/popcornfrog?page=1&pageSize=100&sort=sort%3DtransactionDate%3Adesc&groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here'

Example

{
  "id": "0Con-WN07cuBMdEkr56oo",
  "name": "Dusty's store",
  "nexusUrl": "dusty",
  "code": "dusty",
  "profileImage": "https://cdn.nexus.gg/29/images/profile-image.jpg",
  "currentPage": 1,
  "currentPageSize": 100,
  "transactions": [
    {
      "transactionStatus": "Normal",
      "subtotal": 999,
      "total": 999
    }
  ]
}