ShopeePay App Redirection

หัวข้อทั้งหมดในหน้านี้

ร้านค้าสามารถเพิ่มช่องทางรับชำระเงินผ่านแอปพลิเคชัน ShopeePay โดยเชื่อมต่อผ่าน API ที่โอมิเซะได้เตรียมไว้ ช่องทางรับชำระเงินนี้ช่วยเพิ่มทางเลือกในการชำระเงินแก่ผู้ซื้อ โดยสามารถเลือกชำระผ่านแอปพลิเคชัน ShopeePay ที่ได้ลงทะเบียนใช้งานไว้แล้วได้เลย ลดขั้นตอนการกรอกข้อมูลบัตร ช่วยให้จบขั้นตอนการชำระเงินได้เร็วขึ้น

คู่มือฉบับนี้จะช่วยเป็นแนวทางการอธิบายขั้นตอนการรับชำระเงินผ่าน ShopeePay Jump App

การเปิดรับชำระเงิน

  • ประเทศที่รองรับ: ประเทศไทย, สิงคโปร์
  • API เวอร์ชันล่าสุดที่รองรับ: 2017-11-02

ร้านค้าที่ต้องการเปิดใช้ระบบ ShopeePay Jump App กรุณาส่งอีเมลมาที่ support@opn.ooo ทางทีมงานโอมิเซะจะส่งข้อกำหนดและเงื่อนไขการใช้บริการให้ร้านค้าได้พิจารณาและลงลายมือชื่อก่อนเปิดใช้งานจริง

ขั้นตอนการชำระเงิน

ผู้ซื้อที่เลือกชำระเงินผ่าน ShopeePay จะผ่านกระบวนการชำระเงินแบบที่เรียกว่า ออฟไซต์ คือผู้ซื้อจะต้องเป็นฝ่ายยืนยันการชำระเงินผ่านแอปพลิเคชันของ ShopeePay เพื่อทำรายการ

เมื่อผู้ซื้อเลือกชำระเงินด้วยบริการ ShopeePay ร้านค้าจะต้องส่งผู้ซื้อไปยังแอปพลิเคชัน โดยใช้ URI ที่ได้รับ (เป็น “deep link” ที่จะเปิดแอปพลิเคชันบนโทรศัพท์มือถือของผู้ซื้อ) ภาพประกอบด้านล่างแสดงขั้นตอนการชำระเงินบนโทรศัพท์มือถือ

Wallet App

❶ ผู้ซื้อเลือกชำระผ่านช่องทางที่ต้องการ ❷ โทรศัพท์มือถือเปิดแอปพลิเคชัน ShopeePay เพื่อทำการชำระเงิน ❸ หน้าจอจะแสดงรายละเอียดการชำระเงินให้ผู้ซื้อยืนยันการชำระเงิน ❹ ผู้ซื้อสามารถเลือกกลับไปที่หน้าของร้านค้าได้ โดยคลิกที่ปุ่มกลับสู่ร้านค้า ❺ ผู้ชื้อกลับไปที่หน้าของร้านค้า

ผู้ใช้ ShopeePay สามารถทำรายการชำระเงินผ่านช่องทางต่างๆ ดังนี้:

ช่องทางชำระเงินที่รองรับ ประเทศไทย สิงคโปร์
Wallet Balance ✅ ✅
บัตรเครดิต ✅
การหักบัญชีอัตโนมัติ / หักบัญชีธนาคาร ✅

การติดตั้งใช้งาน

ในการสร้างรายการรับชำระเงินผ่านShopeePay Jump App ให้ร้านค้าส่งคำสั่ง API ดังนี้

  1. สร้าง payment source (type: shopeepay_jumpapp) โดยใช้ Omise.js, omise-ios หรือ omise-android
  2. สร้าง charge โดยใช้ source จากขั้นตอนแรก
  3. เมื่อผู้ซื้อทำรายการสำเร็จและร้านค้าได้รับ webhook event หรือ charge.complete แล้ว เราแนะนำให้ตรวจสอบสถานะรายการด้วยตนเองอีกครั้งเพื่อความแม่นยำ

