diff --git a/docs/gen/redoc.v1.html b/docs/gen/redoc.v1.html index 6c6f1ea..0ce1423 100644 --- a/docs/gen/redoc.v1.html +++ b/docs/gen/redoc.v1.html @@ -421,8 +421,10 @@ ">

Player management endpoints

Get player by ID

Retrieves an existing player by ID. Returns player information including profile data and in-game currency balance.

-
Authorizations:
hmac
query Parameters
playerId
required
string
Authorizations:
hmac
query Parameters
playerId
required
string

The player ID to retrieve

+
environment
string
Default: "PAYMENT_ENVIRONMENT_UNSPECIFIED"
Enum: "PAYMENT_ENVIRONMENT_UNSPECIFIED" "PAYMENT_ENVIRONMENT_TEST" "PAYMENT_ENVIRONMENT_PRODUCTION"

Payment environment for the request

Responses

language
string

Optional language code filter using ISO 639-1 code (e.g., 'en', 'es', 'fr', 'de')

-
playerId
string
playerId
string

Optional player ID filter to get player-specific catalog items

+
environment
string
Default: "PAYMENT_ENVIRONMENT_UNSPECIFIED"
Enum: "PAYMENT_ENVIRONMENT_UNSPECIFIED" "PAYMENT_ENVIRONMENT_TEST" "PAYMENT_ENVIRONMENT_PRODUCTION"

Payment environment for the request

Responses

language
string

Optional language code filter using ISO 639-1 code (e.g., 'en', 'es', 'fr', 'de')

-
playerId
string
playerId
string

Optional player ID filter to get player-specific catalog items

+
environment
string
Default: "PAYMENT_ENVIRONMENT_UNSPECIFIED"
Enum: "PAYMENT_ENVIRONMENT_UNSPECIFIED" "PAYMENT_ENVIRONMENT_TEST" "PAYMENT_ENVIRONMENT_PRODUCTION"

Payment environment for the request

Responses

checkoutLinkId
string

Optional checkout link identifier if purchase was made through a checkout link

+
environment
string
Default: "PAYMENT_ENVIRONMENT_UNSPECIFIED"
Enum: "PAYMENT_ENVIRONMENT_UNSPECIFIED" "PAYMENT_ENVIRONMENT_TEST" "PAYMENT_ENVIRONMENT_PRODUCTION"

Payment environment for the request

required
Array of objects (Canceled Item)

List of items in this canceled purchase

Responses

Request samples

Content type
application/json
{
  • "playerId": "string",
  • "transactionId": "string",
  • "checkoutLinkId": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "PURCHASE_CANCELLATION_STATUS_UNSPECIFIED",
  • "message": "string"
}

Confirm payment completion

Request samples

Content type
application/json
{
  • "playerId": "string",
  • "transactionId": "string",
  • "checkoutLinkId": "string",
  • "environment": "PAYMENT_ENVIRONMENT_UNSPECIFIED",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "PURCHASE_CANCELLATION_STATUS_UNSPECIFIED",
  • "message": "string"
}

Confirm payment completion

Step 2A: Confirms and completes a pending purchase that was previously registered. IMPORTANT: Expects HTTP error status (3xx, 4xx, 5xx) codes for failed purchases.

Authorizations:
hmac
Request Body schema: application/json
required

Request to confirm and complete a pending purchase that was previously registered.

@@ -501,6 +509,8 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Transaction identifier to confirm

checkoutLinkId
string

Optional checkout link identifier if purchase was made through a checkout link

+
environment
string
Default: "PAYMENT_ENVIRONMENT_UNSPECIFIED"
Enum: "PAYMENT_ENVIRONMENT_UNSPECIFIED" "PAYMENT_ENVIRONMENT_TEST" "PAYMENT_ENVIRONMENT_PRODUCTION"

Payment environment for the request

currency
required
string

Currency code (ISO-4217 code, e.g., 'USD', 'EUR')

tax
required
integer <int64>

A successful response.

Request samples

