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

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

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

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

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

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

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

amount(335.50) - usage(34) = 229.50

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

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

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

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

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

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

พารามิเตอร์การค้นหา คำอธิบาย
all Flag ที่ระบุว่าจะแสดงแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false จำนวนแพ็กเกจ API ที่แสดงผลต่อหน้าจะกำหนดโดยพารามิเตอร์การค้นหา size ค่าเริ่มต้นคือ 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 Flag ที่ระบุว่าจะแสดงแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false จำนวนแพ็กเกจ API ที่แสดงผลต่อหน้าจะกำหนดโดยพารามิเตอร์การค้นหา size ค่าเริ่มต้นคือ 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 รูปต่อไปนี้แสดงวิธีจัดการยอดคงเหลือในบัญชีแบบชำระล่วงหน้า โดยใช้ผู้ให้บริการชำระเงิน Worldpay

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

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

ขั้นตอน คำอธิบาย
0 ขั้นตอนเบื้องต้น
ในฐานะผู้ให้บริการ API หากต้องการตั้งค่าผู้ให้บริการชำระเงินบุคคลที่สาม เช่น Worldpay คุณ ต้องทำดังนี้
1 หากต้องการทริกเกอร์โฟลว์ ผู้ใช้ API จะต้องทํางานอย่างใดอย่างหนึ่งต่อไปนี้ในพอร์ทัลนักพัฒนาแอป
  • เพิ่มเงินเข้าบัญชี
  • ยอมรับแพ็กเกจราคาที่มีเงินไม่เพียงพอ
2 พอร์ทัลนักพัฒนาซอฟต์แวร์จะเริ่มการชำระเงินผ่าน Edge สำหรับนักพัฒนาแอป โดยมีรหัสผู้ให้บริการ จำนวนเงินที่โหลดซ้ำ และสกุลเงิน ดูข้อมูลเกี่ยวกับการใช้ API เพื่อเริ่มการชำระเงินได้ที่เริ่มการชำระเงินไปยังบัญชีแบบชำระล่วงหน้าโดยใช้ผู้ให้บริการชำระเงิน
3 Edge ค้นหาผู้ให้บริการตามรหัสและพิจารณาว่าเป็นบัญชี Worldpay
4 Edge จะสร้างรหัสคำสั่งซื้อ
5 Edge สร้างคำสั่งชำระเงินใน Worldpay
6 Worldpay จะส่งคืนรหัสอ้างอิงสำหรับคำสั่งซื้อและ URL ที่จำกัดเวลาเพื่อดำเนินการตามคำสั่งซื้อ
7 การตอบกลับของ Worldpay จะได้รับการแปลงเป็นการตอบกลับ API การชำระเงิน /Edge ทั่วไป ซึ่ง จะส่งกลับไปยังพอร์ทัลนักพัฒนาซอฟต์แวร์เพื่อทำการเรียกที่เริ่มต้นในขั้นตอนที่ 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 Secret ที่กำหนดค่าไว้ทั้งใน Worldpay และพอร์ทัลนักพัฒนาซอฟต์แวร์
12 Worldpay จะเปลี่ยนเส้นทางเบราว์เซอร์ของผู้ใช้ API ไปยัง URL การเรียกกลับที่สำเร็จ (จากขั้นตอนที่ 8) โดยผนวก MAC เป็นพารามิเตอร์การค้นหาและจำนวนเงิน
13 เบราว์เซอร์เรียก URL ในพอร์ทัลนักพัฒนาซอฟต์แวร์พร้อมจำนวนและ MAC ที่ขอ
14 พอร์ทัลจะยืนยัน MAC กับ MAC Secret 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. ตั้งรหัสผ่านที่จะใช้เมื่อกำหนดค่าผู้ให้บริการชำระเงิน Worldpay ใน 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. เลื่อนระดับการเปลี่ยนแปลงโดยทำดังนี้
      • สำหรับสภาพแวดล้อมการทดสอบ ให้คลิกเลื่อนระดับในส่วนการออกแบบ เพื่อเลื่อนระดับจากสภาพแวดล้อมการออกแบบไปยังแซนด์บ็อกซ์
      • สำหรับสภาพแวดล้อมที่ใช้งานจริง ให้คลิกเลื่อนขั้นในส่วนSandbox เพื่อเลื่อนขั้นจาก Sandbox ไปยังเวอร์ชันที่ใช้งานจริง

การกำหนดค่าผู้ให้บริการชำระเงินใน 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 ใน พอร์ทัลนักพัฒนาซอฟต์แวร์

เปิดใช้โมดูลการสร้างรายได้และ 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 ของหน้าการชำระเงินที่ปลอดภัยของ Worldpay ใน 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} คือรหัสของบริษัท เมื่อส่งคำขอ คุณต้อง ระบุในส่วนเนื้อหาของคำขอถึงจำนวนเงินที่จะเพิ่มลงในยอดคงเหลือและสกุลเงินที่ใช้

เช่น คำขอต่อไปนี้จะเพิ่มเงิน 30, 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 ได้โดยการส่งคำขอ DELETE ไปยังทรัพยากรต่อไปนี้

หากต้องการลบผู้ให้บริการชำระเงินสำหรับองค์กรที่เฉพาะเจาะจง ให้ใช้ 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)
  • Flag ที่เปิดใช้การเติมเงินอัตโนมัติ (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)
  • Flag ที่เปิดใช้การเติมเงินอัตโนมัติ (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 เท็จ ไม่
isRecurring

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

ไม่มี ใช่
replenishAmount

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

ไม่มี ใช่
recurringAmount

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

ไม่มี ใช่

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

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

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

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

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

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

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