การสร้าง source เพื่อรับชำระเงินผ่านShopeePay Jump App จะเกิดขึ้นในฝั่งของผู้ซื้อ (client-side) เช่นบนเว็บไซต์หรือโทรศัพท์มือถือของผู้ซื้อ ร้านค้าจะต้องใช้ public key

ส่วนการสร้างรายการ (charge) เพื่อรับชำระเงินผ่านShopeePay Jump App จะเกิดขึ้นในฝั่งของร้านค้า (server-side) ร้านค้าจะต้องใช้ secret key

หมายเหตุ: หากมีความจำต้องสร้างทั้งรายการและ source ในฝั่งร้านค้า (server-side) สามารถทำพร้อมกันได้เลยโดยการส่งคำสั่ง API เพียงครั้งเดียว และใช้งาน secret key

การสร้าง source


เมื่อผู้ซื้อเลือกชำระเงินผ่านช่องทางนี้ ให้ร้านค้าสร้าง source ผ่าน source API โดยกำหนด amount, currency, platform_type, และ type


Parameter Type Description
amount integer (required)
currency string (required) (THB สำหรับประเทศไทย, SGD สำหรับสิงคโปร์)
type string (required) shopeepay_jumpapp
platform_type string (optional) IOS, ANDROID (ตัวอย่าง: IOS)

ตัวอย่างด้านล่างนี้เป็นการสร้าง source สำหรับรายการ ShopeePay Jump App จำนวน S$50 ให้แทนค่าของ omise_public_key และ $OMISE_PUBLIC_KEY ด้วย test public key ของร้านค้าซึ่งสามารถคัดลอกได้จาก แดชบอร์ด

หากใช้ Omise.js parameter type เป็นตัวแปรที่จำเป็นของฟังก์ชัน createSource

Omise.setPublicKey(omise_public_key);

Omise.createSource('shopeepay_jumpapp', {
  "amount": 5000,
  "currency": "SGD"
}, function(statusCode, response) {
  console.log(response)
});

หากร้านค้าต้องการทดสอบให้สร้าง request โดยใช้ curl

curl https://api.omise.co/sources \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=5000" \
  -d "currency=SGD" \
  -d "type=shopeepay_jumpapp"

{
  "object": "source",
  "id": "src_test_5v6lbl954ipmfks9mqb",
  "livemode": false,
  "location": "/sources/src_test_5v6lbl954ipmfks9mqb",
  "amount": 5000,
  "barcode": null,
  "bank": null,
  "created_at": "2023-03-21T09:38:20Z",
  "currency": "SGD",
  "email": null,
  "flow": "app_redirect",
  "installment_term": null,
  "absorption_type": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "shopeepay_jumpapp",
  "zero_interest_installments": null,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": []
}

ตัวแปรของ id คือ source identifier (เริ่มต้นด้วย src)

การสร้างรายการรับชำระเงิน

สร้างรายการรับชำระเงินโดยระบุ parameter return_uri, source, amount และ currency

  • return_uri จะเป็นตำแหน่งบนเว็บไซต์ของร้านค้าที่ผู้ซื้อจะถูกส่งไปเมื่อยืนยันรายการสำเร็จ
  • source จะเป็นตัวกำหนด source identifier
  • amount และ currency จะต้องมีค่าตรงกับ amount และ currency ของ source

Opn แนะนำให้คุณหลีกเลี่ยงการใช้ตัวแปรเหล่านี้ในรายการรับชำระเงิน ได้แก่ net, fee, fee_vat และ transaction_fees จนกว่าสถานะรายการรับชำระเงิน successful

ตัวอย่างด้านล่างนี้แสดงให้เห็นถึงการสร้างรายการรับชำระเงินขึ้นมาใหม่ โดยใช้ curl

ในการสร้างรายการให้ร้านค้าแทน $OMISE_SECRET_KEY ด้วย test secret key ของร้านค้าซึ่งสามารถคัดลอกได้จากแดชบอร์ด และแทน $SOURCE_ID ด้วย id ของ source

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=5000" \
  -d "currency=SGD" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

