จัดการยอดคงเหลือในบัญชีชำระล่วงหน้า

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X
ข้อมูล

วิธีจัดการยอดคงเหลือในบัญชีแบบชำระล่วงหน้ามีดังนี้

ฉันจะคำนวณยอดเงินคงเหลือของบัญชีชำระล่วงหน้าได้อย่างไร

เมื่อดูยอดคงเหลือในบัญชีชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์หรือบริษัทตามที่อธิบายไว้ในส่วนต่อไปนี้ คุณจะต้องได้รับค่าต่อไปนี้จากการตอบกลับ

  • amount: จำนวนเงินทั้งหมดที่มีสำหรับช่วงเวลาที่เรียกเก็บเงินปัจจุบัน ค่านี้จะอัปเดตเมื่อคุณโหลดบัญชีแบบชำระล่วงหน้าซ้ำโดยใช้วิธีการที่อธิบายไว้ในส่วนนี้
  • usage: จำนวนเงินทั้งหมดที่ใช้ในช่วงเวลาที่เรียกเก็บเงินปัจจุบัน ค่านี้จะอัปเดตพร้อมกับธุรกรรมที่สร้างรายได้ที่เข้าเกณฑ์แต่ละรายการ หรือโดยการให้เครดิต (เชิงบวกหรือเชิงลบ)

คุณสามารถคำนวณเงินคงเหลือในบัญชีแบบชำระล่วงหน้าสำหรับช่วงเวลาที่เรียกเก็บเงินปัจจุบันได้โดยลบค่า usage ออกจากค่า amount เช่น หากค่า amount คือ 335.50 และค่า usage คือ 34 ระบบจะคํานวณยอดคงเหลือดังนี้

amount(335.50) - usage(34) = 229.50

การดูยอดคงเหลือในบัญชีชำระล่วงหน้าโดยใช้ API

ส่วนต่อไปนี้จะอธิบายวิธีดูยอดคงเหลือในบัญชีชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์หรือบริษัทโดยใช้ API

การดูยอดคงเหลือในบัญชีชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์

หากต้องการดูยอดคงเหลือในบัญชีชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์ ให้ส่งคำขอ GET ไปยัง API อย่างใดอย่างหนึ่งต่อไปนี้ โดย {developer_id} คืออีเมลของนักพัฒนาซอฟต์แวร์

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: ส่งคืนยอดคงเหลือของบัญชีแบบชำระล่วงหน้าและข้อมูลการตั้งค่าตามรอบสำหรับนักพัฒนาแอป
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: ส่งคืนข้อมูลยอดคงเหลือของบัญชีแบบชำระล่วงหน้า ซึ่งรวมถึงยอดคงเหลือปัจจุบันและยอดคงเหลือทั้งหมด การใช้งาน การเติมเงิน และภาษีการใช้งาน

คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้

พารามิเตอร์การค้นหา คำอธิบาย
all แฟล็กที่ระบุว่าจะแสดงผลแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหาของ size จะเป็นตัวกำหนดจำนวนแพ็กเกจ API ที่แสดงผลในแต่ละหน้า ค่าเริ่มต้นคือ false
size จำนวนแพ็กเกจ API ที่ส่งคืนต่อหน้า ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้
page จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้
currencyId รหัสของสกุลเงินที่ต้องการดูยอดคงเหลือในบัญชีชำระล่วงหน้า

เช่น

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
    "developerBalance": [
        {
            "amount": 2005,
            "chargePerUsage": false,
            "id": "your-provider-id",
            "isRecurring": false,
            "supportedCurrency": {
                "description": "United States Dollars",
                "displayName": "United States Dollars",
                "id": "usd",
                "name": "USD",
                "organization": {
                    "address": [
                        {
                            "address1": "10 Almaden Blvd.",
                            "city": "San Jose",
                            "country": "US",
                            "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61",
                            "isPrimary": true,
                            "state": "CA",
                            "zip": "95113"
                        }
                    ],
                    "approveTrusted": false,
                    "approveUntrusted": false,
                    "billingCycle": "CALENDAR_MONTH",
                    "country": "US",
                    "currency": "USD",
                    "description": "my-org",
                    "groupOrganization": false,
                    "hasBillingAdjustment": false,
                    "hasBroker": false,
                    "hasSelfBilling": false,
                    "hasSeparateInvoiceForProduct": false,
                    "id": "my-org",
                    "issueNettingStmt": false,
                    "name": "my-org",
                    "nettingStmtPerCurrency": false,
                    "selfBillingAsExchOrg": false,
                    "selfBillingForAllDev": false,
                    "separateInvoiceForFees": false,
                    "status": "ACTIVE",
                    "supportedBillingType": "BOTH",
                    "taxModel": "HYBRID",
                    "timezone": "UTC"
                },
                "status": "ACTIVE",
                "virtualCurrency": false
            },
            "usage": 2.1572
        }
    ],
    "totalRecords": 1
}

