Skip to content

Applies action and/or a replacement playerId to every attribution row that shares the given transactionId for your publisher account, using the same lookup as getAttribution.

Rows are checked and saved one at a time. If a row’s linked payment transaction has already been paid out (it has a Trolley payment or batch id), processing stops at that row and the request returns 409 without applying that row’s update. A 409 can come back after earlier rows in the same set have already been updated, so treat the set as partially applied and re-read it before retrying.

For Chargeback, Fraud, or Refund, a refund record is appended to the payment transaction; Fraud additionally flags that transaction as fraud. The request body only accepts action and playerId; any other property is rejected.

If nothing matches the transactionId, this returns 404.

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.

transactionId
required
string
Example
txn_8f2c41d0

Your own transactionId, exactly as sent when the transaction was created.

groupId
string

Creator group.

Media typeapplication/x-www-form-urlencoded
object
action

New transaction status. Chargeback, Fraud, and Refund also append a refund record to the underlying payment transaction; Fraud additionally flags it as fraud.

string
Allowed values: Refund Fraud Chargeback
Example
Refund
playerId

Overwrites the transaction’s playerId directly. Not validated against any existing player record.

string
Example
player_8f2c41d0

Returns the transactions that were updated

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

Bad input parameter

PATCH
/attributions/transactions/{transactionId}
curl --request PATCH \
--url https://api.nexus.gg/v1/attributions/transactions/txn_8f2c41d0 \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-SHARED-SECRET: nexus_sk_your_key_here' \
--data action=Refund \
--data playerId=player_8f2c41d0
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"
}
}
]