Complete reward

Marks an external bounty reward as fulfilled once you’ve delivered it outside Nexus, for example an in-game item or a code you generated yourself. Only rewards of type External can be completed this way. Payment and Sku rewards are fulfilled automatically as part of bounty progress processing, with no call to this endpoint, and requesting one here returns the same 404 Bounty Reward not found as an unknown rewardId.

Completion is idempotent: once a reward’s rewardCompleted is true, calling this again does not update the stored rewardReferenceId, even if you send a different value.

Authorizations

X-SHARED-SECRET

required

stringheader

Parameters

Path Parameters

rewardId

required

string

Example

2ixlNNFdJh-9scoXek80w

The bounty progress reward’s id, from a getBountyRewards or getAllBountyRewards response, or a bounty-reward webhook payload.

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Creator group to use for this operation. 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.

Request Body

application-x-www-form-urlencoded

object

referenceId

An optional reference of your own, for example a support ticket or fulfillment id. It’s stored on the reward and included in this endpoint’s response and in the reward-listing endpoints (getBountyRewards, getAllBountyRewards).

string

Example

ticket-48213

Responses

200

Bounty Reward marked completed

application/json

object

The bounty progress reward’s id.

string

name

The bounty reward’s name.

string

externalId

Your own catalog id for this reward.

string

rewardCompleted

Whether this reward has been completed. Becomes true the first time this endpoint successfully completes it, and does not change on later calls.

boolean

rewardReferenceId

The referenceId from the first completion call. Not changed by a later call to this endpoint.

string

404

Bounty Reward not found

application/json

object

code

CodeNotInGroup: Creator group is private, and specified code is not linked to it
InvalidGroup: No creator group was found with the specified groupId
InvalidAuthCode: AuthCode provided is not valid
ExpiredAuthCode: AuchCode provided has expired
ReferralNexusNotFound: No Nexus was found to match the provided referral code
BountyNotFound: No bounty was found with the specified bountyId
CreatorNotFound: No creator found with the specified creatorId
InvalidEventCode: No event found with the specifed event code

string

Allowed values: InvalidGroup CodeNotInGroup InvalidAuthCode ExpiredAuthCode ReferralNexusNotFound BountyNotFound MemberNotFound InvalidEventCode UnknownError

message

string

POST

/complete-reward/{rewardId}

const url = 'https://api.nexus.gg/v1/bounties/complete-reward/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO';
const options = {
  method: 'POST',
  headers: {
    'X-SHARED-SECRET': 'nexus_sk_your_key_here',
    'Content-Type': 'application-x-www-form-urlencoded'
  },
  body: '{ "referenceId": "ticket-48213" }'
};

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

curl --request POST \
  --url 'https://api.nexus.gg/v1/bounties/complete-reward/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'Content-Type: application-x-www-form-urlencoded' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here' \
  --data '{ "referenceId": "ticket-48213" }'

Example

{
  "id": "2ixlNNFdJh-9scoXek80w",
  "name": "In-Game Title",
  "externalId": "reward_mvp_title",
  "rewardCompleted": true,
  "rewardReferenceId": "ticket-48213"
}

Example

{
  "code": "InvalidGroup",
  "message": "Bounty Not found"
}