การดูยอดคงเหลือในบัญชีชำระล่วงหน้าของบริษัท

หากต้องการดูยอดคงเหลือในบัญชีชำระล่วงหน้าของบริษัท ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/companies/{company_id}/developer-balances โดยที่ {company_id} คือรหัสของบริษัท หากบริษัทเป็นบริษัทชำระล่วงหน้า คำขอจะดึงเงินคงเหลือปัจจุบันในบัญชีชำระล่วงหน้า หากบริษัทชำระเงินภายหลัง คําขอจะดึงวงเงินเครดิตปัจจุบัน

คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้

พารามิเตอร์การค้นหา คำอธิบาย
all แฟล็กที่ระบุว่าจะแสดงผลแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหาของ size จะเป็นตัวกำหนดจำนวนแพ็กเกจ API ที่แสดงผลในแต่ละหน้า ค่าเริ่มต้นคือ false
size จำนวนแพ็กเกจ API ที่ส่งคืนต่อหน้า ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้
page จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้
currencyId รหัสของสกุลเงินที่ต้องการดูยอดคงเหลือในบัญชีชำระล่วงหน้า

เช่น

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

คําตอบจะคล้ายกับคําตอบที่แสดงด้านบนเมื่อดูยอดคงเหลือในบัญชีชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์

การจัดการเงินคงเหลือในบัญชีชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงิน

จัดการยอดคงเหลือในบัญชีชำระล่วงหน้าโดยการตั้งค่าบัญชีผู้ขายกับผู้ให้บริการชำระเงินบุคคลที่สาม เช่น Worldpay ตัวเลขต่อไปนี้แสดงวิธีจัดการยอดเงินคงเหลือในบัญชีชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงินทั่วโลก

ขั้นตอนของผู้ให้บริการชำระเงินทั่วโลก

ตารางต่อไปนี้จะอธิบายแต่ละขั้นตอนในกระบวนการจัดการยอดเงินคงเหลือในบัญชีชำระล่วงหน้าที่แสดงด้านบน

ขั้นตอน คำอธิบาย
0 ขั้นตอนที่ต้องทำก่อน
ในฐานะผู้ให้บริการ API หากต้องการตั้งค่าผู้ให้บริการชำระเงินบุคคลที่สาม เช่น Worldpay คุณต้องดำเนินการดังนี้
1 หากต้องการทริกเกอร์โฟลว์ ผู้บริโภค API จะทํางานอย่างใดอย่างหนึ่งต่อไปนี้ในพอร์ทัลนักพัฒนาซอฟต์แวร์
  • เพิ่มเงินลงในบัญชี
  • ยอมรับแพ็กเกจราคาที่มีเงินไม่เพียงพอ
