ดึงข้อมูลยอดคงเหลือ

GEThttps://api.omise.co/balance

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

---

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

▼

---

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

ไม่จำเป็นต้องมีพารามิเตอร์สำหรับเอนด์พอยต์นี้

---

การตอบกลับ

200

คำขอสำเร็จ

คืนค่าออบเจ็กต์ยอดคงเหลือที่มีข้อมูลยอดคงเหลือปัจจุบันของบัญชี

ออบเจ็กต์ยอดคงเหลือประกอบด้วย:

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

ข้อควรทราบเกี่ยวกับจำนวนเงิน:

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

401

ข้อผิดพลาดการยืนยันตัวตน

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

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

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

---

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

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()

---

ลองใช้งาน