ข้อมูลธุรกรรมบัตร Shell B2B Mobility Card API - คู่มือเริ่มต้นอย่างรวดเร็ว
เวอร์ชัน API: 2.3.4 | การยืนยันตัวตน: OAuth 2.0 | สถานะ: การผลิต
ภาพรวม
Shell Card Transaction Data API เป็น API ที่ใช้ REST เป็นพื้นฐาน ซึ่งช่วยให้ผู้พัฒนาสามารถดึงข้อมูลและวิเคราะห์ข้อมูลการทำธุรกรรมจากบัตรเชื้อเพลิง Shell ได้โดยใช้โปรแกรม API ให้การเข้าถึงธุรกรรมที่มีราคา ค่าธรรมเนียม การกำหนดราคาตามปริมาณ กฎโบนัส ข้อยกเว้น และสรุปการใช้งานบัตร
หมายเหตุ: คู่มือนี้ครอบคลุมเฉพาะจุดสิ้นสุดที่ผ่านการตรวจสอบสิทธิ์ OAuth 2.0 เท่านั้น (เส้นทางพื้นฐาน: /transaction-data/v1) จุดสิ้นสุด Basic Auth แบบเก่า (/fleetmanagement/v1/transaction) ไม่รวมอยู่เนื่องจากกำลังถูกยกเลิก
คุณสมบัติหลัก
- ดึงรายละเอียดธุรกรรมที่มีราคา รวมถึงธุรกรรม EV
- เข้าถึงรายละเอียดธุรกรรมเชื้อเพลิงพร้อมรายการขายและค่าธรรมเนียม
- รับข้อมูลสรุปธุรกรรมสำหรับธุรกรรมเชื้อเพลิงและ NFR
- สอบถามเกี่ยวกับราคาตามปริมาณและกฎโบนัส
- ดึงรายการค่าธรรมเนียมและข้อมูลสรุปค่าธรรมเนียม
- เข้าถึงข้อยกเว้นของบัตรและธุรกรรม
- วิเคราะห์การใช้บัตรและข้อมูลการใช้จ่าย
- รองรับการค้นหาข้อมูลธุรกรรมจากผู้ชำระเงินหลายราย
ประกาศสำคัญ - OAuth 2.0
สำคัญ: OAuth 2.0 เป็นวิธีการยืนยันตัวตนมาตรฐานแล้ว
- การผสานรวมใหม่: ใช้ OAuth 2.0 ตั้งแต่เริ่มต้น
- การผสานรวมที่มีอยู่: วางแผนการย้ายไปใช้ OAuth 2.0
- วิธีการแบบเดิม: การยืนยันตัวตนแบบพื้นฐานกำลังถูกยกเลิก
ติดต่อ ฝ่ายเทคนิค Shell สนับสนุนเพื่อให้คุณได้รับข้อมูลประจำตัว OAuth 2.0 ของคุณ (client_id และ client_secret).
การยืนยันตัวตน
OAuth 2.0 (วิธีการยืนยันตัวตนมาตรฐาน)
API ข้อมูลธุรกรรมบัตรเชลล์ใช้ กระบวนการ OAuth 2.0 Client Credentials เพื่อการยืนยันตัวตนที่ปลอดภัย
<คำเตือน: ลูกค้าทุกท่านควรวางแผนที่จะนำ OAuth 2 มาใช้0 การยืนยันตัวตน. นี่คือวิธีการยืนยันตัวตนที่แนะนำและรองรับอนาคตสำหรับ API ข้อมูลการทำธุรกรรม Shell Card. วิธีการยืนยันตัวตนแบบเก่ากำลังถูกยกเลิกการใช้งาน.
กระบวนการ OAuth 2.0
ขั้นตอนที่ 1: ขอโทเค็นการเข้าถึง
ขอโทเค็นการเข้าถึงจากจุดสิ้นสุดของโทเค็น OAuth
ขั้นตอนที่ 2: แลกเปลี่ยนรหัสการอนุญาต
แลกเปลี่ยนรหัสการอนุญาตกับโทเค็นการเข้าถึง
ขั้นตอนที่ 3: ใช้โทเค็นการเข้าถึง
ใช้โทเค็นการเข้าถึงเพื่อเข้าถึงข้อมูล
ขั้นตอนที่ จุด:
POST /oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=your-client-id&client_secret=your-client-secret
ขั้นตอนที่ 2: ใช้ Access Token ในการร้องขอ API
Authorization: Bearer
Content-Type: application/json
การจัดการโทเค็น
แนวทางปฏิบัติที่ดีที่สุดในการจัดการโทเค็น:
- โทเค็นการเข้าถึงมีอายุการใช้งานจำกัด (โดยปกติ 15 นาที)
- ใช้การแคชโทเค็นเพื่อหลีกเลี่ยงการร้องขอโทเค็นที่ไม่จำเป็น
- รีเฟรชโทเค็นก่อนหมดอายุเพื่อให้แน่ใจว่าบริการไม่ถูกขัดจังหวะ
- ห้ามแชร์ client_secret ของคุณหรือฝังไว้ในโค้ดฝั่งไคลเอนต์
OAuth 2.0 กลยุทธ์การนำไปใช้
ทำไมต้องย้ายไปใช้ OAuth 2.0?
ประโยชน์ด้านความปลอดภัย:
- โปรโตคอลการตรวจสอบสิทธิ์ตามมาตรฐานอุตสาหกรรม
- โทเค็นการเข้าถึงที่มีระยะเวลาจำกัดช่วยลดความเสี่ยงด้านความปลอดภัย
- ไม่มีการส่งข้อมูลประจำตัวในการร้องขอแต่ละครั้ง
- รองรับการหมุนเวียนและการเพิกถอนโทเค็นได้ดีขึ้น
- ปรับปรุงความสามารถในการขยายตัวและประสิทธิภาพ
- ความสามารถในการตรวจสอบและตรวจสอบย้อนกลับที่ดีขึ้น
- การจัดการข้อมูลประจำตัวที่ง่ายขึ้น
- การบูรณาการที่ยืดหยุ่นสำหรับอนาคต
- ขอข้อมูลรับรอง OAuth 2.0 จาก ฝ่ายสนับสนุนด้านเทคนิคของ Shell
- ดำเนินการจัดการโทเค็น OAuth ในแอปพลิเคชันของคุณ
- ทดสอบอย่างละเอียด
- ดำเนินการตรวจสอบสิทธิ์แบบขนาน (OAuth + แบบเดิม) ระหว่างการเปลี่ยนผ่าน
- ตรวจสอบและยืนยันการผสานรวม OAuth
- เปลี่ยนไปใช้ OAuth เท่านั้นเมื่อได้รับการยืนยันแล้ว
- ยกเลิกการใช้งาน การตรวจสอบสิทธิ์แบบเดิม หลังการโยกย้ายสำเร็จ
- ติดต่อ ฝ่ายสนับสนุนด้านเทคนิคของ Shell
- ขอข้อมูลรับรอง OAuth 2.0 (client_id และ client_secret)
- ตรวจสอบ ข้อกำหนดในการให้บริการ
ul>
ประโยชน์ด้านการดำเนินงาน:
เส้นทางการย้ายข้อมูล
หากคุณกำลัง โดยใช้วิธีการตรวจสอบสิทธิ์แบบเดิม ให้ทำตามเส้นทางการย้ายข้อมูลนี้:
> ในสภาพแวดล้อม Test/Sandbox
สภาพแวดล้อม
API มีให้บริการในสองสภาพแวดล้อม:
| สภาพแวดล้อม | URL ฐาน | วัตถุประสงค์ |
|---|---|---|
| การผลิต | สภาพแวดล้อมการผลิตจริง | https://api.shell.com |
| การทดสอบ (แซนด์บ็อกซ์) | https://api-test.shell.com/test | สภาพแวดล้อมสำหรับการทดสอบและพัฒนา |
เคล็ดลับ: ควรทดสอบการผสานระบบของคุณใน สภาพแวดล้อมทดสอบ ก่อนที่จะนำไปใช้งานจริงเสมอ
เริ่มต้นอย่างรวดเร็ว
1. รับข้อมูลประจำตัว OAuth ของคุณ
2. รับโทเค็นการเข้าถึง
ขั้นแรก รับโทเค็นการเข้าถึง OAuth ของคุณ:
ตัวอย่าง cURL:
curl -X POST https://api-test.shell.com/test/oauth/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials&client_id=your-client-id&client_secret=your-client-secret"
Response:
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}3. สร้างคำขอ API ครั้งแรกของคุณ
ตัวอย่าง: รับรายการธุรกรรมที่มีราคา
ตัวอย่าง cURL:
curl -X POST https://api-test.shell.com/test/transaction-data/v1/priced \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \
-H "Content-Type: application/json" \
-d '{
"Filters": {
"ColCoCode": "5",
"PayerNumber": "DE26667080",
"InvoiceStatus": "A",
"IncludeFees": true,
"FromDate": "2024-12-01 00:00:00",
"ToDate": "2025-01-20 00:00:00"
},
"Page": 1,
"PageSize": 1
}ตัวอย่างการตอบกลับ:
{
"RequestId": "9d2dee33-7803-485a-a2b1-2c7538e597ee",
"Status": "SUCCESS",
"Data": [
{
"AccountName": "Blue Colour Ltd",
"AccountId": 29484,
"AccountNumber": "DE26667080",
"AccountShortName": "Mathew",
"Additional1": "GBALLEGO0002452",
"Additional2": "GBALLEGO0002452",
"Additional3": "GBALLEGO0002452",
"Additional4": "GBALLEGO0002452",
"AllowClearing": "Null",
"AuthorisationCode": 300796,
"TransactionStatus": "Y",
"DriverName": "SATTY BHAMRA",
"CardExpiryPeriod": 2204,
"CardExpiry": "20220101",
"CardGroupId": 40000,
"CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
"IssuerCode": 7002,
"CardPAN": "7002053465789891000",
"รหัสการปล่อย": 9,
"หมายเลขลำดับบัตร: 617,
"CardType": "GB STD FLT NAT SINGLE R9",
"ColCoCode": "014",
"UnitDiscountInvoiceCurrency": -0.0051,
"ColCoExchangeRate": 0.851858,
"InvoiceCurrencySymbol": "GBP",
"CorrectionFlag": true,
"CRMNumber": 10,
"CustomerCountry": "สหราชอาณาจักร",
"CustomerCurrencyCode": "GBP",
"CustomerCurrencySymbol": "£",
"RebateonNetAmountInCustomerCurrency": 0,
"EffectiveDiscountInCustomerCurrency": -0.22,
"EffectiveUnitDiscountInCustomerCurrency": -0.0051,
"UnitPriceInInvoiceCurrency": 1.1024,
"InvoiceTax": 0,
"InvoiceGrossAmount": 57.25,
"InvoiceNetAmount": 47.71,
"VATonNetAmountInCustomerCurrency": 9.54,
"CustomerRetailPriceUnitGross": 0,
"CustomerRetailValueTotalGross": 57.52,
"CustomerRetailValueTotalNet": 47.93,
"TransactionTypeDescription": 9.59,
"RebateonNetAmountInTransactionCurrency": -0.22,
"EffectiveDiscountInTrxCurrency": -0.22,
"DelCoToColCoExchangeRate": 0,
"Cards": [
275549
],
"UnitDiscountTransactionCurrency": -0.005,
"TransactionGrossAmount": 57.25,
"TransactionNetAmount": 47.71,
"TransactionTax": 9.54,
"VATonNetAmount": 9.54,
"DelcoListPriceUnitNet": 0,
"DelcoRetailPriceUnitGross": 1.32888,
"UnitPriceInTransactionCurrency": 1.1074,
"DelcoRetailPriceUnitNet": 1.1074,
"DelcoRetailValueTotalGross": 57.52,
"DelcoRetailValueTotalNet": 47.93,
"TransactionCurrencySymbol": "$",
"DiscountType": 1,
"DisputeStatus": false,
"IsShellSite": false,
"FleetIdInput": "YG67OUM",
"IncomingProductCode": 23,
"PostingDate": "20210802",
"PostingTime": "14:15:22",
"ProductCode": 30,
"ProductName": "น้ำมันไร้สารตะกั่ว - ออกเทนกลาง",
"ProductGroupId": 22,
"IncomingCurrencyCode": "GBP",
"IncomingSiteDescription": "Shell Broadway Ring",
"Location": "Shell Broadway Ring",
"SiteName": "Shell Broadway Ring",
"SiteCode": 32,
"IncomingSiteNumber": 15,
"InvoiceCurrencyCode": "GBP",
"InvoiceDate": "20210802",
"InvoiceNumber": 3201016193,
"FuelProduct": true,
"VATApplicable": "Y",
"ชื่อผู้ชำระเงิน": "Colours Services Ltd",
"หมายเลขผู้ชำระเงิน": "GB12121212",
"หมายเลขลูกค้าหลัก": "GB12121212",
"PayerGroup": "H312066",
"PayerGroupName": "12162566 - บริการบัตรเติมน้ำมัน",
"CheckDigit": 6,
"NetInvoiceIndicator": "Y",
"DelcoCode": 5,
"NetworkCode": 3,
"PurchasedInCountry": "สหราชอาณาจักร",
"SiteCountry": "สหราชอาณาจักร",
"VATCountry": "สหราชอาณาจักร",
"DelcoName": "Shell U.K. Oil Products Limited",
"Network": "Shell",
"OdometerInput": 0,
"OriginalSalesItemId": "Null",
"FleetIDDescription": "YG67OUM",
"ParentCustomerId": 6494,
"PINIndicator": "Y, N",
"ProductGroupName": "ค่าธรรมเนียม",
"PurchasedInCountryCode": "GB",
"Quantity": 43.28,
"RebateRate": 0.0022,
"ReceiptNumber": 6803,
"RefundFlag": "Y",
"SiteGroupId": 202,
"SiteGroupName": "CZ 9100 ECONOMY NETWORK",
"Latitude": 53.83606,
"ลองจิจูด": -1.61854,
"อัตราแลกเปลี่ยนDelCo": 0.851858,
"จำนวนเงินคืนยูโร": -0.258259,
"สุทธิยูโร"จำนวนเงิน": 56.01,
"EuroVATAmount": 11.2,
"ชื่อลูกค้าหลัก": "FUEL CARD SERVICES LTD",
"IsInvoiced": false,
"TransactionCurrencyCode": "GBP",
"CreditDebitCode": "D หรือ C",
"TransactionDate": "20210801",
"TransactionTime": "12:16:58",
"TransactionItemId": "H305908971030",
"TrnIdentifier": "H305908971030",
"Type": "SALE",
"TransactionLine": 1,
"TransactionType": "Purchase",
"UTCOffset": "Europe/London",
"VATCategory": "United Kingdom Standard VAT Rate",
"VATRate": 0.2,
"VehicleRegistration": "YG67OUM",
"IsCancelled": "Y",
"ColCoGrossAmount": 57.25,
"ColCoNetAmount": 47.71,
"ColCoVATAmount": 9.54,
"OriginalCurrencySymbol": "$",
"OriginalCurrencyCode": "$",
"OriginalVATAmount": 0,
"EmbossText": "PARKLANE PROPERTIES LTD",
"OriginalExchangeRate": 0,
"OriginalTransactionItemInvoiceDate": "20220202",
"FeeTypeId": 1,
"LineItemคำอธิบาย": true,
"FeeRuleDescription": "ค่าธรรมเนียมแบบง่าย",
"Frequency": 1,
"FeeRuleId": 1,
"SystemEntryDate": "20210828",
"SystemEntryTime": "20:21:08",
"IsManual": "Y",
"OriginalTransactionItemId": "Y",
"OriginalTransactionItemInvoiceNumber": 6750802,
"OriginalTransactionItemInvoiceId": 234,
"PayerShortName": "FUEL CARD SERVICES LTD",
"ReverseCharge": "Y",
"OriginalGrossAmount": 57.25,
"OriginalNetAmount": 57.25,
"UnitOfMeasure": "L",
"RoadType": "ถนนสายหลัก",
"CustomerCountryIsoCode": "DE",
"EVOperator": "Shell Recharge",
"EVSerialId": "GBALLEGO0002452",
"EVChargePointSerial": "GBALLEGO0002452",
"EVChargePointConnectorType": 5,
"EVChargePointConnectorTypeDescription": "DC 50 kW",
"EVChargeDuration": "PT3205S",
"EVChargeStartDate": "2021-08-01",
"EVChargeStartTime": "20:08:01",
"EVChargeEndDate": "2022-08-01",
"EVChargeEndTime": "20:08:01",
"HostingCollectingCompanyNumber": 0,
"TransactionId": 0,
"FuelOnly": true,
"EVPrintedNumber": "ZZ2WJ53ZZ5",
"IsRFID": true
}
],
"Page": 1,
"PageSize": 1,
"TotalPages": 5
}จุดสิ้นสุดของ API อ้างอิง
ธุรกรรมที่มีราคา
| จุดสิ้นสุด | วิธีการ | คำอธิบาย |
|---|---|---|
| /transaction-data/v1/priced | POST | รับรายละเอียดธุรกรรมที่มีการกำหนดราคา รวมถึงธุรกรรม EV (OAuth 2.0) |
| /transaction-data/v1/pricedtransaction | POST | รับรายละเอียดธุรกรรมเชื้อเพลิงพร้อมรายการขายและค่าธรรมเนียม (OAuth 2.0) |
| /transaction-data/v1/multipayerspricedtransactions | POST | รับรายละเอียดธุรกรรมที่มีราคาสำหรับผู้ชำระเงินหลายคน (OAuth 2.0) |
กรณีการใช้งานทั่วไป:
- ดึงรายการธุรกรรมตามช่วงวันที่
- กรองตามสถานะธุรกรรม (อนุมัติ, ปฏิเสธ, ฯลฯ)
- ค้นหาโดยหมายเลขบัตร PAN หรือทะเบียนยานพาหนะ
- ดูรายการธุรกรรมชาร์จรถยนต์ไฟฟ้า
li>
สรุปธุรกรรม
| จุดสิ้นสุด | วิธีการ | คำอธิบาย |
|---|---|---|
| /transaction-data/v1/pricedtransactionssummary | POST | รับข้อมูลสรุปธุรกรรมที่มีราคาสำหรับเชื้อเพลิงและ NFR พร้อมรายการขายและค่าธรรมเนียม (OAuth 2.0) |
| /transaction-data/v1/cardusagesummary | POST | รับการวิเคราะห์การใช้จ่ายและสรุปการใช้งานสำหรับบัตร (OAuth 2.0) |
ผลลัพธ์:
- ข้อมูลธุรกรรมรวมตามช่วงเวลา
- ปริมาณและจำนวนเงินรวม
- แยกตามประเภทและหมวดหมู่ของผลิตภัณฑ์
- การวิเคราะห์การใช้จ่ายในระดับบัตร
การจัดการค่าธรรมเนียม
| จุดสิ้นสุด | วิธีการ | คำอธิบาย |
|---|---|---|
| /transaction-data/v1/feessummary | POST | รับข้อมูลสรุปรายการค่าธรรมเนียมสำหรับผู้ชำระเงินที่กำหนด (OAuth 2.0) |
ข้อมูลค่าธรรมเนียม:
- ดึงรายการค่าธรรมเนียมที่นำไปใช้กับธุรกรรม
- สรุปค่าธรรมเนียมทั้งหมดตามช่วงเวลา
- รายละเอียดค่าธรรมเนียม
ตามประเภทและหมวดหมู่
ปริมาณ-กฎตามเงื่อนไข
| จุดสิ้นสุด | วิธีการ | คำอธิบาย |
|---|---|---|
| /transaction-data/v1/volumebasedpricing | POST | ตั้งค่ากฎค่าธรรมเนียมการค้างชำระสำหรับผู้ชำระเงินที่กำหนด (OAuth 2.0) |
| /transaction-data/v1/volumebasedbonus | POST | รับการตั้งค่าโบนัสและกฎการเชื่อมโยงสำหรับผู้ชำระเงินที่กำหนด (OAuth 2.0) |
คุณสมบัติตามปริมาณ:
- เข้าถึงกฎการกำหนดราคาตามปริมาณ
- ดึงกฎการคำนวณโบนัส
- รับการกำหนดค่าโบนัสของสมาคม
- สอบถามโครงสร้างค่าธรรมเนียมที่ค้างชำระ
ข้อยกเว้น
| จุดสิ้นสุด | วิธีการ | คำอธิบาย |
|---|---|---|
| /transaction-data/v1/exceptions | POST | รับข้อยกเว้นที่เกี่ยวข้องกับบัตรหรือธุรกรรม (OAuth 2.0) |
ประเภทของข้อยกเว้น:
- ความล้มเหลวในการตรวจสอบความถูกต้องของธุรกรรม
- การใช้งานบัตรที่ผิดปกติ
- ข้อยกเว้นในการอนุมัติ
- การแจ้งเตือนการละเมิดนโยบาย
li>
กรณีการใช้งานทั่วไป
ส่วนนี้จะเชื่อมโยงสถานการณ์ทางธุรกิจทั่วไปกับจุดสิ้นสุด API ที่เหมาะสมเพื่อช่วยให้คุณระบุได้อย่างรวดเร็วว่าควรใช้ API ใดสำหรับความต้องการเฉพาะของคุณ
กรณีการใช้งานที่ 1: การกระทบยอดธุรกรรมรายวัน
สถานการณ์: คุณจำเป็นต้องกระทบยอดธุรกรรมทั้งหมดจากบัตรยานพาหนะของคุณทุกวันเพื่อวัตถุประสงค์ทางบัญชี
API ที่แนะนำ: /transaction-data/v1/priced
ทำไมถึงเลือก API นี้: จุดสิ้นสุดนี้ให้รายละเอียดการทำธุรกรรมอย่างครบถ้วน รวมถึงการทำธุรกรรมชาร์จ EV รองรับการกรองวันที่ที่ยืดหยุ่น และรวมถึงธุรกรรมที่เรียกเก็บเงินแล้วและที่ยังไม่ได้เรียกเก็บเงิน เหมาะสำหรับการกระทบยอดรายวันพร้อมการรองรับการแบ่งหน้าสำหรับชุดข้อมูลขนาดใหญ่
พารามิเตอร์หลัก:
FromDateและToDate- ตั้งเป็นวันที่เมื่อวานInvoiceStatus- ใช้ "A" สำหรับทุกธุรกรรมPageSize- ตั้งค่าเป็น 100 เพื่อการดึงข้อมูลที่มีประสิทธิภาพ
กรณีการใช้งานที่ 2: การตรวจสอบและยืนยันใบแจ้งหนี้
สถานการณ์: คุณได้รับใบแจ้งหนี้และจำเป็นต้องตรวจสอบรายละเอียดธุรกรรมทั้งหมด รวมถึงค่าธรรมเนียมและค่าใช้จ่ายต่างๆ
คำแนะนำ API: /transaction-data/v1/pricedtransaction
ทำไมถึงเลือก API นี้: ออกแบบมาโดยเฉพาะเพื่อให้ข้อมูลการทำธุรกรรมน้ำมันเชื้อเพลิงอย่างละเอียด รวมถึงรายการขายและค่าธรรมเนียมที่เกี่ยวข้องทั้งหมด เหมาะสำหรับการตรวจสอบใบแจ้งหนี้เนื่องจากตรงกับโครงสร้างของใบแจ้งหนี้
พารามิเตอร์หลัก:
InvoiceNumber- หมายเลขใบแจ้งหนี้ที่ต้องการตรวจสอบInvoiceDate- วันที่ใบแจ้งหนี้จากบิลของคุณIncludeFees- ตั้งค่าเป็น true เพื่อดูรายการค่าธรรมเนียมทั้งหมด
กรณีการใช้งานที่ 3: การวิเคราะห์และรายงานการใช้เชื้อเพลิง
สถานการณ์: คุณจำเป็นต้องวิเคราะห์รูปแบบการใช้เชื้อเพลิงของยานพาหนะทั้งหมดในฝูงของคุณในช่วงเดือนที่ผ่านมา เพื่อเพิ่มประสิทธิภาพเส้นทางและลดต้นทุน
API ที่แนะนำ:
/transaction-data/v1/pricedtransactionssummary- สำหรับข้อมูลรวม
เหตุผลที่เลือกใช้ API เหล่านี้: จุดสิ้นสุดแบบสรุป (Summary endpoints) ให้ข้อมูลรวมตามผลิตภัณฑ์ กลุ่มเว็บไซต์ และช่วงเวลา ทำให้เหมาะอย่างยิ่งสำหรับการวิเคราะห์แนวโน้มโดยไม่ต้องประมวลผลปริมาณธุรกรรมจำนวนมาก
พารามิเตอร์สำคัญ:
FromDateและToDate- ตั้งค่าเป็น 30 วันที่ผ่านมาProductCode- กรองตามประเภทเชื้อเพลิงเฉพาะProductGroupName- จัดกลุ่มตามหมวดหมู่เชื้อเพลิง
กรณีการใช้งานที่ 4: การจัดการหลายกองยาน
สถานการณ์: คุณจัดการบัญชีย่อยหรือผู้ชำระเงินหลายราย และต้องการดึงข้อมูลธุรกรรมจากทุกบัญชีเพื่อรายงานแบบรวม
แนะนำ API: /transaction-data/v1/multipayerspricedtransactions
ทำไมถึงแนะนำ API นี้: ออกแบบมาโดยเฉพาะเพื่อสอบถามธุรกรรมจากผู้ชำระเงินหลายรายในคำขอ API เดียว ช่วยลดจำนวนคำขออย่างมากและปรับปรุงประสิทธิภาพสำหรับสถานการณ์ที่มีหลายกองยาน
พารามิเตอร์หลัก:
บัญชี- อาร์เรย์ของรหัสผู้ชำระเงินและหมายเลข (สูงสุด 10 ราย)สถานะใบแจ้งหนี้- "A" สำหรับธุรกรรมทั้งหมดวันที่เริ่มต้น
และ ToDate - ช่วงเวลาที่รายงาน
กรณีการใช้งานที่ 5: การตรวจสอบข้อยกเว้นและการตรวจจับการทุจริต
สถานการณ์: คุณต้องการระบุรูปแบบการทำธุรกรรมที่ผิดปกติ เช่น ธุรกรรมที่มีมูลค่าสูง ปริมาณเชื้อเพลิงที่มากเกินไป หรือบัตรที่มีการใช้งานผิดปกติเพื่อป้องกันการฉ้อโกงหรือการใช้งานที่ไม่เหมาะสม
API ที่แนะนำ: /transaction-data/v1/exceptions
เหตุผลที่ใช้ API นี้: สร้างขึ้นเพื่อระบุธุรกรรมที่เกินเกณฑ์ที่กำหนด ทำให้ เหมาะสำหรับการติดตามข้อยกเว้นและการฉ้อโกงที่อาจเกิดขึ้น
พารามิเตอร์หลัก:
เงื่อนไข- กำหนดประเภทของเกณฑ์ (ValueGreaterThan, VolumeGreaterThan, เป็นต้น)ค่า- กำหนดค่าเกณฑ์OutputType- "Transaction" สำหรับข้อยกเว้นธุรกรรมTransactionsFromDateและTransactionsToDate- ช่วงเวลาการตรวจสอบ
กรณีการใช้งานที่ 6: การวิเคราะห์ค่าธรรมเนียมและค่าใช้จ่าย
สถานการณ์:
API ที่แนะนำ: /transaction-data/v1/feessummary
ทำไมถึงเลือก API นี้: ให้ข้อมูลค่าธรรมเนียมรวม
ข้อมูลตามประเภทค่าธรรมเนียม กลุ่มผลิตภัณฑ์ และกลุ่มค่าธรรมเนียม ทำให้ง่ายต่อการวิเคราะห์โครงสร้างค่าธรรมเนียมและระบุพื้นที่ที่มีต้นทุนสูง
พารามิเตอร์สำคัญ:
InvoiceStatus- "I" สำหรับค่าธรรมเนียมที่ออกใบแจ้งหนี้เท่านั้นFeeTypeGroup- กรองตาม "ค่าใช้จ่ายบัตร", "ค่าใช้จ่ายบัญชี", ฯลฯFromDateและToDate- ช่วงเวลาการวิเคราะห์
กรณีการใช้งานที่ 7: การติดตามการใช้จ่ายบัตรรายบุคคล
สถานการณ์:
API ที่แนะนำ: /transaction-data/v1/cardusagesummary
เหตุผลที่เลือก API นี้: ให้การวิเคราะห์การใช้จ่ายโดยละเอียดสำหรับบัตรแต่ละใบในช่วง 7 เดือนที่ผ่านมา จัดกลุ่มตามสถานที่และผลิตภัณฑ์ เหมาะสำหรับการรายงานในระดับบัตร
พารามิเตอร์สำคัญ:
CardIdหรือPAN- บัตรเฉพาะที่ต้องการวิเคราะห์CardExpiry- สำหรับการตรวจสอบเพิ่มเติมAccountId- ตัวกรองบัญชี (ไม่บังคับ)
กรณีการใช้งาน 8: การตรวจสอบสิทธิ์การกำหนดราคาตามปริมาณ
สถานการณ์: คุณต้องการตรวจสอบว่าบัญชีของคุณมีสิทธิ์ได้รับอัตราค่าบริการตามปริมาณการใช้งานหรือไม่ และต้องการทราบระดับการใช้งานปัจจุบันของคุณเมื่อเทียบกับเกณฑ์ที่กำหนดไว้
API ที่แนะนำ: /transaction-data/v1/volumebasedpricing
เหตุผลที่เลือกใช้ API นี้: แสดงกฎค่าธรรมเนียมค้างชำระ การกำหนดระดับชั้น และปริมาณการใช้งานปัจจุบันของคุณ ช่วยให้เข้าใจโครงสร้างราคาและวางแผนเพื่อเข้าถึงระดับชั้นที่ดีขึ้น
พารามิเตอร์สำคัญ:
PayerNumber- หมายเลขผู้ชำระเงินของคุณ
บัญชีli>
IncludeHistory - ตั้งค่าเป็น true เพื่อดูการคำนวณย้อนหลังIncludeCurrentPeriodVolume - ตั้งค่าเป็น true สำหรับการแยกย่อยรายเดือนกรณีการใช้งานที่ 9: การติดตามโบนัสและส่วนลด
สถานการณ์: คุณมีข้อตกลงโบนัสตามปริมาณและต้องการติดตามความคืบหน้าของคุณต่อเกณฑ์โบนัสและดูโบนัสที่ได้รับก่อนหน้านี้
API ที่แนะนำ: /transaction-data/v1/volumebasedbonus
ทำไมถึงเลือก API นี้: ให้รายละเอียดครบถ้วนเกี่ยวกับกฎของโบนัส, การบริโภคในช่วงเวลาปัจจุบัน, และการคำนวณโบนัสในอดีต, ช่วยให้คุณสามารถเพิ่มประสิทธิภาพการซื้อเพื่อเพิ่มโบนัสให้สูงสุด.
พารามิเตอร์หลัก:
PayerNumber- บัญชีผู้ชำระเงินของคุณIncludeHistory- ตั้งเป็น true เพื่อดูประวัติการจ่ายโบนัสที่ผ่านมาIncludeCurrentPeriodVolume- ตั้งเป็น สอดคล้องกับสถานะความคืบหน้าของช่วงเวลาปัจจุบัน
ตัวอย่างการใช้งาน
ตัวอย่างที่ 1: รับรายการธุรกรรมที่มีราคา (รวมถึง EV)
คำขอ:
POST /transaction-data/v1/priced
{
"PageSize": 1,
"Page": 1,
"Filters": {
"ColCoCode": "5",
"ColCoId": 5,
"InvoiceStatus": "A",
"PayerNumber": "DE26685263",
"AccountId": 29484,
"AccountNumber": "DE26667080",
"CardPAN": "7002051006629890645",
"FromDate": "2022-01-01 00:00:00",
"ToDate": "2022-01-31 00:00:00",
"IncludeFees": true
}
}Response:
{
"RequestId": "9d2dee33-7803-485a-a2b1-2c7538e597ee",
"Status": "SUCCESS",
"Data": [
{
"AccountName": "Blue Colour Ltd",
"AccountId": 29484,
"AccountNumber": "DE26667080",
"AccountShortName": "Mathew",
"Additional1": "GBALLEGO0002452",
"Additional2": "GBALLEGO0002452",
"Additional3": "GBALLEGO0002452",
"Additional4": "GBALLEGO0002452",
"AllowClearing": "Null",
"AuthorisationCode": 300796,
"TransactionStatus": "Y",
"DriverName": "SATTY BHAMRA",
"CardExpiryPeriod": 2204,
"CardExpiry": "20220101",
"CardGroupId": 40000,
"CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
"IssuerCode": 7002,
"CardPAN": "7002053465789891000",
"ReleaseCode": 9,
"CardSequenceNumber": 617,
"CardType": "GB STD FLT NAT SINGLE R9",
"ColCoCode": "014",
"UnitDiscountInvoiceCurrency": -0.0051,
"ColCoExchangeRate": 0.851858,
"InvoiceCurrencySymbol": "GBP",
"CorrectionFlag": true,
"CRMNumber": 10,
"CustomerCountry": "สหราชอาณาจักร",
"CustomerCurrencyCode": "GBP",
"CustomerCurrencySymbol": "£",
"RebateonNetAmountInCustomerCurrency": 0,
"ส่วนลดที่มีผลในสกุลเงินของลูกค้า": -0.22,
"EffectiveUnitDiscountInCustomerCurrency": -0.0051,
"UnitPriceInInvoiceCurrency": 1.1024,
"InvoiceTax": 0,
"InvoiceGrossAmount": 57.25,
"ยอดเงินในใบแจ้งหนี้": 47.71,
"VATonNetAmountInCustomerCurrency": 9.54,
"CustomerRetailPriceUnitGross": 0,
"CustomerRetailValueTotalGross": 57.52,
"CustomerRetailValueTotalNet": 47.93,
"TransactionTypeDescription": 9.59,
"RebateonNetAmountInTransactionCurrency": -0.22,
"EffectiveDiscountInTrxCurrency": -0.22,
"DelCoToColCoExchangeRate": 0,
"Cards": [
275549
],
"UnitDiscountTransactionCurrency": -0.005,
"TransactionGrossAmount": 57.25,
"TransactionNetAmount": 47.71,
"TransactionTax": 9.54,
"VATonNetAmount": 9.54,
"DelcoListPriceUnitNet": 0,
"DelcoRetailPriceUnitGross": 1.32888,
"UnitPriceInTransactionCurrency": 1.1074,
"DelcoRetailPriceUnitNet": 1.1074,
"DelcoRetailValueTotalGross": 57.52,
"DelcoRetailValueTotalNet": 47.93,
"TransactionCurrencySymbol": "$",
"DiscountType": 1,
"DisputeStatus": false,
"IsShellSite": false,
"FleetIdInput": "YG67OUM",
"IncomingProductCode": 23,
"PostingDate": "20210802",
"เวลาโพสต์": "14:15:22",
"รหัสสินค้า": 30,
"ชื่อสินค้า": "น้ำมันไร้สารตะกั่ว - ออกเทนกลาง",
"ProductGroupId": 22,
"IncomingCurrencyCode": "GBP",
"IncomingSiteDescription": "Shell Broadway Ring",
"Location": "Shell Broadway Ring",
"SiteName": "Shell Broadway Ring",
"SiteCode": 32,
"IncomingSiteNumber": 15,
"InvoiceCurrencyCode": "GBP",
"InvoiceDate": "20210802",
"หมายเลขใบแจ้งหนี้": 3201016193,
"ผลิตภัณฑ์เชื้อเพลิง": true,
"VATApplicable": "Y",
"ชื่อผู้ชำระเงิน": "Colours Services Ltd",
"หมายเลขผู้ชำระเงิน": "GB12121212",
"ParentCustomerNumber": "GB12121212",
"PayerGroup": "H312066",
"PayerGroupName": "12162566 - บริการบัตรเชื้อเพลิง",
"CheckDigit": 6,
"NetInvoiceIndicator": "Y",
"DelcoCode": 5,
"NetworkCode": 3,
"PurchasedInCountry": "สหราชอาณาจักร",
"SiteCountry": "สหราชอาณาจักร",
"VATCountry": "สหราชอาณาจักร",
"DelcoName": "Shell U.K. Oil Products Limited",
"Network": "Shell",
"OdometerInput": 0,
"OriginalSalesItemId": "Null",
"FleetIDDescription": "YG67OUM",
"ParentCustomerId": 6494,
"PINIndicator": "Y, N",
"ProductGroupName": "ค่าธรรมเนียม",
"PurchasedInCountryCode": "GB",
"Quantity": 43.28,
"RebateRate": 0.0022,
"ReceiptNumber": 6803,
"RefundFlag": "Y",
"SiteGroupId": 202,
"SiteGroupName": "CZ 9100 ECONOMY NETWORK",
"ละติจูด": 53.83606,
"ลองจิจูด": -1.61854,
"DelCoExchangeRate": 0.851858,
"EuroRebateAmount": -0.258259,
"NetEuroAmount": 56.01,
"EuroVATAmount": 11.2,
"ParentCustomerName": "FUEL CARD SERVICES LTD",
"IsInvoiced": false,
"TransactionCurrencyCode": "GBP",
"CreditDebitCode": "D หรือ C",
"TransactionDate": "20210801",
"TransactionTime": "12:16:58",
"TransactionItemId": "H305908971030",
"TrnIdentifier": "H305908971030",
"Type": "SALE",
"TransactionLine": 1,
"TransactionType": "Purchase",
"UTCOffset": "Europe/London",
"VATCategory": "อัตราภาษีมูลค่าเพิ่มมาตรฐานของสหราชอาณาจักร",
"VATRate": 0.2,
"VehicleRegistration": "YG67OUM",
"IsCancelled": "Y",
"ColCoGrossAmount": 57.25,
"ColCoNetAmount": 47.71,
"ColCoVATAmount": 9.54,
"OriginalCurrencySymbol": "$",
"OriginalCurrencyCode": "$",
"OriginalVATAmount": 0,
"EmbossText": "PARKLANE PROPERTIES LTD",
"OriginalExchangeRate": 0,
"OriginalTransactionItemInvoiceDate": "20220202",
"FeeTypeId": 1,
"LineItemDescription": true,
"FeeRuleDescription": "ค่าธรรมเนียมแบบง่าย",
"ความถี่": 1,
"รหัสค่าธรรมเนียม": 1,
"วันที่บันทึกในระบบ": "20210828",
"เวลาบันทึกในระบบ": "20:21:08",
"เป็นข้อมูลป้อนด้วยมือ": "Y",
"OriginalTransactionItemId": "Y",
"OriginalTransactionItemInvoiceNumber": 6750802,
"OriginalTransactionItemInvoiceId": 234,
"PayerShortName": "FUEL CARD SERVICES LTD",
"ReverseCharge": "Y",
"OriginalGrossAmount": 57.25,
"จำนวนเงินต้น": 57.25,
"UnitOfMeasure": "L",
"RoadType": "ถนนสายหลัก",
"CustomerCountryIsoCode": "DE",
"EVOperator": "Shell Recharge",
"EVSerialId": "GBALLEGO0002452",
"EVChargePointSerial": "GBALLEGO0002452",
"EVChargePointConnectorType": 5,
"EVChargePointConnectorTypeDescription": "DC 50 kW",
"EVChargeDuration": "PT3205S",
"EVChargeStartDate": "2021-08-01",
"EVChargeStartTime": "20:08:01",
"EVChargeEndDate": "2022-08-01",
"EVChargeEndTime": "20:08:01",
"HostingCollectingCompanyNumber": 0,
"TransactionId": 0,
"FuelOnly": true,
"EVPrintedNumber": "ZZ2WJ53ZZ5",
"IsRFID": true
}
],
"หน้า": 3,
"PageSize": 30,
"TotalPages": 5
}ตัวอย่างที่ 2: รับรายละเอียดธุรกรรมน้ำมัน
คำขอ:
POST /transaction-data/v1/pricedtransaction
{
"Filters": {
"ColCoCode": 14,
"InvoiceStatus": "A",
"PayerId": 12345,
"PayerNumber": "NL10042616"
},
"Page": 1,
"PageSize": 50
}Response:
{
"RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
"Status": "SUCCESS",
"Data": [
{
"Transactions": [
{
"Type": "SalesItem /FeeItem",
"CardId": 0,
"CardPAN": "7002051006629891000",
"CardExpiry": "2026-06-16",
"TransactionDate": "2026-06-16",
"TransactionTime": "string",
"UTCOffset": "string",
"FleetIdInput": "XYZ1234",
"OdometerInput": 12345,
"DriverName": "แอนดรูว์ กิลเบอร์รี",
"ทะเบียนรถ": "MV65YLH",
"รหัสสกุลเงินในใบแจ้งหนี้": "GBP",
"สัญลักษณ์สกุลเงินในใบแจ้งหนี้": "$",
"รหัสสกุลเงินในการทำธุรกรรม": "GBP",
"สัญลักษณ์สกุลเงินในการทำธุรกรรม": "$",
"จำนวนเงินสุทธิในการทำธุรกรรม": 0,
"TransactionTax": 0,
"TransactionGrossAmount": 0,
"InvoiceNetAmount": 0,
"InvoiceTax": 0,
"InvoiceGrossAmount": 0,
"PurchasedInCountry": "Germany",
"AccountId": 29484,
"AccountNumber": "GB99215176",
"AccountName": "MATTHEW ALGIE & COMPANY LIMITED",
"AccountShortName": "string",
"Quantity": 0,
"FuelProduct": true,
"UnitPriceInTransactionCurrency": 0,
"UnitPriceInInvoiceCurrency": 0,
"UnitDiscountTransactionCurrency": 0,
"UnitDiscountInvoiceCurrency": 0,
"IsInvoiced": true,
"InvoiceNumber": "S04500493",
"InvoiceDate": "string",
"SiteCode": "050001 -\tCHARNOCK RICHARD NTHBOUND MWSA 0755",
"SiteName": "050001 -\tCHARNOCK RICHARD NTHBOUND MWSA 0755",
"SiteCountry": "Germany",
"Location": {
"Latitude": "37.4224764",
"ลองจิจูด": "122.0842499"
},
"ชื่อกลุ่มบัตร": "006240 FIRE BRIGHT SOLUTIONS",
"หมายเลขใบเสร็จ": "1234",
"รหัสสินค้า": "10 - ค่าธรรมเนียม TMF",
"ชื่อสินค้า": "ไร้สารตะกั่ว - ออกเทนสูง",
"รหัสกลุ่มสินค้า": 1,
"ProductGroupName": "กลุ่มผลิตภัณฑ์หลัก",
"DelCoExchangeRate": 0,
"ColCoExchangeRate": 0,
"IsShellSite": true,
"Network": "100013\tSTEINDORFER",
"SiteGroupId": 202,
"SiteGroupName": "CZ 9100 ECONOMY NETWORK",
"วันที่โพสต์": "สตริง",
"IssuerCode": "7002",
"PurchasedInCountryCode": "NL",
"CustomerCountryCode": "NL",
"CustomerCountry": "เนเธอร์แลนด์",
"ReleaseCode": "8",
"CardGroupId": "string",
"CardSequenceNumber": "2",
"CheckDigit": "string",
"FleetIDDescription": "string",
"VATRate": "0.20 สำหรับ 20%",
"VATCategory": "1-Zero Rated",
"VATonNetAmount": 0,
"VATCountry": "เนเธอร์แลนด์",
"EffectiveDiscountInTrxCurrency": 0,
"TransactionType": "ซื้อเมื่อมีบัตร, ไม่กรอกเมื่อไม่มีบัตร",
"PINIndicator": ""ใช้รหัส PIN"",
"VATApplicable": "ใช่",
"NetInvoiceIndicator": "ใช่",
"CustomerCurrencyCode": "GBP",
"CustomerCurrencySymbol": "£",
"EffectiveUnitDiscountInCustomerCurrency": 0,
"EffectiveDiscountInCustomerCurrency": 0,
"VATonNetAmountInCustomerCurrency: 0,
"ประเภทส่วนลด": "2-เพนซ์ต่อหน่วย",
"สถานะธุรกรรม": "U",
"รหัสสินค้าขาย": 18315958002,
"กลุ่มผู้ชำระเงิน": "string",
"PayerGroupName": "12119008 - กลุ่มบริษัทเชลล์",
"RefundFlag": "string",
"OriginalSalesItemId": "string",
"DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
"DelcoCode": "14",
"หมายเลขผู้ชำระเงิน": "NL10042616",
"ชื่อผู้ชำระเงิน": "V.M. LE COMTE",
"ระยะเวลาหมดอายุบัตร": "1901",
"รหัสอนุญาต": "1011256",
"TransactionId": "io9KVXk1UkW57XWKyeaHHg",
"TransactionLine": "1",
"AllowClearing": "Y",
"CRMNumber": "string",
"DisputeStatus": "ไม่มีข้อพิพาท",
"RebateRate": 28.279,
"DelCoToColCoExchangeRate": 1,
"NetEuroAmount": 0,
"EuroVATAmount": 0,
"ParentCustomerNumber": "string",
"ParentCustomerName": "string",
"ParentCustomerId": 0,
"IncomingSiteNumber": "100021",
"IncomingSiteDescription": "HN3 INTI_02-82.02",
"IncomingCurrencyCode": "GBP",
"IncomingProductCode": "30",
"CreditDebitCode": "D",
"CorrectionFlag": "Y",
"Additional1": "string",
"Additional2": "string",
"Additional3": "string",
"Additional4": "string",
"RebateonNetAmountInCustomerCurrency": -0.735,
"RebateonNetAmountInTransactionCurrency": "AVEE PTUAZONW CUBFAO COSFS",
"TrnIdentifier": "string",
"CardType": "string",
"DelcoListPriceUnitNet": 30.5,
"DelcoRetailPriceUnitNet": 1.921,
"DelcoRetailPriceUnitGross": 0,
"DelcoRetailValueTotalNet": 0,
"DelcoRetailValueTotalGross": 0,
"CustomerRetailPriceUnitGross": 0,
"CustomerRetailValueTotalNet": 0,
"EVPrintedNumber": "3792",
"IsRFID": true,
"TokenTypeDescription": "string"
}
]
}
],
"Page": 1,
"PageSize": 1,
"TotalPages": 15
}ตัวอย่างที่ 3: รับสรุปธุรกรรมที่มีราคา
คำขอ:
POST /transaction-data/v1/pricedtransactionssummary
{
"Filters": {
"ColCoCode": 9,
"PayerId": 12,
"InvoiceStatus": "A",
"FromDate": "2024-03-20",
"ToDate": "2024-09-17",
"PurchasedInCountryCode": "AT"
}
}Response:
{
"RequestId": "2b0cbe11-f109-4c43-9201-49af0370df1c",
"Status": "SUCCESS",
"Data": [
{
"ProductId": 1234,
"รหัสสินค้า": "10",
"ชื่อสินค้า": "ดีเซล AGO",
"รหัสกลุ่มสินค้า": 1,
"ชื่อกลุ่มสินค้า": "น้ำมันเชื้อเพลิง",
"TotalFuelQuantity": 1250.75,
"TotalNetAmount": 5420.50,
"TotalGrossAmount": 6504.60,
"InvoiceCurrencyCode": "GBP",
"InvoiceCurrencySymbol": "£",
"CustomerRetailValueTotalNet": 5420.50,
"CustomerRetailValueTotalGross": 6504.60
}
]
}ตัวอย่างที่ 4: รับสรุปราคา
คำขอ:
POST /transaction-data/v1/pricedsummary
{
"Filters": {
"ColCoCode": 86,
"PayerNumber": "GB000000123",
"CardId": 275549,
"FromDate": "20240225",
"ToDate": "20240225",
"FuelOnly": false
}
}
Response:
{
"RequestId": "5f1bded6-416d-4478-ab7f-33905d7b5d4b"
"สถานะ": "สำเร็จ",
"ข้อมูล": [
{
"ยอดรวมมูลค่าขายปลีกของลูกค้า": 114.13,
"ยอดรวมมูลค่าขายปลีกสุทธิของลูกค้า": 95.11,
"รหัสสกุลเงินใบแจ้งหนี้": "EUR",
"InvoiceCurrencySymbol": "€",
"ProductCode": "21",
"ProductGroupId": 3,
"ProductGroupName": "น้ำมันเบนซินสำหรับรถยนต์",
"ProductId": 21,
"ProductName": "น้ำมันไร้สารตะกั่ว - ออกเทนสูง",
"SiteGroupId": 104,
"SiteGroupName": "สถานีเชลล์เริ่มต้น ออสเตรีย",
"TotalFuelQuantity": 17.0,
"TotalGrossAmount": 114.13,
"TotalNetAmount": 95.11
}
]
}
ตัวอย่างที่ 5: รับรายการธุรกรรมที่มีราคาสำหรับผู้ชำระเงินหลายคน
คำขอ:
POST /transaction-data/v1/multipayerspricedtransactions
{
"ColCoCode": 86,
"บัญชี": [
{
"ผู้ชำระเงินId": 12345,
"หมายเลขผู้ชำระเงิน": "GB987654322"
},
{
"PayerId": 12346,
"PayerNumber": "GB000000124"
}
],
"InvoiceStatus": "A",
"FromDate": "20220101",
"ToDate": "20220131",
"PageSize": 50,
"Page": 1
}Response:
{
"RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
"สถานะ": "สำเร็จ",
"ข้อมูล": [
{
"รายการธุรกรรม": [
{
"ประเภท": "รายการขาย"
}
],
"หมายเลขบัตร": 275549,
"CardPAN": "7002051006629891000",
"CardExpiry": "20250812",
"TransactionDate": "20250812",
"TransactionTime": "14:30:45",
"UTCOffset": "+01:00:00",
"FleetIdInput": "XYZ1234",
"OdometerInput": 12345,
"DriverName": "แอนดรูว์ กิลเบอร์รี่",
"VehicleRegistration": "MV65YLH",
"InvoiceCurrencyCode": "GBP",
"InvoiceCurrencySymbol": "£",
"TransactionCurrencyCode": "GBP",
"TransactionCurrencySymbol": "£",
"TransactionNetAmount": 47.71,
"TransactionTax": 9.54,
"TransactionGrossAmount": 57.25,
"จำนวนเงินในใบแจ้งหนี้": 47.71,
"ภาษีในใบแจ้งหนี้": 9.54,
"จำนวนเงินรวมในใบแจ้งหนี้": 57.25,
"ซื้อในประเทศ": "เยอรมนี",
"AccountId": 29484,
"AccountNumber": "GB99215176",
"AccountName": "MATTHEW ALGIE & COMPANY LIMITED",
"AccountShortName": "MATTHEW",
"ปริมาณ": 43.28,
"FuelProduct": true,
"UnitPriceInTransactionCurrency": 1.1074,
"UnitPriceInInvoiceCurrency": 1.1024,
"UnitDiscountTransactionCurrency": -0.005,
"UnitDiscountInvoiceCurrency": -0.0051,
"IsInvoiced": true,
"หมายเลขใบแจ้งหนี้": "S04500493",
"วันที่ใบแจ้งหนี้": "20250815 09:30:00",
"รหัสสถานที่": "050001",
"ชื่อสถานที่": "CHARNOCK RICHARD NTHBOUND MWSA 0755",
"SiteCountry": "Germany",
"Location": {
"Latitude": "53.83606",
"Longitude": "-1.61854"
},
"CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
"ReceiptNumber": "6803",
"รหัสสินค้า": "10",
"ชื่อสินค้า": "ไร้สารตะกั่ว - ออกเทนสูง",
"รหัสกลุ่มสินค้า": 2,
"ชื่อกลุ่มสินค้า": "น้ำมันเชื้อเพลิงทุกชนิด",
"DelCoExchangeRate": 0.851858,
"ColCoExchangeRate": 0.851858,
"IsShellSite": true,
"Network": "SHELL",
"SiteGroupId": 202,
"SiteGroupName": "CZ 9100 ECONOMY NETWORK",
"PostingDate": "20250812 14:30:45",
"IssuerCode": "7002",
"PurchasedInCountryCode": "DE",
"CustomerCountryCode": "NL",
"CustomerCountry": "เนเธอร์แลนด์",
"ReleaseCode": "8",
"CardGroupId": "40000",
"CardSequenceNumber": "617",
"CheckDigit": "6",
"FleetIDDescription": "YG67OUM",
"VATRate": 0.2,
"VATCategory": "1-อัตราปกติ",
"VATonNetAmount": 9.54,
"VATCountry": "เนเธอร์แลนด์",
"EffectiveDiscountInTrxCurrency": -0.22,
"TransactionType": "การซื้อ",
"PINIndicator": "ใช้ PIN",
"VATApplicable": "Y",
"NetInvoiceIndicator": "N",
"CustomerCurrencyCode": "GBP",
"CustomerCurrencySymbol": "£",
"EffectiveUnitDiscountInCustomerCurrency": -0.0051,
"EffectiveDiscountInCustomerCurrency": -0.22,
"VATonNetAmountInCustomerCurrency": 9.54,
"DiscountType": "2-เพนซ์ต่อหน่วย",
"TransactionStatus": "I",
"SalesItemId": 18315958002,
"PayerGroup": "H312066",
"PayerGroupName": "12119008 - SHELL GROUP OF COMPANIES",
"RefundFlag": "N",
"OriginalSalesItemId": null,
"DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
"DelcoCode": "014",
"PayerNumber": "GB987654322",
"PayerName": "V.M. LE COMTE",
"CardExpiryPeriod": "2504",
"รหัสอนุญาต": "011256",
"รหัสธุรกรรม": "io9KVXk1UkW57XWKyeaHHg",
"รายการธุรกรรม": "1",
"AllowClearing": "Y",
"CRMNumber": null,
"DisputeStatus": "ไม่มีข้อพิพาท",
"RebateRate": 28.279,
"DelCoToColCoExchangeRate": 1,
"NetEuroAmount": 56.01,
"EuroVATAmount": 11.2,
"ParentCustomerNumber": "GB12121212",
"ParentCustomerName": "FUEL CARD SERVICES LTD",
"ParentCustomerId": 6494,
""หมายเลขสถานที่รับเข้า": "100021",
"คำอธิบายสถานที่รับเข้า": "HN3 INTI_02-82.02",
"รหัสสกุลเงินรับเข้า": "GBP",
"รหัสสินค้าขาเข้า": "30",
"รหัสเครดิตเดบิต": "D",
"สถานะการแก้ไข": "N",
"ข้อมูลเพิ่มเติม 1": "GBALLEGO0002452",
"Additional2": null,
"Additional3": null,
"Additional4": null,
"RebateonNetAmountInCustomerCurrency": -0.735,
"RebateonNetAmountInTransactionCurrency": -0.735,
"TrnIdentifier": "H305908971030",
"CardType": "GB STD FLT NAT SINGLE R9",
"DelcoListPriceUnitNet": 30.5,
"DelcoRetailPriceUnitเน็ต": 1.1074,
"DelcoRetailPriceUnitGross": 1.32888,
"DelcoRetailValueTotalNet": 47.93,
"DelcoRetailValueTotalGross": 57.52,
"CustomerRetailPriceUnitGross": 1.32888,
"CustomerRetailValueTotalNet": 47.93,
"EVPrintedNumber": "3792",
"IsRFID": true,
"TokenTypeDescription": "บัตรยานพาหนะ"
}
],
"Page": 1,
"PageSize": 20,
"TotalPages": 15,
"TotalRecords": 300
}ตัวอย่างที่ 6: รับกฎการกำหนดราคาตามปริมาณ
คำขอ:
POST /transaction-data/v1/volumebasedpricing
{
"ColCoId": 1,
"ColCoCode": 86,
"PayerId": 12345,
"PayerNumber": "GB000000123",
"IncludeHistory": true,
"IncludeCurrentPeriodVolume": true
}คำตอบ:
{
"RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
"สถานะ": "สำเร็จ",
"ข้อมูล": [
{
"การกำหนดค่า": [
{
"รหัสบัญชีราคา": 123456,
"PricingAccountNumber": "GB000000123",
"PricingAccountShortName": "ABCD1234",
"PricingAccountFullName": "ABCD1234",
"FeeRuleId": 12345,
"FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
"FeeRuleDateEffective": "20231223",
"FeeRuleDateTerminated": "20231223",
"BonusPaidTo": "1-จ่ายให้ผู้รับ",
"BonusPaidToAccountId": 123456, "BonusPaidToAccountNumber": "GB000000123", "BonusPaidToAccountShortName": "12345", "BonusPaidToAccountFullName": "GB000000123",
"ความถี่": "3-สัปดาห์ – วันจันทร์",
"วันที่คำนวณครั้งถัดไป": "20231223",
"วันที่คำนวณครั้งก่อน": "20231223",
"FeeRuleBasis": "3-Lump Sum",
"FeeRuleCurrencyCode": "GBP",
"FeeRuleCurrencySymbol": "£",
"FeeRuleAvailableFrom": "20231223",
"FeeRuleAvailableTo": "20231223",
"FeeRuleLocations": [
{
"DelcoId": 866,
"Country": "สหราชอาณาจักร",
"CountryCode": "UK",
"FuelNetworkId": 100007,
"NetworkName": "VALERO",
"SiteGroupId": 100007,
"SiteGroupName": "VALERO ENERGY LTD",
"SiteCode": 999493,
"SiteId": 100007,
"SiteName": "VALERO ENERGY LTD"
}
],
"FeeRuleProducts": [
{
"ProductGroupID": 3,
"ProductGroupName": "น้ำมันเบนซินสำหรับรถยนต์",
"ProductCode": "30 สำหรับดีเซล AGO",
"ProductId": "30 สำหรับ Diesel AGO",
"ProductName": "Diesel AGO"
}
],
"FeeRuleTiers": [
{
"TierMinimum": 1234,
"TierMaximum": 1234,
"Value": 1234.12
}
]
}
],
"CurrentPeriodConsumption": [
{
"FeeRuleId": 12345,
"FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
"PriceRuleID": 100005,
"PriceRuleDescription": "PL/GAGO/GMOT/UL0.055",
"TotalVolume": 10000.78,
"NextFeeCreationDate": "20231223"
}
],
"History": [
{
"FromDate": "20231223",
"ToDate": "20231223",
"FeesRuleID": 8081,
"FeesRuleDescription": "PT/P067/D120/P4.0",
"TotalVolume": 12356.66
}
],
"Warnings": [
{
"ข้อความ": "ระบบกำลังหยุดทำงานเพื่ออัปเกรด",
"ประเภท": "ระบบหยุดทำงาน"
}
]
}
]
}ตัวอย่างที่ 7: รับกฎโบนัสตามปริมาณ
คำขอ:
POST /transaction-data/v1/volumebasedbonus
{
"ColCoId": 1,
"ColCoCode": 86,
"PayerId": 12345,
"PayerNumber": "GB000000123",
"IncludeHistory": true,
"IncludeCurrentPeriodVolume": true
}คำตอบ:
{
"RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
"Status": "SUCCESS",
"Data": [
{
"Configuration": [
{ "PricingAccountId": 123456, "PricingAccountNumber": "GB000000123", "PricingAccountShortName": "MATTHEW", "PricingAccountFullName": "MATTHEW",
"FeeRuleId": 1,
"FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
"FeeRuleDateEffective": "20231223",
"FeeRuleDateTerminated": "20231223",
"BonusPaidTo": "1-Pay to Payer",
"BonusPaidToAccountId": 123456,
"BonusPaidToAccountNumber": "GB000000123",
"BonusPaidToAccountShortName": "12345",
"BonusPaidToAccountFullName": "GB000000123",
"ความถี่": "3 สัปดาห์ – วันจันทร์",
"วันที่คำนวณครั้งถัดไป": "20231223",
"PreviousCalculatedDate": "20231223",
"FeeRuleBasis": "3-Lump Sum",
"FeeRuleCurrencyCode": "GBP",
"FeeRuleCurrencySymbol": "£",
"FeeRuleAvailableFrom": "20231223",
"FeeRuleAvailableTo": "20231223",
"FeeRuleLocations": [
{
"DelcoId": 866,
"Country": "สหราชอาณาจักร",
"CountryCode": "UK"",
"FuelNetworkId": 100007,
"NetworkName": "VALERO",
"SiteGroupId": 100007,
"SiteGroupName": "VALERO ENERGY LTD",
"SiteCode": 999493,
"SiteId": 100007,
"SiteName": "VALERO ENERGY LTD"
}
],
"FeeRuleProducts": [
{
"ProductGroupID": 3,
"ProductGroupName": "น้ำมันเบนซินสำหรับรถยนต์",
"ProductCode": "30 สำหรับดีเซล AGO",
"ProductId": "30 สำหรับดีเซล AGO",
"ProductName": "ดีเซล AGO"
}
],
"FeeRuleTiers": [
{
"TierMinimum": 1234,
"TierMaximum": 1234,
"Value": 1234.12
}
],
"AssociatedAccounts": [
{
"AssociatedAccountId": 12345,
"AssociatedAccountNumber": "GB000000123",
"AssociatedAccountShortName": "ชื่อบัญชีแบบย่อ",
"AssociatedAccountFullName": "ชื่อบัญชีเต็ม"
}
]
}
],
"CurrentPeriodConsumption": [
{
"FeeRuleId": 12345,
"FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
"Month": 1,
"Year": 2018,
"TotalVolume: 10000.78
}
],
"HistoricalBonusPaid": [
{
"PayerId": 12345,
"PayerNumber": "GB000000123",
"ชื่อย่อผู้ชำระเงิน": "Jorden",
"ชื่อเต็มผู้ชำระเงิน": "MATTHEW",
"รหัสบัญชี": 123456,
"AccountNumber": "GB000000123",
"AccountShortName": "SALT",
"AccountFullName": "ABCD1234",
"InvoiceAccountId": 12345,
"หมายเลขบัญชีใบแจ้งหนี้": "GB000000123",
"ชื่อย่อบัญชีใบแจ้งหนี้": "DFE1234",
"ชื่อเต็มบัญชีใบแจ้งหนี้": "AZAD PVT LMT",
"FeeRuleId": 12345,
"FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
"FromDate": "20231223",
"ToDate": "20231223",
"BonusPaidTo": "5-จ่ายให้ลูกค้าที่เกี่ยวข้อง",
"FeeItemId": 12345,
"FeeRuleBasis": "2-เปอร์เซ็นต์ของยอดเพิ่มขึ้น",
"FeeItemCurrencyCode": "GBP",
"FeeItemCurrencySymbol": "$",
"ProratedVolume": 123.12,
"TotalVolume": 123.12,
"FeeProduct": "1562-โบนัสดีเซลเชลล์",
"InvoiceGrossAmount": 123.12,
"InvoiceNetAmount": 123.12,
"InvoiceVATAmount": 123.12,
"IsFeeCancelled": true,
"FeeItemTierProratedVolume": 123.12,
"FeeItemTierTotalVolume": 123.12,
"TierMinimum": 123,
"TierRate": 123.12
}
]
}
],
"คำเตือน": [
{
"ข้อความ": "ระบบกำลังปิดเพื่ออัปเกรด",
"ประเภท": "ระบบหยุดทำงาน"
}
]
}ตัวอย่างที่ 8: รับสรุปค่าธรรมเนียม
คำขอ:
POST /transaction-data/v1/feessummary
{
"ColCoId": 1,
"ColCoCode: 86,
"PayerId": 12345,
"PayerNumber": "GB000000123",
"CardId": 275549,
"InvoiceStatus": "I",
"FromDate": "20240101",
"ToDate": "20240131",
"FeeTypeGroup": "ค่าธรรมเนียมบัตร"
}คำตอบ:
{
"RequestId": "2b0cbe11-f109-4c43-9201-49af0370df1c",
"Status": "SUCCESS",
"Data": [
{
"FeeTypeGroup": "ค่าธรรมเนียมบัตร",
"FeeTypeId": 1,
"FeeType": "ค่าธรรมเนียมรายปีบัตร",
"ProductId": 1234,
"ProductCode": "FEE",
"ชื่อสินค้า": "ค่าธรรมเนียมบัตร",
"จำนวนค่าธรรมเนียมรวม": 125.00,
"รหัสสกุลเงินในใบแจ้งหนี้": "GBP",
"สัญลักษณ์สกุลเงินในใบแจ้งหนี้": "£"
}
]
}ตัวอย่างที่ 9: รับข้อยกเว้นของธุรกรรม
คำขอ:
POST /transaction-data/v1/exceptions
{
"ColCoId": 1,
"ColCoCode": 86,
"PayerId": 12345,
"PayerNumber": "GB000000123",
"TransactionsFromDate": "20231223",
"TransactionsToDate": "20240131",
"Value": 100,
"Condition": 5,
"OutputType": "Transaction"
}คำตอบ:
{
"RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
"Status": "SUCCESS",
"Data": [
{
"CardsExceptions": [
{
"AccountId": 29484,
"CardId": 1234,
"PAN": "ABCD1234",
"DriverName": "แอนดรูว์ กิลเบอร์รี่",
"VRN": "34235",
"PayerId": 123455,
"หมายเลขผู้ชำระเงิน": "GB000000123",
"หมายเลขบัญชี": "GB99215176",
"ชื่อบัญชีสั้น": "MATTHEW",
"PayerShortName": "MATTHEW",
"Day": 2,
"Week": 2,
"Month": 5,
"ปี": 2017,
"จำนวนธุรกรรมทั้งหมด": 4,
"จำนวนรายการขายทั้งหมด": 4,
"จำนวนรวมทั้งหมด": 261,
"จำนวนเงินรวม": 100.21,
"รหัสสกุลเงิน": "GBP",
"CurrencySymbol": "$"
}
],
"TransactionsExceptions": [
{
"SalesItemId": 18315958002,
"CardId": 1234,
"ProductId": 2,
"TransactionGUID": "ABCD1234",
"TransactionDate": "20231223",
"CustomerInvoiceValueTotalGross": 123.12,
"CardPAN": "7002051006629891000",
"CardExpiry": "20311223 12:12:12",
"TransactionTime": "12:12:12",
"UTCOffset": "+12:12:12",
"FleetIdInput": "XYZ1234",
"OdometerInput": 1234,
"DriverName": "SALT",
"VehicleRegistration": "MV65YLH",
"InvoiceCurrencyCode": "GBP",
"InvoiceCurrencySymbol": "$",
"TransactionCurrencyCode": "GBP",
"TransactionCurrencySymbol": "£",
"TransactionNetAmount": 123.12,
"TransactionTax": 123.12,
"TransactionGrossAmount": 123.12,
"InvoiceNetAmount": 123.12,
"InvoiceTax": 123.12,
"InvoiceGrossAmount": 123.1,
"PurchasedInCountry": "ฝรั่งเศส",
"AccountId": 1234,
"AccountNumber": "GB99215176",
"AccountName": "MATTHEW ALGIE & COMPANY LIMITED",
"AccountShortName": "MATTHEW ALGIE & COMPANY LIMITED",
"จำนวน": 123.12,
"FuelProduct": true,
"UnitPriceInTransactionCurrency": 123.12,
"UnitPriceInInvoiceCurrency": 123.12,
"UnitDiscountTransactionCurrency": 123.12,
"UnitDiscountInvoiceCurrency": 123.12,
"IsInvoiced": true,
"InvoiceNumber": "S04500493",
"InvoiceDate": "20231223",
"SiteCode": "50001",
"SiteName": "CHARNOCK RICHARD NTHBOUND MWSA 0755",
"SiteCountry": "Germany",
"Location": {
"Lat": "37.4224764",
"Lng": "122.0842499"
},
"CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
"ReceiptNumber": "1234",
"ProductCode": "TMF Charges",
"ProductName": "น้ำมันไร้สารตะกั่ว - ออกเทนสูง",
"ProductGroupId": 1234,
"ProductGroupName": "กลุ่มผลิตภัณฑ์หลัก",
"DelCoExchangeRate": 123.12,
"ColCoExchangeRate": 123.12,
"IsShellSite": true,
"Network": "Shell PH",
"SiteGroupId": 202,
"SiteGroupName": "CZ 9100 ECONOMY NETWORK",
"PostingDate": "20231223 12:12:12",
"IssuerCode": "7077 = CRT",
"รหัสประเทศที่ซื้อ": "NL",
"CustomerCountryCode": "NL",
"CustomerCountry": "เนเธอร์แลนด์",
"ReleaseCode": "8 สำหรับ 702188",
"CardGroupId": "200",
"CardSequenceNumber": "2",
"CheckDigit": "GHE1234",
"FleetIDDescription": "ตัวอย่างคำอธิบาย",
"อัตราภาษีมูลค่าเพิ่ม": 0.2,
"หมวดหมู่ภาษีมูลค่าเพิ่ม": "3-ยกเว้นภาษีมูลค่าเพิ่ม",
"ภาษีมูลค่าเพิ่มบนยอดสุทธิ": 12.21,
"ประเทศภาษีมูลค่าเพิ่ม": "เนเธอร์แลนด์",
"EffectiveDiscountInTrxCurrency": 0,
"TransactionType": "ซื้อเมื่อมีบัตร มิฉะนั้นให้เว้นว่าง",
"PINIndicator": "Y",
"VATApplicable": "Y",
"NetInvoiceIndicator": "Y",
"CustomerCurrencyCode": "GBP",
"CustomerCurrencySymbol": "£",
"EffectiveUnitDiscountInCustomerCurrency": 123.12,
"EffectiveDiscountInCustomerCurrency": 123.12,
"VATonNetAmountInCustomerCurrency": 123.12,
"DiscountType": "3-Percentage",
"สถานะธุรกรรม": "U",
"กลุ่มผู้ชำระเงิน": "12119008",
"RefundFlag": "N",
"OriginalSalesItemId": "1231",
"DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
"DelcoCode": "NL10042616",
"ชื่อผู้ชำระเงิน": "V.M. LE COMTE",
"ระยะเวลาหมดอายุบัตร": "1901",
"รหัสการอนุมัติ": "11256",
"TransactionId": "io9KVXk1UkW57XWKyeaHHg",
"TransactionLine": "1",
"AllowClearing": "Y",
"CRMNumber": "ABCD1234",
"สถานะข้อพิพาท": "6\tเรียกเก็บเงินกลับไปยังเว็บไซต์",
"อัตราการคืนเงิน": 28.279,
"DelCoToColCoExchangeRate": 1,
"NetEuroAmount": 37.93,
"EuroRebateAmount": 0,
"EuroVATAmount": 7.96,
"ParentCustomerNumber": "DRG1234"
}
]
}
]
}ตัวอย่างที่ 10: รับสรุปการใช้งานบัตร
คำขอ:
POST /transaction-data/v1/cardusagesummary
{
"ColCoId": 1,
"ColCoCode": 86,
"PayerId": 12345,
"หมายเลขผู้ชำระเงิน": "GB000000123",
"รหัสบัญชี": 1234,
"หมายเลขบัญชี": "GB000000123",
"หมายเลขบัตร": 1234,
"PAN": "7882861007636000020",
"CardExpiry": "20311223"
}คำตอบ:
{
"RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
"Status": "SUCCESS",
"Data": [
{
"UsageSummary": [
{
"Date": "20170930",
"ProductId": 1,
"รหัสสินค้า": "2",
"ชื่อสินค้า": "ดีเซล AGO",
"เป็นผลิตภัณฑ์เชื้อเพลิง": true,
"รหัสกลุ่มสถานี": 1234,
"ชื่อกลุ่มสถานี": "เครือข่ายทางหลวง UK 9500",
"TotalVolume": 123.12,
"TotalGross": 123.12,
"TotalNet": 123.12,
"CurrencyCode": "GBP",
"CurrencySymbol": "£",
"ProductGroupId": 1234,
"ProductGroupName": "น้ำมันเบนซินสำหรับรถยนต์"
}
]
}
]
}การจัดการข้อผิดพลาด
รหัสข้อผิดพลาดทั่วไป
| สถานะ HTTP | รหัสข้อผิดพลาด | คำอธิบาย | วิธีแก้ไข |
|---|---|---|---|
| 200 | ไม่เกี่ยวข้อง | สถานะ: สำเร็จ | ไม่เกี่ยวข้อง |
| 200 | E0001 | ข้อผิดพลาดในการตรวจสอบความถูกต้อง | ตรวจสอบพารามิเตอร์ของคำขอ |
| 401 | E0003 | ไม่ได้รับอนุญาต | ตรวจสอบโทเค็น OAuth ว่าถูกต้อง |
| 403 | E0 | ห้าม | ตรวจสอบสิทธิ์ผู้ใช้ |
| 404 | E0005 | ไม่พบทรัพยากร | ตรวจสอบ URL ของจุดสิ้นสุดและทรัพยากรว่ามีอยู่จริง |
| 500 | E0002 | ข้อผิดพลาดที่ไม่ทราบสาเหตุ / ข้อผิดพลาดภายในเซิร์ฟเวอร์ | ติดต่อฝ่ายสนับสนุน |
แนวทางปฏิบัติที่ดีที่สุด
1. ใช้การยืนยันตัวตน OAuth 2.0
สำคัญ: ลูกค้าทุกท่านควรย้ายไปใช้การยืนยันตัวตน OAuth 2.0 ดำเนินการจัดการโทเค็นอย่างเหมาะสม:
- เก็บโทเค็นการเข้าถึงแคชและใช้ซ้ำจนกว่าจะหมดอายุ
- รีเฟรชโทเค็นก่อนที่มันจะหมดอายุ (แนะนำให้ทำก่อน 60 วินาที)
- เก็บรักษาข้อมูลประจำตัวของลูกค้าอย่างปลอดภัย (ใช้ตัวแปรสภาพแวดล้อมหรือผู้จัดการความลับ)
- อย่าบันทึกหรือเปิดเผยโทเค็นการเข้าถึงในโค้ดฝั่งลูกค้า
2. ใช้รหัสคำขอ
โปรดระบุรหัสคำขอ (RequestId) ที่ไม่ซ้ำกัน (รูปแบบ GUID) เพื่อการติดตามตั้งแต่ต้นจนจบ
3. ดำเนินการแบ่งหน้า
สำหรับชุดข้อมูลธุรกรรมขนาดใหญ่ ให้ใช้การแบ่งหน้าเพื่อหลีกเลี่ยงการหมดเวลา:
- ตั้งค่าขนาดหน้า (PageSize) ให้เหมาะสม (แนะนำ: 50-100 รายการ)
- ประมวลผลหน้าตามลำดับหรือพร้อมกัน
- จัดการ TotalPages และ TotalRecords ในการตอบสนอง
4. ใช้ตัวกรองวันที่อย่างชาญฉลาด
เมื่อค้นหาข้อมูลธุรกรรม:
- จำกัดช่วงวันที่เพื่อหลีกเลี่ยงผลลัพธ์จำนวนมาก
- ใช้ตัวกรอง FromDate และ ToDate อย่างสม่ำเสมอ
- พิจารณาการค้นหาตามเดือนหรือสัปดาห์เพื่อประสิทธิภาพที่ดีขึ้น
5. ทดสอบในสภาพแวดล้อม Sandbox
ทดสอบการผสานรวมในสภาพแวดล้อม Test/Sandbox เสมอก่อน ย้ายไปยังการผลิต
6. เก็บข้อมูลอ้างอิงไว้ในแคช
กำหนดราคาตามปริมาณการใช้แคชและกฎโบนัสเพื่อลดการเรียกใช้ API:
- กฎเหล่านี้มีการเปลี่ยนแปลงไม่บ่อย
- รีเฟรชแคชเป็นระยะ (เช่น รายวัน)
- ใช้พารามิเตอร์ IncludeHistory เฉพาะเมื่อจำเป็นเท่านั้น
SDK & ตัวอย่างโค้ด
Shell มี SDK อย่างเป็นทางการและตัวอย่างโค้ดที่ครอบคลุมเพื่อเร่งการผสานรวมของคุณกับ Transaction Data API
ภาษา SDK ที่มีให้บริการ
- Python - SDK ที่มีฟีเจอร์ครบถ้วนพร้อม OAuth 2.0 support
- TypeScript - SDK ที่ปลอดภัยด้านประเภทข้อมูล พร้อมคำจำกัดความประเภทข้อมูลอย่างครบถ้วน
- Java - SDK ระดับองค์กร
- C#/.NET - การผสานรวม .NET อย่างสมบูรณ์
- PHP - ไลบรารี PHP ที่ใช้งานง่าย
- Ruby - รูบี้เจมสำหรับการผสานรวมอย่างราบรื่น
ดู SDK และเอกสารอย่างเป็นทางการ
การสนับสนุนและทรัพยากร
การสนับสนุนทางเทคนิค
- การสนับสนุน: การสนับสนุนทางเทคนิคของเชลล์
- การย้ายข้อมูล OAuth 2.0: การสนับสนุนการย้ายข้อมูล OAuth 2.0
เอกสาร
ขอความช่วยเหลือ
เมื่อติดต่อฝ่ายสนับสนุน โปรดระบุ:
- client_id ของคุณ (ห้ามแชร์ client_secret หรือ access tokens ของคุณเด็ดขาด)
- RequestId จากคำตอบของ API
- Timestamp ของคำขอ
- สภาพแวดล้อม (Production/Test)
ปรับปรุงล่าสุด: 16 มิถุนายน 2026
เวอร์ชันเอกสาร: 1.0
เวอร์ชัน API: 2.3.4