2 พอร์ทัลนักพัฒนาซอฟต์แวร์จะเริ่มต้นการชำระเงินผ่าน Edge สำหรับนักพัฒนาแอป โดยระบุรหัสผู้ให้บริการ จำนวนเงินที่โหลดซ้ำ และสกุลเงิน ดูข้อมูลเกี่ยวกับการใช้ API เพื่อเริ่มการชำระเงินได้ที่การเริ่มต้นการชำระเงินไปยังบัญชีแบบชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงิน
3 Edge ค้นหาผู้ให้บริการตามรหัส และระบุว่าเป็นบัญชี Worldpay
4 Edge จะสร้างรหัสคำสั่งซื้อ
5 Edge สร้างคำสั่งซื้อของการชำระเงินใน Worldpay
6 Worldpay จะแสดงรหัสอ้างอิงสำหรับคำสั่งซื้อและ URL ที่มีการจำกัดเวลาเพื่อดำเนินการตามคำสั่งซื้อ
7 การตอบกลับของ Worldpay จะเปลี่ยนเป็นการตอบกลับทั่วไปของ Edge /payment API ซึ่งจะส่งกลับไปยังพอร์ทัลนักพัฒนาแอปเพื่อทำการเรียกใช้ในขั้นตอนที่ 2 ให้เสร็จสมบูรณ์ เช่น
{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}
8 พอร์ทัลนักพัฒนาซอฟต์แวร์จะเพิ่ม URL เรียกกลับ (เพื่อความสำเร็จ ความล้มเหลว และอื่นๆ) เป็นพารามิเตอร์การค้นหาลงใน URL
9 พอร์ทัลนักพัฒนาซอฟต์แวร์ตอบสนองต่อคำขอในขั้นตอนที่ 1 โดยเปลี่ยนเส้นทางเบราว์เซอร์ของผู้ใช้ API ไปยัง URL ที่มีการแก้ไข
10 ผู้บริโภค API จะกรอกแบบฟอร์มการสมัครและดำเนินการเริ่มการประมวลผลด้วย Worldpay
11 Worldpay จะเก็บข้อมูลสำหรับการเรียกเก็บเงินและประมวลผลการชำระเงิน เมื่อประสบความสำเร็จ Worldpay จะสร้างรหัสการตรวจสอบสิทธิ์ข้อความ (MAC) โดยใช้ข้อมูลลับ MAC ที่กำหนดค่าทั้งใน Worldpay และพอร์ทัลนักพัฒนาซอฟต์แวร์
12 Worldpay จะเปลี่ยนเส้นทางเบราว์เซอร์ของผู้บริโภค API ไปยัง URL เรียกกลับที่สำเร็จ (จากขั้นตอนที่ 8) โดยต่อท้าย MAC เป็นพารามิเตอร์การค้นหา และจำนวน
13 เบราว์เซอร์เรียก URL ในพอร์ทัลของนักพัฒนาซอฟต์แวร์ด้วยจำนวนเงินที่ขอและ MAC
14 พอร์ทัลจะตรวจสอบ MAC กับข้อมูลลับของ MAC MAC ป้องกันไม่ให้บุคคลใดบุคคลหนึ่งอ้างสิทธิ์โดยพลการว่ามีการชำระเงินที่สำเร็จ
15 พอร์ทัลนักพัฒนาซอฟต์แวร์จะส่งคำขอไปยัง Edge เพื่อโหลดยอดคงเหลือแบบชำระล่วงหน้าอีกครั้ง สำหรับข้อมูลเกี่ยวกับการใช้ API เพื่อโหลดยอดคงเหลืออีกครั้ง โปรดดูการโหลดยอดคงเหลือในบัญชีชำระล่วงหน้าอีกครั้งโดยใช้ API

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

การตั้งค่าบัญชีผู้ขายกับผู้ให้บริการชำระเงิน WorldPay

ก่อนเริ่มต้น คุณต้องติดต่อผู้ให้บริการชำระเงินบุคคลที่สาม (Worldpay) เพื่อตั้งค่าบัญชีผู้ขาย เราขอแนะนำให้คุณสร้างบัญชี 2 บัญชี บัญชีหนึ่งสำหรับการทดสอบและอีกบัญชีสำหรับเวอร์ชันที่ใช้งานจริง ดูข้อมูลเพิ่มเติมเกี่ยวกับบัญชีผู้ขาย Worldpay ได้ที่ www.worldpay.com และ wp-support.crm.worldpay.com (ศูนย์สนับสนุน Worldpay)

หลังจากที่ตั้งค่าบัญชีผู้ขายและได้รับข้อมูลเข้าสู่ระบบของบัญชีแล้ว ให้กำหนดค่าบัญชีผู้ขายด้วย WorldPay ดังนี้

  1. ไปที่ https://secure.worldpay.com/sso/public/auth/login.html
  2. เข้าสู่ระบบบัญชี Worldpay โดยใช้ข้อมูลเข้าสู่ระบบที่ได้รับจาก Worldpay
  3. ตั้งรหัสผ่าน XML และคีย์ลับรหัสการตรวจสอบสิทธิ์ข้อความ (MAC) ดังนี้
    1. คลิกโปรไฟล์
    2. ตั้งรหัสผ่านที่จะใช้เมื่อกำหนดค่าผู้ให้บริการชำระเงินทั่วโลกใน Edge ในช่องรหัสผ่าน XML
    3. ป้อนคีย์ข้อมูลลับ MAC ความยาว 20 ถึง 30 อักขระในช่องข้อมูลลับ MAC
    4. คลิกบันทึกโปรไฟล์
  4. เพิ่มเซิร์ฟเวอร์การจัดการ Apigee Edge ลงในรายการ IP ของผู้ขาย (รายการที่อนุญาต) ดังนี้
    1. คลิกโปรไฟล์ > สภาพแวดล้อมของผู้ขาย
    2. คลิก IP ทดสอบใหม่
    3. ป้อน IP สำหรับเซิร์ฟเวอร์การจัดการ Apigee Edge
    4. คลิกบันทึก
  5. กำหนดค่า URL ของผู้ขายเพื่อเพิ่มพารามิเตอร์ Worldpay ซึ่งรวมถึงรหัสการตรวจสอบสิทธิ์ของเมธอด (MAC) ดังนี้
    1. คลิกการติดตั้ง > หน้าการชำระเงินที่โฮสต์ > เครื่องมือออกแบบหน้าการชำระเงิน
    2. ในส่วนแก้ไขหน้าการชำระเงิน ให้เลือกรหัสการติดตั้งจากรายการแบบเลื่อนลงเลือกช่อง
    3. ในแท็บ "พร็อพเพอร์ตี้" ให้เลือกแก้ไขการกำหนดค่าผู้ขาย
    4. ตั้งค่าพารามิเตอร์ของ URL ที่ส่งเป็น True
    5. คลิกแท็บเผยแพร่
    6. โปรโมตการเปลี่ยนแปลง ดังนี้
      • สำหรับสภาพแวดล้อมการทดสอบ ให้คลิกโปรโมตใต้การออกแบบเพื่อโปรโมตจากการออกแบบไปยังแซนด์บ็อกซ์
      • สำหรับสภาพแวดล้อมการใช้งานจริง ให้คลิกโปรโมตใต้แซนด์บ็อกซ์เพื่อโปรโมตจากแซนด์บ็อกซ์ไปยังเวอร์ชันที่ใช้งานจริง