Content type
application/json
{
  • "playerId": "string",
  • "transactionId": "string",
  • "checkoutLinkId": "string",
  • "currency": "string",
  • "tax": 0,
  • "total": 0,
  • "timeMillis": "string",
  • "paymentMethodType": "PAYMENT_METHOD_TYPE_UNSPECIFIED",
  • "items": [
    ],
  • "platform": "PURCHASE_PLATFORM_UNSPECIFIED",
  • "browser": "string",
  • "deviceId": "string",
  • "source": "PURCHASE_SOURCE_UNSPECIFIED",
  • "ipAddress": "string",
  • "region": "string",
  • "emailMarketingOptIn": true,
  • "extraInGameCurrency": 0,
  • "extraLoyaltyPoints": 0,
  • "extraLoyaltyCredits": 0,
  • "bonusItems": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Register payment intent

Request samples

Content type
application/json
{
  • "playerId": "string",
  • "transactionId": "string",
  • "checkoutLinkId": "string",
  • "environment": "PAYMENT_ENVIRONMENT_UNSPECIFIED",
  • "currency": "string",
  • "tax": 0,
  • "total": 0,
  • "timeMillis": "string",
  • "paymentMethodType": "PAYMENT_METHOD_TYPE_UNSPECIFIED",
  • "items": [
    ],
  • "platform": "PURCHASE_PLATFORM_UNSPECIFIED",
  • "browser": "string",
  • "deviceId": "string",
  • "source": "PURCHASE_SOURCE_UNSPECIFIED",
  • "ipAddress": "string",
  • "region": "string",
  • "emailMarketingOptIn": true,
  • "extraInGameCurrency": 0,
  • "extraLoyaltyPoints": 0,
  • "extraLoyaltyCredits": 0,
  • "bonusItems": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Register payment intent

Step 1: Registers a purchase intent with the game backend. The game backend is expected to reserve inventory for the purchase. IMPORTANT: Always expects HTTP 200 OK response with inline error codes in the body.

Authorizations:
hmac
Request Body schema: application/json
required

Request to register a purchase intent with the game backend, at which point the game backend is expected to reserve the inventory for the purchase.

@@ -556,6 +566,8 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">

Unique transaction identifier for this purchase session

checkoutLinkId
string

Optional checkout link identifier if purchase was made through a checkout link

+
environment
string
Default: "PAYMENT_ENVIRONMENT_UNSPECIFIED"
Enum: "PAYMENT_ENVIRONMENT_UNSPECIFIED" "PAYMENT_ENVIRONMENT_TEST" "PAYMENT_ENVIRONMENT_PRODUCTION"

Payment environment for the request

currency
required
string

Currency code (ISO-4217 code, e.g., 'USD', 'EUR')

required
Array of objects (Purchase Registration)

A successful response.

Request samples

Content type
application/json
{
  • "playerId": "string",
  • "transactionId": "string",
  • "checkoutLinkId": "string",
  • "currency": "string",
  • "registrations": [
    ],
  • "platform": "PURCHASE_PLATFORM_UNSPECIFIED",
  • "browser": "string",
  • "deviceId": "string",
  • "source": "PURCHASE_SOURCE_UNSPECIFIED",
  • "ipAddress": "string",
  • "region": "string"
}

Response samples

Content type
application/json
{
  • "statuses": [
    ]
}
+

Request samples

Content type
application/json
{
  • "playerId": "string",
  • "transactionId": "string",
  • "checkoutLinkId": "string",
  • "environment": "PAYMENT_ENVIRONMENT_UNSPECIFIED",
  • "currency": "string",
  • "registrations": [
    ],
  • "platform": "PURCHASE_PLATFORM_UNSPECIFIED",
  • "browser": "string",
  • "deviceId": "string",
  • "source": "PURCHASE_SOURCE_UNSPECIFIED",
  • "ipAddress": "string",
  • "region": "string"
}

Response samples

Content type
application/json
{
  • "statuses": [
    ]
}