Changed on

This API allows for the manual addition or deduction of points for a customer in Gameball. It provides flexibility in managing loyalty points, enabling adjustments based on specific needs or circumstances.

post/api/v4.0/integrations/transactions/manual

Request

  • Base URL: https://api.gameball.co
  • URL: https://api.gameball.co/api/v4.0/integrations/transactions/manual
  • Auth: API key in header apikey and API key in header secretkey

Request body

customerIdstring required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

emailstring

Customer's email address. This is required if your account uses email-based channel merging.

mobilestring

Customer's mobile number. This is required if your account uses mobile-based channel merging.

transactionIdstring required

A unique identifier for a transaction in your system (e.g., order number or invoice number). This ID can be used to reverse, cancel, or refund any reward or redemption transactions in Gameball.

transactionTimestring date-time

The time of the transaction in your system (e.g., order datetime, invoice datetime). Must be in UTC (ISO 8601 format). Defaults to the current time in UTC when omitted.

usernamestring required

The username of the admin performing the manual transaction.

reasonstring required

Reason for manually rewarding or deducting points (e.g., 'Referral bonus').

pointsinteger

The number of points to be rewarded or deducted. Provide either points or amount. Positive values add points, and negative values deduct points.

amountnumber

The monetary value, in system currency, associated with the transaction. Provide either points or amount. Positive values add points, and negative values deduct points.

expiryAfterinteger nullable

The number of days after which the points added in this transaction will expire, counted from the time of the addition. For example, 30 means the awarded points expire 30 days from now. When omitted, null, or 0, the points follow the client's default points-expiry setting configured in the dashboard. This replicates the custom-expiry option available when manually adding points from the Gameball dashboard. expiryAfter applies only to point additions; it cannot be used when deducting points.

Example request

{
  "customerId": "cust_abc12345xyz67890",
  "email": "john.doe@example.com",
  "mobile": "+1234567890",
  "transactionId": "txn543211",
  "transactionTime": "2024-10-11T15:54:10.944Z",
  "username": "admin_user",
  "reason": "Referral bonus",
  "points": 50,
  "expiryAfter": 30
}

Response

Manual transaction added successfully

customerIdstring

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

gameballTransactionIdnumber

The unique identifier for the transaction within Gameball.

transactionIdstring

A unique identifier for a transaction in your system (e.g., order number or invoice number). This ID can be used to reverse, cancel, or refund any reward or redemption transactions in Gameball.

pointsnumber

The number of points rewarded or deducted in the transaction.

amountnumber

The monetary value processed in the transaction.

Example response

{
  "customerId": "cust_abc12345xyz67890",
  "gameballTransactionId": 11035201,
  "transactionId": "txn54321221",
  "points": 50,
  "amount": 5
}

Changes

  • 7e222ea67994Revision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the non-success response with the status

  • 262228c13429Revision changes
    • info

      the endpoint scheme security apiKey AND secretKey was added to the API

    • info

      the endpoint scheme security apiKey was removed from the API

    • info

      the endpoint scheme security secretKey was removed from the API