Gameball Developers Guide
v3.0
v3.0
  • Introduction
  • What's New in V3.0
  • Installing Gameball
    • Web
      • Show Gameball Customer Widget
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • iOS
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • React Native
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
      • Migration from v1 to v2
    • Flutter
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Go-Live Checklist
    • Generic Mobile App
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
    • Retail & Modern POS
      • Initialize Gameball Customer Profile
      • Track Orders & Cashback Reward
      • Track Refunds
      • Enable Redemption
        • Prepare POS for Redemption
        • Using Virtual ID
          • Using Virtual Card
  • REST API
    • Overview
      • Server-Side SDKs
    • Authentication
    • API Reference
      • Customer
      • Event
      • Transactions
      • Order
      • Coupons
      • Leaderboard 👑
      • Notifications 👑
      • Configurations 👑
      • Batches 👑
        • Batch Operations Data
      • OTP
      • Partner 🤝
        • Client 🤝
        • Redemption Rule 🤝
        • Cashback Rule 🤝
    • Webhooks
      • Notifications Webhook
      • Customer Profile Webhook
    • Errors
    • Object Reference
  • Tutorials
    • Build Custom UI Elements 👑
      • Display Reward Campaign Progress
      • Show VIP Tiers
      • Show Customer Points Balance
      • Build Leaderboards
      • Show Notifications Inbox
      • Adapt UI to Configurations
      • Advanced UI Techniques
        • Increase Sales with Cashback UI Elements
        • Derive Engagement with Rewards Campaigns UI Elements
    • Tracking Customer Events
    • Build your Own Notification System
    • Checkout Integration Example
    • Redemption Integration Options
      • Redeem with coupon system
        • Integrate your coupon system
          • Example using e-commerce platform(WooCommerce)
          • Example using a custom coupon system
        • Build couponing experience
          • Using Gameball widget
          • Build custom experience
            • Showing customers available points
            • Allowing customers to create coupons
            • Apply the discount code to your cart
        • Coupon integration reference
      • Redeem with direct debt
        • Get customers points balance
        • Redeem customer points
  • Third Party Integrations
    • Segment Integration
Powered by GitBook
On this page
  • HTTP Status Codes
  • Error Object
  • Example
  • Error Codes
  1. REST API

Errors

This section shows all Gameball common error codes and how to resolve them.

PreviousCustomer Profile WebhookNextObject Reference

Last updated 1 year ago

HTTP Status Codes

Gameball uses to indicate the success or failure of your API requests. If your request fails, Gameball returns an error using the appropriate status code.

  • 2XX codes indicate success and that the request worked as intended

  • 4XX codes indicate errors due to some mistakes in the request.

  • 5XX codes indicate an error with Gameball's servers.

Error Object

When an error occurs and the response code is 4XX, Gameball's servers send an Error Object that has two parameters, codeand message.

Example

{
    "code": 15,
    "message": "Name Already Exists"
}

Error Codes

Gameball sends an error code in the body of the response, each code has a corresponding error message that is descriptive of what went wrong, below are the codes along with their description.

Code

Message

Description

3

Not Found

Rewards Campaign is not found

4

Missing Arguments

  • Missing parameter in the argument

  • Username is required for manual rewarding

  • Reason is required for manual rewarding

5

Null Arguments

The format is invalid or not compatible

7

Invalid Value

  • Value is in the wrong format, for example negative value for a payment

  • No VIP tier order was found matching the provided value

10

Forbidden

The body hash for client registration is not valid

11

Hash Invalid

Hashed calculated is invalid or created in a wrong way

12

Name Length Invalid

The provided name does not meet the required character limit

13

Something Wrong

An unexpected error occurred while processing your request.

14

Name Already Exists

The name provided is already registered in our system

15

Email Already Exists

The email address provided is already registered in our system.

16

Inactive

Inactive element like a customer or program that are inactive

17

Invalid Leveling Method

Different leveling method required to perform VIP tier update

50

Gameball Is Disabled

Gameball is disabled

51

Cashback Is Disabled

Cashback points program is disabled

101

Customer External ID Not Found

Customer does not exist

102

Customer Already Exists

The customer you are trying to create already exists

151

Referral Customer Referred Already

Customer already exists and can not be referred

152

Referral Code Not Found

Referral code is wrong or nonexistent

301

Transaction Type Non Reversible

This transaction can not be canceled or reversed

302

Transaction Already Canceled

The transaction has already been canceled

303

Transaction Not Found

Transaction ID doesn't exist

304

Transaction Time Already Exists

A transaction was already done during the same exact time

305

Transaction ID Already Exists

Transaction ID must be unique, this ID already exists

306

Transaction Reversed ID Not Found

Reversed Transaction ID doesn't exist

307

Transaction Hold Reference Not Found

Transaction Hold Reference no longer exists. It is either wrong or it's been deleted after the 10-minute hold

308

Invalid Transaction Time

Invalid Transaction Date. An order for the same Transaction Date has already been placed within the same second.

351

Event Not Found

This event is not configured in the dashboard

The table covers all used errors and their description. If you get any error that is not listed above, please us to add it.

HTTP response status codes
email