အော်ဒါဆိုင်ရာ API လမ်းကြောင်းများ

အော်ဒါဖန်တီးရာတွင် ကိုယ်တိုင်ထုတ်ထားသော UUID ကို အသုံးပြုပါ။ ထို UUID သည် idempotency key ဖြစ်ပြီး တူညီသော UUID ဖြင့် ထပ်ပို့ပါက ငွေနှစ်ကြိမ်မဖြတ်ဘဲ မူလအော်ဒါကိုသာ ပြန်ပေးပါသည်။ ထို့နောက် အခြေအနေကို အော်ဒါတစ်ခုချင်း၊ တစ်ကြိမ်လျှင် အများဆုံး 50 ခုပါသော batch သို့မဟုတ် စာမျက်နှာခွဲထားသော စာရင်းဖြင့် ပြန်ဖတ်နိုင်သည်။

POST

/orders/create

အော်ဒါ တင်ခြင်း

အော်ဒါအသစ် တင်ပါ။ idempotency အတွက် order_id တွင် မထပ်သော UUID တစ်ခု ထည့်ရပါမည်။ Wallet မှ ငွေကို ချက်ချင်း နုတ်ယူပါမည်။

တောင်းဆိုနှုန်း ကန့်သတ်ချက်အကောင့်တစ်ခုလျှင် 5000 req / 60s

မှတ်ချက်: order_id သည် idempotency key ဖြစ်ပါသည်။ UUID တူတူဖြင့် ထပ်ပို့ပါက အော်ဒါအသစ် ထပ်မဖန်တီးဘဲ ရှိပြီးသား အော်ဒါကို ပြန်ပေးပါမည်။

တောင်းဆိုမှုတွင် ပို့ရမည့် ဒေတာ

အမည်အမျိုးအစားလိုအပ်ဖော်ပြချက်ဥပမာ
order_idstring (UUID)ဟုတ်ဤအော်ဒါအတွက် မထပ်သော UUID တစ်ခု (v1, v4, v7 စသည်ဖြင့် မည်သည့်ပုံစံမဆို ရပါသည်)။ ၎င်းကို idempotency key အဖြစ် အသုံးပြုပါသည်။01912345-6789-7abc-8def-0123456789ab
sub_category_idnumberဟုတ်ပစ္စည်း၏ အမျိုးအစားခွဲ ID။999
quantitynumberဟုတ်မှာယူမည့် ယူနစ် အရေအတွက် (အပေါင်းကိန်းပြည့်)။1
requirementsobjectဟုတ်ပေးပို့ရမည့် ကစားသူ၏ အချက်အလက်။ “အမျိုးအစား လိုအပ်ချက်များ ရယူခြင်း” endpoint မှ ပြန်ပေးသော field အားလုံးကို ထည့်ပါ။{"player_id": "123456789", "server": "Asia"}
expected_unit_pricestringမဟုတ်ဈေးနှုန်း ကာကွယ်ချက်။ လက်ရှိဈေးနှုန်းသည် ဤတန်ဖိုးထက် ကျော်လွန်ပါက အော်ဒါကို ငြင်းပယ်ပါမည်။0.950000
တောင်းဆိုမှု
curl -s -X POST "https://shop2topup.com/api/endpoints/v1/orders/create" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "01912345-6789-7abc-8def-0123456789ab",
  "sub_category_id": 999,
  "quantity": 1,
  "requirements": {
    "player_id": "123456789",
    "server": "Asia"
  },
  "expected_unit_price": 0.95
}'
တုံ့ပြန်မှု နမူနာ
{
  "success": true,
  "order": {
    "order_id": "01912345-6789-7abc-8def-0123456789ab",
    "status": "pending",
    "player_id": "123456789",
    "player_name": "ProGamer99",
    "subcategory_name": "FF 100 Diamonds",
    "quantity": 1,
    "charged_amount": "0.950000",
    "currency": "USD",
    "created_at": "2024-06-15T12:00:00Z"
  }
}
GET

/orders/:orderId

အော်ဒါ အခြေအနေ ရယူခြင်း

အော်ဒါတစ်ခု၏ လက်ရှိ အခြေအနေနှင့် အသေးစိတ်ကို ရယူပါ။

