PromotionNotification

POST 
promotion_notification

PromotionNotification

Request

application/json

Body

required

id string

non-empty

Unique ID of the webhook

create_time string

Notification creation time, format example: 2021-11-08T05:45:20Z

update_time string

Update time, format example: 2021-11-08T05:45:20Z

event_type string

event_type

event_version string

event version

resource_type string

resource_type

resource_version string

resource version，currenct version：v1

summary string

Callback summary information

resource

object

app_id string

non-empty

Application ID, assigned by MidasBuy

create_time string

non-empty

Promotion occurrence time, following the ISO 8601 standard for date and time representation format, for example: 2006-01-02T15:04:05Z07:00

update_time string

non-empty

Promotion last update time, following the ISO 8601 standard for date and time representation format, for example: 2006-01-02T15:04:05Z07:00

user_id string

non-empty

Unique identifier of the game player within the game

server_id string

non-empty

The number of the game server

promotion_order_id string

non-empty

Midasbuy promotion order number, globally unique

payment_order_id string

Payment order number associated with the promotion

promotion_items

object[]

>= 1

product list

Array [

promotion_id string

non-empty

promotion id

model_id string

non-empty

promotion model id

product_id string

non-empty

product id

game_product_id string

non-empty

game product id

quantity string

Value must match regular expression ^\d+$

game product quantity

product_type enum

[UNDEFINED, VIRTUAL_CURRENCY, VIRTUAL_ITEM, SUBSCRIPTION, REDEEM_CODE, POINTS, GROWTH_VALUE]

product type

]

Responses

200

OK

application/json

Response

Response

processed boolean
message string

Example

{
  "processed": true,
  "message": "string"
}

default

Error response structure

application/json

Response

Response

name string
message string

details

object[]

Array [

@type string

The type of the serialized message.

]

debug_id string

causes

object[]

Array [

cause string

solution string

]

Example

{
  "name": "string",
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ],
  "debug_id": "string",
  "causes": [
    {
      "cause": "string",
      "solution": "string"
    }
  ]
}

• curl
• go
• python
• csharp
• nodejs
• php
• java

• CURL

curl -L '' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "id": "2021110805452010020000",
  "create_time": "2021-11-08T05:45:20Z",
  "update_time": "2021-11-08T05:45:20Z",
  "event_type": "PROMOTION_ORDER_FINISHED",
  "event_version": "v1",
  "resource_type": "RESOURCE_TYPE_PROMOTION",
  "resource_version": "v1",
  "summary": "extent info",
  "resource": {
    "app_id": "1450015065",
    "create_time": "2021-11-08T05:45:20Z",
    "update_time": "2021-11-08T05:45:20Z",
    "user_id": "12345678",
    "server_id": "1",
    "promotion_order_id": "SG2024113000900_EXdgdg",
    "payment_order_id": "SG2024113000900",
    "promotion_items": [
      {
        "promotion_id": "Activity_1728531062_YDWLUC",
        "model_id": "23ggn9U0vwtZKK",
        "product_id": "com.games.abc.sku1",
        "game_product_id": "com.games.abc.sku1",
        "quantity": "1",
        "product_type": "VIRTUAL_CURRENCY"
      }
    ]
  }
}'

Request Collapse all

Webhook URLrequired

Method

GETPOSTPUTPATCHDELETE

Body required

{
  "id": "2021110805452010020000",
  "create_time": "2021-11-08T05:45:20Z",
  "update_time": "2021-11-08T05:45:20Z",
  "event_type": "PROMOTION_ORDER_FINISHED",
  "event_version": "v1",
  "resource_type": "RESOURCE_TYPE_PROMOTION",
  "resource_version": "v1",
  "summary": "extent info",
  "resource": {
    "app_id": "1450015065",
    "create_time": "2021-11-08T05:45:20Z",
    "update_time": "2021-11-08T05:45:20Z",
    "user_id": "12345678",
    "server_id": "1",
    "promotion_order_id": "SG2024113000900_EXdgdg",
    "payment_order_id": "SG2024113000900",
    "promotion_items": [
      {
        "promotion_id": "Activity_1728531062_YDWLUC",
        "model_id": "23ggn9U0vwtZKK",
        "product_id": "com.games.abc.sku1",
        "game_product_id": "com.games.abc.sku1",
        "quantity": "1",
        "product_type": "VIRTUAL_CURRENCY"
      }
    ]
  }
}

ResponseClear

Click the Send API Request button above and see the response here!