{
  "object": "charge",
  "id": "chrg_test_5v6lblcka12tuomartm",
  "location": "/charges/chrg_test_5v6lblcka12tuomartm",
  "amount": 5000,
  "net": 0,
  "fee": 0,
  "fee_vat": 0,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 5000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": null,
    "fee_rate": null,
    "vat_rate": "0.0"
  },
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "SGD",
  "funding_currency": "SGD",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_test_5v6lblcka12tuomartm/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2023-03-21T09:38:21Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5v6lbkzr1lzokgznk53",
    "livemode": false,
    "location": "/sources/src_test_5v6lbkzr1lzokgznk53",
    "amount": 5000,
    "barcode": null,
    "bank": null,
    "created_at": "2023-03-21T09:38:19Z",
    "currency": "SGD",
    "email": null,
    "flow": "app_redirect",
    "installment_term": null,
    "absorption_type": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": null,
    "scannable_code": null,
    "billing": null,
    "shipping": null,
    "items": [],
    "references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "shopeepay_jumpapp",
    "zero_interest_installments": null,
    "charge_status": "pending",
    "receipt_amount": null,
    "discounts": []
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/payments/pay2_test_5v6lblclyxxko23y7ts/authorize",
  "return_uri": "http://example.com/orders/345678/complete",
  "created_at": "2023-03-21T09:38:20Z",
  "paid_at": null,
  "expires_at": "2023-03-28T09:38:20Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": false,
  "branch": null,
  "terminal": null,
  "device": null,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false
}

การสร้าง source และรายการรับชำระเงิน

ร้านค้าสามารถสร้างทั้ง source และ รายการรับชำระเงิน (charge) ผ่านการเรียกใช้ API เพียงครั้งเดียว

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=5000" \
  -d "currency=SGD" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=shopeepay_jumpapp"

การตั้งเวลาหมดอายุสำหรับรายการ

โดยทั่วไป รายการรับชำระเงินจะมีอายุ 20 นาทีหลังจากการสร้างรหัส

ในกรณีที่ต้องการกำหนดระยะเวลาในการหมดอายุสำหรับแต่ละรายการ สามารถเข้าไปที่ Charge API และระบุระยะเวลาหมดอายุ (timestamp) ที่ต้องการใน field expires_at (ตั้งเวลาให้รหัสหมดอายุได้ไม่เกิน 60 นาทีหลังจากการสร้างรหัส) หากกรอกข้อมูลถูกต้อง ระบบจะทำการปิดการเข้ารายการรับชำระเงินเมื่อถึงระยะเวลาที่กำหนดไว้แทนระยะเวลาตั้งต้น

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=5000" \
  -d "currency=SGD" \
  -d "source[type]=shopeepay_jumpapp"
  -d "expires_at=2020-07-01T15:00:00Z"

หากต้องการปิดใช้งานลิงก์ก่อนกำหนด สามารถเรียกใช้ API นี้เพื่อปิดการเข้าถึงลิงก์

curl https://api.omise.co/charges/$CHARGE_ID/expire \
  -X POST \
  -u $OMISE_SECRET_KEY:

สร้างรายการสำเร็จ

เมื่อร้านค้าสร้างรายการรับชำระเงินขึ้นมาแล้ว จะพบว่าสถานะของรายการแสดงเป็น pending หรือ status==pending โดยสถานะของรายการรับชำระเงินสามารถเป็นได้ทั้ง successful, failed และ expired

ในส่วนต่อไปเราจะอธิบายวิธีอนุมัติรายการ, การรับ event แจ้งเตือนเมื่อรายการเสร็จสิ้นผ่าน webhook และการตรวจสอบสถานะรายการ

ภาพด้านล่างนี้แสดงให้เห็นถึงขั้นตอนทั้งหมดในการรับชำระเงินแต่ละรายการ

sequenceDiagram participant customer participant omise.js participant merchant participant api.omise.co customer->>omise.js: Send payment details for purchase omise.js->>api.omise.co: Request source using payment details api.omise.co-->>omise.js: Return source omise.js->>merchant: Merchant gets returned source merchant->>api.omise.co: Request charge using source and purchase details api.omise.co-xmerchant: Send "charge.create" webhook api.omise.co-->>merchant: Return charge merchant->>customer: Redirect to "authorize_uri" for pending charge customer->>api.omise.co: Provide charge authorization details at "authorize_uri" api.omise.co-->>customer: Redirect to "return_uri" api.omise.co-xmerchant: Send "charge.complete" webhook merchant-xcustomer: Send charge result (e.g. via email)