တောင်းဆိုနှုန်း ကန့်သတ်ချက်အကောင့်နှင့် အော်ဒါ (order_id) တစ်တွဲလျှင် 60 စက္ကန့်အတွင်း တောင်းဆိုမှု 3 ကြိမ်

မှတ်ချက်: အော်ဒါ အခြေအနေသည် pending (စောင့်ဆိုင်းဆဲ)၊ completed (ပြီးစီးပြီ)၊ refunded (ငွေပြန်အမ်းပြီး) သို့မဟုတ် partial (ယူနစ်အချို့ ပေးပို့ပြီး ကျန်ယူနစ်များကို ငွေပြန်အမ်းထားသည်) အနက် တစ်ခုခု ဖြစ်ပါသည်။ ယူနစ်တစ်ခုစီ၏ sub_transactions[].status တွင်မူ partial မပါဘဲ ကျန်ရှိသော အခြေအနေ သုံးမျိုးသာ ရှိပါသည်။ ပေးပို့ပြီးခြင်း သို့မဟုတ် ငွေပြန်အမ်းခြင်း မဖြစ်မချင်း ယူနစ်သည် pending ဖြစ်နေပါမည်။ အော်ဒါအတွင်းရှိ sub_transactions[].id သည် ယူနစ်၏ အစဉ်နံပါတ် (1…n) ဖြစ်ပြီး ဒေတာဘေ့စ်ရှိ ID မဟုတ်ပါ။ retry_count နှင့် max_retries တို့ ပါလာပါက အသုံးမပြုတော့ရန် သတ်မှတ်ထားပြီး အမြဲတမ်း 0 ဖြစ်ပါသည်။

လမ်းကြောင်း (path) ပါရာမီတာများ

အမည်အမျိုးအစားလိုအပ်ဖော်ပြချက်ဥပမာ
orderIdstring (UUID)ဟုတ်ရှာဖွေမည့် အော်ဒါ ID။01912345-6789-7abc-8def-0123456789ab
တောင်းဆိုမှု
curl -s "https://shop2topup.com/api/endpoints/v1/orders/01912345-6789-7abc-8def-0123456789ab" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
တုံ့ပြန်မှု နမူနာ
{
  "success": true,
  "order": {
    "order_id": "01912345-6789-7abc-8def-0123456789ab",
    "status": "completed",
    "player_id": "123456789",
    "player_name": "ProGamer99",
    "subcategory_name": "FF 100 Diamonds",
    "quantity": 1,
    "charged_amount": "0.950000",
    "currency": "USD",
    "created_at": "2024-06-15T12:00:00Z",
    "completed_at": "2024-06-15T12:00:05Z",
    "vouchers": [],
    "sub_transactions": [
      {
        "id": 1,
        "status": "completed",
        "player_id": "123456789",
        "player_name": "ProGamer99",
        "amount": "0.950000",
        "created_at": "2024-06-15T12:00:00Z",
        "completed_at": "2024-06-15T12:00:05Z"
      }
    ]
  }
}
POST

/orders/batch

အော်ဒါများကို အစုလိုက် ရယူ

အော်ဒါ ID များဖြင့် အော်ဒါအများအပြားကို တစ်ကြိမ်တည်း ရယူနိုင်သည်။ Request တစ်ခုလျှင် အော်ဒါ ID အများဆုံး 50 ခု ပို့နိုင်သည်။

တောင်းဆိုနှုန်း ကန့်သတ်ချက်အကောင့်တစ်ခုလျှင် 60 စက္ကန့်တွင် request 2 ကြိမ်

တောင်းဆိုမှုတွင် ပို့ရမည့် ဒေတာ

အမည်အမျိုးအစားလိုအပ်ဖော်ပြချက်ဥပမာ
order_idsstring[]ဟုတ်အော်ဒါ UUID များပါသော စာရင်း (အများဆုံး 50 ခု)။["uuid-1", "uuid-2"]
တောင်းဆိုမှု
curl -s -X POST "https://shop2topup.com/api/endpoints/v1/orders/batch" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "order_ids": [
    "uuid-1",
    "uuid-2"
  ]
}'
တုံ့ပြန်မှု နမူနာ
{
  "success": true,
  "orders": [
    {
      "order_id": "01912345-6789-7abc-8def-0123456789ab",
      "status": "completed",
      "charged_amount": "0.950000"
    }
  ],
  "not_found": [
    "uuid-that-does-not-exist"
  ]
}
GET