การกําหนดค่าผู้ให้บริการชําระเงินใน Edge

ขั้นตอนถัดไปคือกำหนดค่าผู้ให้บริการชำระเงินใน Edge

คุณกำหนดค่าผู้ให้บริการชำระเงินสำหรับองค์กรใดองค์กรหนึ่งได้โดยใช้ API ต่อไปนี้

/organizations/{org-name}/providers

ลูกค้า Apigee Edge Private Cloud เท่านั้นที่มีสิทธิ์ของผู้ดูแลระบบจะกำหนดค่าผู้ให้บริการชำระเงินทั่วโลกได้โดยใช้ API ต่อไปนี้

/config/providers

เมื่อเรียกใช้ API แต่ละรายการ คุณต้องระบุข้อมูลต่อไปนี้ในเนื้อหาคำขอ

พารามิเตอร์ คำอธิบาย จำเป็น
authType รหัสการติดตั้งที่ได้รับจากผู้ให้บริการชำระเงิน มี
credential ข้อมูลเข้าสู่ระบบที่เข้ารหัส Base64 (username:XMLpassword) สำหรับบัญชีผู้ขาย Worldpay ของคุณ username เทียบเท่ากับรหัสผู้ขาย (ตัวพิมพ์ใหญ่ทั้งหมด) และ XMLpassword จะระบุรหัสผ่าน XML ที่คุณตั้งค่าในขั้นตอนก่อนหน้าเมื่อตั้งค่าบัญชีผู้ขาย Worldpay มี
description คำอธิบายของผู้ให้บริการชำระเงิน ไม่ได้
endpoint ปลายทางเพื่อเข้าถึงผู้ให้บริการชำระเงิน
  • สำหรับบัญชีทดสอบ ให้ใช้ปุ่มต่อไปนี้ https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp
  • สำหรับบัญชีที่ใช้งานจริง ให้ใช้รูปแบบต่อไปนี้ https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp
มี
merchantCode รหัสผู้ขายที่ผู้ให้บริการชำระเงินมอบให้กับผู้บริโภคของ API มี
name ชื่อที่ใช้สำหรับผู้ให้บริการ

ลูกค้า Apigee Edge Private Cloud เท่านั้น: สำหรับผู้ให้บริการชำระเงินทั่วโลก โปรดตรวจสอบว่าชื่อดังกล่าวไม่ซ้ำกันในองค์กร Edge ทั้งหมด ขอแนะนำให้คุณใส่ WorldPay (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) ในชื่อผู้ให้บริการเพื่อให้ระบุได้ง่าย เช่น WorldPay test หรือ WorldPay prod. การเว้นวรรคในชื่อผู้ให้บริการจะแปลงเป็นขีดล่าง

มี

ตัวอย่างต่อไปนี้ตั้งค่าบัญชีผู้ขายที่มี Worldpay ชื่อ Worldpay-myorg

$ curl  -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Worldpay-myorg",
    "description": "Worldpay payment provider",
    "endpoint": "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp",
    "authType": "123456",
    "credential": "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "merchantCode": "myMerchantCode"
  }' \
"https://api.enterprise.apigee.com/v1/organizations/myOrg/providers" \
-u email:password 

