ดึงข้อมูล Balance

GEThttps://api.omise.co/balance

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

---

พารามิเตอร์คำขอ

ไม่ต้องระบุพารามิเตอร์สำหรับ endpoint นี้

---

การตอบกลับ

200

คำขอสำเร็จ

ส่งคืน balance object พร้อมข้อมูลยอดคงเหลือบัญชีปัจจุบัน

Balance object ประกอบด้วย:

• object - ค่าสตริง "balance"
• livemode - Boolean ระบุ live หรือ test mode
• location - เส้นทาง API endpoint "/balance"
• currency - รหัสสกุลเงิน ISO 4217 สามตัวอักษร
• total - ยอดคงเหลือรวมหลังหักค่าธรรมเนียม (ในหน่วยสกุลเงินที่เล็กที่สุด)
• transferable - จำนวนที่สามารถโอนไปยังบัญชีธนาคารได้
• reserve - จำนวนที่สำรองไว้ (ยังใช้ไม่ได้)
• on_hold - จำนวนที่ถูกระงับอยู่ในปัจจุบัน
• created_at - ISO 8601 timestamp

หมายเหตุเกี่ยวกับจำนวนเงิน:

• จำนวนเงินทั้งหมดอยู่ในหน่วยสกุลเงินที่เล็กที่สุด (สตางค์สำหรับ THB, เซนต์สำหรับ USD, เยนสำหรับ JPY)
• ยอดรวม = ที่โอนได้ + เงินสำรอง + ที่ถูกระงับ
• จำนวนที่โอนได้สามารถใช้สร้างการโอนได้

401

Unauthorized

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือหายไป

สาเหตุทั่วไป:

• ขาด Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

5xx

Server error

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ สิ่งเหล่านี้หายากแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลอง request ใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/balance \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

balance = Omise::Balance.retrieve

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

balance = omise.Balance.retrieve()

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const balance = await omise.balance.retrieve();

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$balance = OmiseBalance::retrieve();

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Balance balance = client.balance().get();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var balance = await client.Balance.Get();

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

balance, _ := client.Balance().Get()

---

🔑ข้อมูลยืนยันตัวตน API

▼

ลองใช้งาน

IP ของคุณ: ...กำลังโหลด...