/orders

အော်ဒါစာရင်း

အော်ဒါများကို စာမျက်နှာခွဲ၍ စာရင်းပြသည်။ လိုအပ်ပါက status နှင့် ရက်စွဲအပိုင်းအခြားဖြင့် စစ်ထုတ်နိုင်သည်။

တောင်းဆိုနှုန်း ကန့်သတ်ချက်အကောင့်တစ်ခုလျှင် 60 စက္ကန့်တွင် request 2 ကြိမ်

မေးမြန်းချက် (query) ပါရာမီတာများ

အမည်အမျိုးအစားလိုအပ်ဖော်ပြချက်ဥပမာ
pagenumberမဟုတ်စာမျက်နှာ နံပါတ် (မူလ: 1)။1
limitnumberမဟုတ်စာမျက်နှာတစ်ခုလျှင် ပြမည့် ရလဒ်အရေအတွက်၊ 1-100 (မူလ: 50)။50
statusstringမဟုတ်အော်ဒါ အခြေအနေအလိုက် စစ်ထုတ်ရန်: pending (စောင့်ဆိုင်းဆဲ)၊ completed (ပြီးစီးပြီ)၊ refunded (ငွေပြန်အမ်းပြီး)၊ partial (တစ်စိတ်တစ်ပိုင်း)။completed
created_afterstring (ISO 8601)မဟုတ်ဤရက်စွဲနောက်ပိုင်း ပြုလုပ်ခဲ့သော အော်ဒါများကိုသာ ပြရန်။2024-01-01T00:00:00Z
created_beforestring (ISO 8601)မဟုတ်ဤရက်စွဲမတိုင်မီ ပြုလုပ်ခဲ့သော အော်ဒါများကိုသာ ပြရန်။2024-12-31T23:59:59Z
တောင်းဆိုမှု
curl -s "https://shop2topup.com/api/endpoints/v1/orders?page=1&limit=50&status=completed&created_after=2024-01-01T00:00:00Z&created_before=2024-12-31T23:59:59Z" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
တုံ့ပြန်မှု နမူနာ
{
  "success": true,
  "orders": [
    {
      "order_id": "01912345-6789-7abc-8def-0123456789ab",
      "status": "completed",
      "subcategory_name": "FF 100 Diamonds",
      "quantity": 1,
      "charged_amount": "0.950000",
      "created_at": "2024-06-15T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "total_pages": 1
  }
}

ဤစာမျက်နှာမှ တကယ့် တောင်းဆိုမှု ပို့ကြည့်ပါ

ဤလမ်းကြောင်းများကို တိုက်ရိုက်ခေါ်ဆို စမ်းသပ်ရန် API Key ကို ကူးထည့်ပါ။ ထည့်လိုက်သော Key ကို ယခုဖွင့်ထားသော browser tab ထဲတွင်သာ သိမ်းထားပြီး API ထံသို့သာ ပို့ပါသည်။

Enter your API key to use the interactive playground. Get your API key

ခေါ်ဆိုမည့် API လမ်းကြောင်း ရွေးပါ

1
2
Order Details

Enter your API key above to try this endpoint.

ပလက်ဖောင်းကို စတင်အသုံးပြုသူ ဖြစ်ပါက Reseller များအတွက် ဂိမ်း Top Up API အကျဉ်းချုပ်၊ သို့မဟုတ် SHOP2TOPUP Reseller အစီအစဉ် အကျဉ်းချုပ် ကို ဖတ်၍ ပါတနာအကောင့် မည်သို့ အလုပ်လုပ်သည်ကို လေ့လာပါ။

အော်ဒါ API လမ်းညွှန်: အော်ဒါ ဖန်တီးခြင်း၊ ရယူခြင်း၊ Batch နှင့် စာရင်း