การดูผู้ให้บริการชำระเงินบุคคลที่สาม

ดูและยืนยันผู้ให้บริการชำระเงินบุคคลที่สามที่กำหนดค่าไว้สำหรับองค์กร Edge ของคุณ โดยส่งคำขอ GET ไปยังทรัพยากรต่อไปนี้

/mint/organizations/{org-name}/providers

ตัวอย่างต่อไปนี้แสดงผู้ให้บริการชำระเงินบุคคลที่สามที่กำหนดค่าสำหรับ myorg อยู่ในขณะนี้

$ curl  -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers" \
-u email:password

ต่อไปนี้เป็นตัวอย่างการตอบกลับที่แสดงบัญชีผู้ขาย 2 บัญชี บัญชีหนึ่งสำหรับการทดสอบและอีกบัญชีสำหรับเวอร์ชันที่ใช้งานจริง

{
  "provider" : [ {
    "authType" : "123456",
    "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "description" : "Worldpay payment provider",
    "endpoint" : "https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp",
    "id" : "worldpay-myorg",
    "merchantCode" : "MERCH_CODE",
    "name" : "Worldpay-myorg"
  }, {
    "authType" : "123456",
    "credential" : "dXNlcm5hbWU6cGFzc3dvcmQ=",
    "description" : "Worldpay payment provider",
    "endpoint" : "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp",
    "id" : "worldpay-test",
    "merchantCode" : "MERCH_CODE_FROM_PROVIDER",
    "name" : "Worldpay-test"
  } ]
}

การเปิดใช้และกำหนดค่าโมดูลการสร้างรายได้และ WorldPay ในพอร์ทัลนักพัฒนาซอฟต์แวร์

เปิดใช้โมดูลการสร้างรายได้และการชำระทั่วโลกที่จำเป็นในพอร์ทัลนักพัฒนาซอฟต์แวร์ ดูรายละเอียดได้ที่กำหนดค่าการสร้างรายได้ในพอร์ทัลนักพัฒนาแอป

เริ่มการชำระเงินไปยังบัญชีแบบชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงิน

ดังที่แสดงในขั้นตอนที่ 2 ของกระบวนการจัดการบัญชีแบบชำระล่วงหน้า การชำระเงินไปยังบัญชีแบบชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงินจะดำเนินการโดยพอร์ทัลนักพัฒนาซอฟต์แวร์เมื่อผู้ใช้ API ดำเนินการต่อไปนี้

  • ยอมรับแพ็กเกจราคา แต่มีเงินในบัญชีแบบชำระล่วงหน้าไม่เพียงพอ
  • ขอเติมเงินในบัญชีแบบชำระล่วงหน้า

หากต้องการเริ่มการชำระเงินจากผู้ให้บริการชำระเงินบุคคลที่สามโดยใช้ API ให้ส่งคำขอ POST ไปยังทรัพยากรต่อไปนี้ โดยที่ {developer_id} คืออีเมลของนักพัฒนาซอฟต์แวร์

/mint/organizations/{org_name}/developers/{developer_id}/payment?amount={amount}&provider={providerId}&supportedCurrencyId={currency}

เมื่อคุณส่งคำขอ คุณต้องระบุค่าต่อไปนี้เป็นพารามิเตอร์การค้นหา

  • จำนวนเงินที่จะเพิ่มลงในยอดคงเหลือในบัญชีชำระล่วงหน้า (amount={amount})
  • รหัสผู้ให้บริการชำระเงิน (provider={providerId})
  • สกุลเงินที่รองรับ (supportedCurrencyId={currency})

นอกจากนี้ คุณต้องส่งรายละเอียดพื้นฐานของบัญชี เช่น ที่อยู่สำหรับการเรียกเก็บเงินของบริษัท

ตัวอย่างต่อไปนี้โหลดยอดคงเหลือในบัญชีชำระล่วงหน้าซ้ำโดยใช้ผู้ให้บริการการชำระเงิน WorldPay การโอนครั้งแรกไปยังบัญชีแบบชำระเงินล่วงหน้าจะเป็น 10 ดอลลาร์สหรัฐ (amount ตั้งค่าพารามิเตอร์การค้นหาเป็น 10)

