PaymentNotification

POST 
payment_notification

PaymentNotification

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

Transaction 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

Transaction 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 identification of the gamer within the game

payment_order_id string

non-empty

payment order id

server_id string

non-empty

The number of the game server

order_status enum

[UNDEFINED, Created, Paid, Finished, Refunded]

order status

order_items

object[]

>= 1

order_items

Array [

product_id string

non-empty

Unique identification of the item within Midasbuy

game_product_id string

non-empty

Unique identification of the item within game

quantity string

Value must match regular expression ^\d+$

quantity

product_type enum

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

product type

price

object

currency string

The ISO-4217 currency codes.：https://en.wikipedia.org/wiki/ISO_4217#Active_codes

amount string

Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Amount, in units of the currency. For different currencies, we have restrictions on the number of decimal places for the amount. For example: for currencies like JPY, it's usually not a fraction, but an integer, like 100. For currencies like TND, it's subdivided into thousandths, so it's a decimal fraction, like 100.123. For the number of decimal places required for each currency code, please refer to the currency code.

]

total_price

object

currency string

The ISO-4217 currency codes.：https://en.wikipedia.org/wiki/ISO_4217#Active_codes

amount string

Value must match regular expression ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$

Amount, in units of the currency. For different currencies, we have restrictions on the number of decimal places for the amount. For example: for currencies like JPY, it's usually not a fraction, but an integer, like 100. For currencies like TND, it's subdivided into thousandths, so it's a decimal fraction, like 100.123. For the number of decimal places required for each currency code, please refer to the currency code.

shop_region string

non-empty

shop region

payment_channel string

non-empty

payment channel

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

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": "PAYMENT_ORDER_STATUS_UPDATE",
  "event_version": "v1",
  "resource_type": "RESOURCE_TYPE_ORDER",
  "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",
    "payment_order_id": "SG2024113000900",
    "server_id": "1",
    "order_status": "Finished",
    "order_items": [
      {
        "product_id": "com.games.abc.sku1",
        "game_product_id": "com.games.abc.sku1",
        "quantity": "1",
        "product_type": "VIRTUAL_GOOD",
        "price": {
          "currency": "USD",
          "amount": "100.123"
        }
      }
    ],
    "total_price": {
      "currency": "USD",
      "amount": "100.123"
    },
    "shop_region": "US",
    "payment_channel": "CREDIT_CARD"
  }
}

ResponseClear

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