การอนุมัติรายการรับชำระเงิน

ระบบจะส่งผู้ซื้อไปยังตำแหน่งที่ระบุไว้ใน authorize_uri เพื่อให้ผู้ซื้อสามารถดำเนินการอนุมัติรายการรับชำระเงินได้

ร้านค้าสามารถจำลองขั้นตอนการอนุมัติรายการในโหมดทดสอบ โดยเข้าไปที่ authorize_uri เพื่อปรับสถานะรายการเป็น “สำเร็จ” หรือ “ไม่สำเร็จ” ได้ด้วยตนเอง หลังจากผู้ซื้อทำการอนุมัติรายการเสร็จสิ้น ผู้ซื้อจะถูกส่งไปยังหน้าที่ร้านค้าระบุเป็น return_uri เอาไว้

การรับ event แจ้งเตือนรายการสำเร็จ

ร้านค้าสามารถรับการแจ้งเตือนเมื่อมีการทำรายการเสร็จสิ้นโดยใช้งาน webhook events

ในการติดตั้งให้ร้านค้ากำหนดตำแหน่งบนเซิร์ฟเวอร์เพื่อรับ webhook events และเพิ่มตำแหน่งเดียวกันนี้เป็น webhook endpoint บนแดชบอร์ด

เมื่อมีรายการเสร็จสิ้น ระบบจะส่ง POST request ไปยัง endpoint นี้ พร้อมทั้งแนบสถานะการตอบกลับของรายการนั้นๆ ไปด้วย

ตัวแปรหลักหรือ key สำหรับ event object ประกอบไปด้วย charge.complete และตัวแปร data ที่มี charge object

อ่านเพิ่มเติมได้ที่ Events API

การตรวจสอบสถานะรายการ

เมื่อได้รับ event ของรายการที่เสร็จสิ้นแล้ว ร้านค้าสามารถตรวจสอบสถานะรายการหรือ status โดยใช้ Charge API

หากค่าของ charge.status เป็น successful หมายถึงว่ารายการรับชำระเงินสำเร็จ หากค่าของ charge.status เป็น failed รายการรับชำระเงินนั้นไม่สำเร็จ ร้านค้าสามารถตรวจสอบ failure_code และ failure_message ได้ใน charge object เพื่ออ่านคำอธิบายเพิ่มเติม

สาเหตุขัดข้องที่อาจเกิดขึ้นได้มีดังนี้

รหัสข้อขัดข้อง รายละเอียด
payment_cancelled ผู้ซื้อยกเลิกการชำระเงิน
payment_expired รายการชำระเงินหมดอายุ
payment_rejected รายการถูกปฏิเสธโดยธนาคารผู้ออกบัตร
failed_processing ระบบทำรายการไม่สำเร็จ
invalid_account ไม่พบบัญชีที่สามารถชำระเงินผ่านช่องทางที่เลือก
insufficient_fund วงเงินคงเหลือไม่เพียงพอหรือวงเงินเต็ม

การคืนเงิน

สามารถทำการคืนเงินแบบเต็มจำนวนหรือบางส่วนได้ภายในระยะเวลา 180 วันนับจากวันทำรายการ โดยสามารถดำเนินการผ่าน refund API หรือหน้าแดชบอร์ด (Dashboard) ได้

ข้อจำกัด

  • จำนวนรับชำระขั้นต่ำ: 2000 (THB20.00)
  • จำนวนรับชำระสูงสุด: 15000000 (THB150,000.00)

ขั้นตอนต่อไป

เว็ปไซต์นี้มีการใช้คุกกี้เพื่อวิเคราะห์การใช้และปรับการใช้งานให้เหมาะกับท่าน เมื่อกดยอมรับหรือยังคงเข้าชมเว็บไซต์ต่อ เราถือว่าท่านยินยอมในการใช้งานคุกกี้ของเว็บไซต์ อ่านนโยบายความเป็นส่วนตัว