$ curl  -H "Content-Type:application/xml" -X POST -d \
'{
    "address1": "5115 Hopyard Ave.",
    "city": "Pleasanton",
    "country": "US",
    "state": "CA",
    "zip": "58158"
}'
' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/payment?amount=10&provider=worldpay-myorg&supportedCurrencyId=usd" \
-u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
    "isRecurring": "false",
    "orderCode": "1234",
    "referenceId": "3042815493",
    "referenceUrl": "https://secure.worldpay.com/wcc/dispatcher?OrderKey=MERCH_CODE_FROM_PROVIDER%5E1234",
    "success": "true"
}

ระบบจะแสดงผล URL ไปยังหน้าการชำระเงินที่ปลอดภัยทั่วโลกใน referenceUrl โดยมีคีย์คำสั่งซื้อที่ไม่ซ้ำกันต่อท้ายเป็นพารามิเตอร์การค้นหา

การโหลดยอดคงเหลือในบัญชีชำระล่วงหน้าอีกครั้งโดยใช้ API

ตามที่แสดงในขั้นตอนที่ 15 ของกระบวนการจัดการบัญชีแบบชำระล่วงหน้า เมื่อผู้ให้บริการชำระเงินยืนยันการดำเนินการเสร็จสมบูรณ์แล้ว พอร์ทัลนักพัฒนาซอฟต์แวร์จะส่งคำขอไปยัง Edge เพื่อโหลดบัญชีแบบชำระเงินล่วงหน้าซ้ำ

คุณโหลดยอดคงเหลือในบัญชีชำระล่วงหน้าอีกครั้งได้โดยใช้ API สำหรับนักพัฒนาซอฟต์แวร์หรือบริษัท ตามที่อธิบายไว้ในส่วนต่อไปนี้

การโหลดยอดคงเหลือที่ชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์อีกครั้ง

หากต้องการโหลดยอดเงินคงเหลือในบัญชีชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์ที่ใช้ API ซ้ำ ให้ส่งคำขอ POST ไปยัง /mint/organizations/{org_name}/developers/{developer_id}/developer-balances โดย {developer_id} คืออีเมลของนักพัฒนาซอฟต์แวร์ เมื่อส่งคําขอ คุณต้องระบุจํานวนเงินที่จะเพิ่มไปยังยอดคงเหลือและสกุลเงินที่ใช้ในส่วนเนื้อหาของคําขอ

ตัวอย่างเช่น คำขอต่อไปนี้จะเพิ่ม $1, 000 ในยอดคงเหลือบัญชีชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "amount": 1000,
  "supportedCurrency": {
      "id": "usd" 
  } 
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

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

การโหลดยอดคงเหลือในบัญชีชำระล่วงหน้าของบริษัทใหม่

หากต้องการโหลดยอดเงินคงเหลือในบัญชีชำระล่วงหน้าของบริษัทโดยใช้ API ให้ส่งคำขอ POST ไปยัง /mint/organizations/{org_name}/companies/{company_id}/developer-balances โดย {company_id} คือรหัสของบริษัท เมื่อส่งคําขอ คุณต้องระบุจํานวนเงินที่จะเพิ่มไปยังยอดคงเหลือและสกุลเงินที่ใช้ในส่วนเนื้อหาของคําขอ

ตัวอย่างเช่น คำขอต่อไปนี้เพิ่มเงิน $1, 000 ให้กับยอดคงเหลือในบัญชีแบบชำระล่วงหน้าของบริษัท

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "amount": 1000,
  "supportedCurrency": {
      "id": "usd" 
  } 
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

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

สรุปพร็อพเพอร์ตี้คำขอสำหรับการโหลดบัญชีแบบชำระล่วงหน้าซ้ำ

คุณต้องระบุพร็อพเพอร์ตี้ต่อไปนี้เมื่อโหลดยอดคงเหลือในบัญชีชำระล่วงหน้าอีกครั้งโดยใช้ API

ชื่อ คำอธิบาย ค่าเริ่มต้น จำเป็นหรือไม่
amount

จำนวนเงินจะใช้กับยอดเงินชำระล่วงหน้า (ในสกุลเงินที่เกี่ยวข้อง)

ไม่มีข้อมูล มี
supportedCurrency

สกุลเงินที่ใช้สำหรับยอดคงเหลือที่ชำระล่วงหน้า สกุลเงินนี้ได้รับการตั้งค่าสำหรับแพ็กเกจในแพ็กเกจ API ที่นักพัฒนาแอปซื้อ

ไม่มีข้อมูล มี

การลบผู้ให้บริการชำระเงินบุคคลที่สาม

คุณสามารถลบผู้ให้บริการชำระเงินบุคคลที่สามที่กำหนดค่าไว้สำหรับองค์กร Edge ได้โดยส่งคำขอลบไปยังแหล่งข้อมูลต่อไปนี้

