Skip to content

List every transaction (attribution) for a creator group, with cursor pagination by default. If more than one member filter is passed (playerId, memberId, providerId, code), only one is used, in that priority order. Filtering by code with the default codeScope=member returns every transaction for the member that code currently resolves to, even ones attributed under a different one of that member’s codes; codeScope=code narrows results to that exact code string.

Pagination is cursor-based unless you pass page, which switches to offset pagination and disables the cursor. A corrupted or hand-edited cursor fails with 400 InvalidCursor. pageSize is capped at 1000 in both pagination modes.

An invalid codeScope, status, origin, sort, date, cursor, or groupId all fail with 400 and a machine-readable code field; branch on that field, not on message.

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.

X-SHARED-SECRET
required
stringheader

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

groupId
string
Example
V1StGXR8_Z5jdHi6B1LiO

Creator group to retrieve transactions for. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.

pageSize
integer format: int32
default: 500 >= 1 <= 1000
Example
100

Maximum number of records to return. Defaults to 500 and is capped at 1000 in both cursor and offset pagination modes.

cursor
string

Cursor for the page of transactions to be returned.

page
integer format: int32
>= 1 <= 9999
Example
1

Page of records to return. Not recommended: passing this disables cursor pagination for the request.

startDate
string format: date-time
Example
2026-06-23T15:00:00Z

Start of the date range to filter transactions by.

endDate
string format: date-time
Example
2026-07-23T15:00:00Z

End of the date range to filter transactions by.

origin
string
Allowed values: api webshopCode storefrontCode

Origin(s) to include.

Example
origin=api&origin=webshopCode or origin=api,webshopCode
status
string
Allowed values: normal refund fraud chargeback test
Example
normal

Transaction status(es) to include, comma-separated or repeated. Matched case-insensitively.

code
string
Example
popcornfrog

Filter transactions by the creator code they were attributed to.

codeScope
string
Allowed values: member code
Example
member

member (default) returns all of that member’s transactions across every code they have; code restricts to the exact code string.

memberId
string
Example
CsRKC8uD0NLtyQ0LOt8Ru

Filter by the member’s Nexus id.

playerId
string
Example
player_8f2c41d0

Filter by your internal player/user ID for this member (their externalRef).

providerId
string

Filter a member with a specific OAUTH provider ID, such as twitch or youtube

sort
string

Property and sort direction. Format: { property }:{ asc or desc }. Valid properties: transactionDate.

Example
sort=transactionDate:desc

Returns all transactions with the given transactionId

Media typeapplication/json
Array<object>
object
transaction
object
id

Nexus-generated id for this attribution record, not your own transactionId.

string
code
required

The creator code this transaction should be attributed to. The member must have an approved membership in the target group.

string
memberPlayerId

Your identifier for the creator this transaction was attributed to, from their group membership, not the purchasing player.

string
description
required
string
status

Initial transaction status. Only Normal or Test is honored on creation; any other value (or omitting this) is stored as Normal.

string
Allowed values: Normal Fraud Refund Chargeback
subtotal
required

Purchase subtotal, in the smallest denomination of currency (e.g. cents for USD). Must be a whole number of at least 1, once validated; by default that is also what you send.

number format: cents
currency
required
string
Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTC BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VEF VND VUV WST XAF XAG XAU XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL
total

Total charged, in the smallest denomination of totalCurrency. Defaults to subtotal if omitted.

number format: cents
totalCurrency

Currency for total. Defaults to currency if omitted.

string
Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTC BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VEF VND VUV WST XAF XAG XAU XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL
transactionId
required

Your own idempotency key for this purchase. Reusing one already saved for your publisher account returns a bare 409 with only the default status text, no JSON payload. Reusing one within the same request array is allowed and is how you split one purchase’s credit across multiple members.

string
transactionDate
required
string format: date-time
platform
string
Allowed values: PC PlayStation Xbox Switch Apple Android VR
playerId
string
playerName
string
metrics

Metrics are optional but will allow Nexus to provide useful statistics about your program

object
joinDate

The date that the player joined your game

string format: date-time
conversion

Conversion metrics are used for calculationg the conversion rate of your customers. Only one of lastPurchaseDate or totalSpendToDate are required. lastPurchaseDate is preferred, but totalSpendToDate can be used if not available

object
lastPurchase
object
date
string format: date-time
platform

The platform where the last purchase was made

string
totalSpendToDate
object
total
required
number
currency
required
string
Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTC BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VEF VND VUV WST XAF XAG XAU XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL
memberShareAmount

The amount that the member received for this transaction. This will not be specified upon initial transaction creation, as the calculation happens in a separate process.

number
memberSharePercent

The percent of the subtotal for this transaction that the member received. if a memberSharePercent is provided upon transaction creation, it will always be used. Otherwise, the percent a member receives will be influenced by factors such as the default group setting, member tier, scheduled revenue shares, spcific skus

number
>= 1 <= 100
memberPaid
boolean
skuId

Your internal ID for the item that was purchased

string

Not found

GET
/attributions/transactions
curl --request GET \
--url 'https://api.nexus.gg/v1/attributions/transactions?groupId=V1StGXR8_Z5jdHi6B1LiO&pageSize=500&page=1&startDate=2026-06-23T15%3A00%3A00Z&endDate=2026-07-23T15%3A00%3A00Z&origin=origin%3Dapi%26origin%3DwebshopCode%20or%20origin%3Dapi%2CwebshopCode&status=normal&code=popcornfrog&codeScope=member&memberId=CsRKC8uD0NLtyQ0LOt8Ru&playerId=player_8f2c41d0&sort=sort%3DtransactionDate%3Adesc' \
--header 'X-SHARED-SECRET: nexus_sk_your_key_here'
Example
[
{
"transaction": {
"id": "2ixlNNFdJh-9scoXek80w",
"code": "popcornfrog",
"memberPlayerId": "player_8f2c41d0",
"description": "1000 gems",
"status": "Normal",
"subtotal": 999,
"currency": "AED",
"total": 999,
"totalCurrency": "AED",
"transactionId": "txn_8f2c41d0",
"transactionDate": "2026-03-13T17:32:28Z",
"platform": "PC",
"playerId": "12345",
"playerName": "shadowstrike99",
"metrics": {
"joinDate": "2026-03-13T17:32:28Z",
"conversion": {
"lastPurchase": {
"date": "2026-03-13T17:32:28Z",
"platform": "Android"
},
"totalSpendToDate": {
"total": 129.99,
"currency": "AED"
}
}
},
"memberShareAmount": 1,
"memberSharePercent": 10,
"memberPaid": false,
"skuId": "Hv98bvRCSm1jDDPhls1qC"
}
}
]