ඇණවුම් එන්ඩ්පොයින්ට්

ඇණවුමක් සාදන්නේ ඔබ විසින්ම ජනනය කරන UUID එකකින්. එම UUID එක idempotency key එක ලෙස ක්‍රියා කරයි: එය නැවත යැවුවොත් දෙවරක් මුදල් අය නොකර මුල් ඇණවුමම ලැබේ. ඉන්පසු තත්ත්වය එක් එක් ඇණවුමට වෙන වෙනම, උපරිම 50 බැගින් batch වශයෙන්, හෝ පිටු වලට බෙදූ ලැයිස්තුවක් ලෙස කියවිය හැක.

POST

/orders/create

ඇණවුමක් සාදන්න

නව ඇණවුමක් දමන්න. order_id ලෙස අනන්‍ය UUID එකක් ලබා දීම අනිවාර්යයි; එය idempotency සඳහා යොදා ගැනේ. මුදල වහාම වොලට් එකෙන් අය කෙරේ.

ඉල්ලීම් සීමාවඑක් ගිණුමකට තත්පර 60කට ඉල්ලීම් 5000

සටහන: order_id එක ඔබේ idempotency key එකයි. එකම UUID එකෙන් නැවත උත්සාහ කළහොත් අලුත් අනුපිටපතක් නොසාදා, දැනට ඇති ඇණවුම ලැබේ.

ඉල්ලීමේ body එක

නමවර්ගයඅනිවාර්යදවිස්තරයඋදාහරණය
order_idstring (UUID)ඔව්මෙම ඇණවුම සඳහා අනන්‍ය UUID එකක් (ඕනෑම ආකෘතියක්: v1, v4, v7 ආදිය). idempotency key එක ලෙස භාවිත වේ.01912345-6789-7abc-8def-0123456789ab
sub_category_idnumberඔව්නිෂ්පාදනයේ උප කාණ්ඩ ID එක.999
quantitynumberඔව්ඇණවුම් කරන ඒකක ගණන (ධන පූර්ණ සංඛ්‍යාවක්).1
requirementsobjectඔව්ලබාදීම සඳහා ක්‍රීඩකයාගේ තොරතුරු. “කාණ්ඩයේ අවශ්‍යතා ලබා ගන්න” endpoint එකෙන් ලැබෙන සියලු ක්ෂේත්‍ර ඇතුළත් කරන්න.{"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 හි දැක්වෙන අතර, එය pending, completed හෝ refunded විය හැක. ඒකකයක් ලබාදෙන තුරු හෝ ඒ සඳහා මුදල් ආපසු ගෙවන තුරු එය පොරොත්තුවෙන් පවතී. එක් එක් ඒකකයට ලැබෙන sub_transactions[].id යනු ඇණවුම තුළ එහි අනුපිළිවෙල අංකයයි (1…n), දත්ත ගබඩා හැඳුනුම් අංකයක් නොවේ. 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 භාවිත කර ඇණවුම් කිහිපයක් එකවර ලබාගන්න. එක් ඉල්ලීමකට ඇණවුම් ID උපරිම 50ක් ඇතුළත් කළ හැක.

ඉල්ලීම් සීමාවඑක් ගිණුමකට තත්පර 60කට ඉල්ලීම් 2

ඉල්ලීමේ body එක

නමවර්ගයඅනිවාර්යදවිස්තරයඋදාහරණය
order_idsstring[]ඔව්ඇණවුම් UUID අඩංගු array එකක් (උපරිම 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

ඇණවුම් ලැයිස්තුව

ඔබේ ඇණවුම් පිටුවෙන් පිටුවට ලබාගන්න. අවශ්‍ය නම් තත්ත්වය සහ දින පරාසය අනුව පෙරහන් කළ හැක.

ඉල්ලීම් සීමාවගිණුමකට තත්පර 60කට ඉල්ලීම් 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
  }
}

මෙම පිටුවෙන්ම සැබෑ request එකක් යවන්න

මෙම එන්ඩ්පොයින්ට් සජීවීව ඇමතීමට ඔබේ API key එක මෙහි පේස්ට් කරන්න. යතුර මෙම බ්‍රවුසර් ටැබය තුළ පමණක් රැඳෙන අතර, එය යැවෙන්නේ API එක වෙත පමණි.

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

එන්ඩ්පොයින්ට් එකක් තෝරන්න

1
2
Order Details

Enter your API key above to try this endpoint.

Platform එකට අලුත් නම් මුලින්ම රීසෙලර්ලා සඳහා ගේම් ටොප් අප් API හැඳින්වීම, නැතහොත් SHOP2TOPUP රීසෙලර් වැඩසටහනේ හැඳින්වීම කියවා පාර්ට්නර් ගිණුම ක්‍රියා කරන ආකාරය දැනගන්න.

ඇණවුම් API යොමුව: සෑදීම, ලබාගැනීම, Batch සහ ලැයිස්තුව