หากต้องการลบผู้ให้บริการชำระเงินสำหรับองค์กรใดองค์กรหนึ่ง ให้ใช้ API ต่อไปนี้

/mint/organizations/{org-name}/providers/id

ลูกค้า Apigee Edge Private Cloud เท่านั้นที่มีสิทธิ์ของผู้ดูแลระบบสามารถเลือกลบผู้ให้บริการชำระเงินส่วนกลางได้โดยใช้ API ต่อไปนี้

/config/providers/id

ตัวอย่างเช่น รายการต่อไปนี้จะลบผู้ให้บริการชำระเงินบุคคลที่สามที่กำหนดค่าไว้สำหรับ myorg

$ curl  -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/providers/worldpay-myorg" \
-u email:password

การจัดการยอดคงเหลือในบัญชีชำระล่วงหน้าด้วยตนเอง

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

การตั้งค่าการโหลดซ้ำโดยอัตโนมัติสำหรับยอดเงินคงเหลือในบัญชีชำระล่วงหน้าโดยใช้ API

ส่วนต่อไปนี้จะอธิบายวิธีการโหลดซ้ำโดยอัตโนมัติสำหรับยอดเงินคงเหลือในบัญชีชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์หรือบริษัทที่ใช้ผู้ให้บริการชำระเงินบุคคลที่สาม ตัวเลือกนี้มีประโยชน์ในการจัดการการชำระเงินตามรอบสำหรับแพ็กเกจราคา

การตั้งค่าการโหลดซ้ำโดยอัตโนมัติสำหรับยอดเงินคงเหลือในบัญชีแบบชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์

หากต้องการตั้งค่าการโหลดซ้ำอัตโนมัติของยอดเงินคงเหลือในบัญชีแบบชำระล่วงหน้าสำหรับนักพัฒนาซอฟต์แวร์ เมื่อยอดคงเหลือต่ำกว่าเกณฑ์ที่กำหนด ให้ส่งคำขอ POST ไปที่ /mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup โดย {developer_id} คืออีเมลของนักพัฒนาซอฟต์แวร์

เมื่อส่งคําขอ คุณต้องระบุสิ่งต่อไปนี้

  • รหัสของผู้ให้บริการชำระเงินที่จะใช้โหลดบัญชีซ้ำ (providerID)
  • แฟล็กที่เปิดใช้การโหลดซ้ำอัตโนมัติ (isRecurring)
  • เกณฑ์ที่ยอดเงินคงเหลือในบัญชีชำระล่วงหน้าต้องลดลงต่ำกว่าจึงจะทริกเกอร์การโหลดซ้ำอัตโนมัติ (replenishAmount)
  • จำนวนเงินที่จะเพิ่มลงในบัญชีโดยอัตโนมัติ (recurringAmount)
  • พารามิเตอร์การค้นหา supportedCurrencyID เพื่อระบุสกุลเงิน

ในตัวอย่างต่อไปนี้ เมื่อยอดเงินคงเหลือในบัญชีแบบชำระล่วงหน้าของนักพัฒนาแอปลดลงต่ำกว่า 5 ดอลลาร์สหรัฐ ระบบจะเพิ่มดอลลาร์สหรัฐเพิ่มเติมอีก 10 ดอลลาร์สหรัฐลงในบัญชีโดยอัตโนมัติ

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "providerId": "worldpay-myorg",
    "isRecurring" : true,
    "replenishAmount" : 5,
    "recurringAmount" : 10
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \
-u email:password

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

การตั้งค่าการโหลดยอดคงเหลือในบัญชีชำระล่วงหน้าโดยอัตโนมัติสำหรับบริษัท

หากต้องการตั้งค่าการโหลดซ้ำโดยอัตโนมัติสำหรับยอดเงินคงเหลือในบัญชีแบบชำระล่วงหน้าสำหรับบริษัท เมื่อยอดคงเหลือต่ำกว่าจำนวนเงินที่กำหนด ให้ส่งคำขอ POST ไปยัง /mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup โดย {company_id} คือรหัสของบริษัท

เมื่อส่งคําขอ คุณต้องระบุสิ่งต่อไปนี้

  • รหัสของผู้ให้บริการชำระเงินที่จะใช้โหลดบัญชีซ้ำ (providerID)
  • แฟล็กที่เปิดใช้การโหลดซ้ำอัตโนมัติ (isRecurring)
  • เกณฑ์ที่ยอดเงินคงเหลือในบัญชีชำระล่วงหน้าต้องลดลงต่ำกว่าจึงจะทริกเกอร์การโหลดซ้ำอัตโนมัติ (replenishAmount)
  • จำนวนเงินที่จะเพิ่มลงในบัญชีโดยอัตโนมัติ (recurringAmount)
  • พารามิเตอร์การค้นหา supportedCurrencyID เพื่อระบุสกุลเงิน

ในตัวอย่างต่อไปนี้ เมื่อยอดคงเหลือในบัญชีชำระล่วงหน้าของบริษัทลดลงต่ำกว่า 5 ดอลลาร์สหรัฐ ระบบจะเพิ่มดอลลาร์สหรัฐเพิ่มเติมอีก 10 ดอลลาร์สหรัฐลงในบัญชีโดยอัตโนมัติ

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "providerId": "worldpay-myorg",
    "isRecurring" : true,
    "replenishAmount" : 5,
    "recurringAmount" : 10
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances/recurring-setup?supportedCurrencyId=usd" \
-u email:password

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

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

คุณระบุแอตทริบิวต์ต่อไปนี้ได้เมื่อโหลดยอดคงเหลือแบบชำระล่วงหน้าอีกครั้งโดยอัตโนมัติด้วย API

ชื่อ คำอธิบาย ค่าเริ่มต้น จำเป็นหรือไม่
providerId

รหัสของผู้ให้บริการชำระเงิน

ไม่มีข้อมูล มี
chargePerUsage false ไม่ได้
isRecurring

แฟล็กที่ระบุว่าเปิดใช้การโหลดซ้ำอัตโนมัติหรือไม่ (true) หากต้องการปิดใช้การโหลดซ้ำอัตโนมัติ ให้ตั้งค่าแฟล็กนี้เป็น false

ไม่มีข้อมูล มี
replenishAmount

เกณฑ์ที่ยอดเงินคงเหลือในบัญชีชำระล่วงหน้าต้องลดลงต่ำกว่าจึงจะทริกเกอร์การโหลดซ้ำอัตโนมัติได้

ไม่มีข้อมูล มี
recurringAmount

จำนวนเงินที่จะเพิ่มลงในยอดเงินคงเหลือของบัญชีชำระล่วงหน้าเมื่อมีการทริกเกอร์การโหลดซ้ำอัตโนมัติ

ไม่มีข้อมูล มี

การย้ายข้อมูลไปยังหน้าการชำระเงินที่โฮสต์ของ WorldPay

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

หากกำหนดค่าผู้ให้บริการชำระเงิน WorldPay โดยใช้ขั้นตอนการประมวลผลการชำระเงินที่ปลอดภัยที่เลิกใช้งานแล้ว (ก่อนเดือนสิงหาคม 2017) คุณจะต้องย้ายข้อมูลไปยังหน้าการชำระเงินที่โฮสต์ใหม่ของ WorldPay ก่อนเดือนมกราคม 2018

วิธีย้ายข้อมูลไปยังหน้าการชำระเงินที่โฮสต์ของ WorldPay

  1. ติดต่อ WorldPay เพื่อย้ายบัญชีปัจจุบันไปใช้หน้าการชำระเงินที่โฮสต์ใหม่และรับรหัสการติดตั้งใหม่สำหรับบัญชีของคุณ
  2. กำหนดค่าผู้ให้บริการชำระเงิน WorldPay รายใหม่ตามที่อธิบายไว้ในการกำหนดค่าผู้ให้บริการชำระเงินใน Edge โดยส่งรหัสการติดตั้งในช่อง authType
  3. กำหนดค่าผู้ให้บริการชำระเงินใหม่ในพอร์ทัลนักพัฒนาซอฟต์แวร์ตามที่อธิบายไว้ในกำหนดค่าการสร้างรายได้ในพอร์ทัลนักพัฒนาซอฟต์แวร์
  4. หากคุณตั้งค่าการโหลดซ้ำอัตโนมัติสำหรับบัญชีแบบชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงิน คุณจะต้องกำหนดค่าการโหลดซ้ำอัตโนมัติอีกครั้งเพื่อใช้รหัสผู้ให้บริการใหม่ตามที่อธิบายไว้ในการตั้งค่าการโหลดยอดคงเหลืออัตโนมัติสำหรับบัญชีแบบชำระล่วงหน้าโดยใช้ API

ขั้นตอนถัดไป

คุณสามารถตั้งวงเงินเครดิตสำหรับนักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลังแต่ละราย ดูวิธีการได้ในจัดการยอดคงเหลือแบบชำระเงินภายหลัง