ดึงข้อมูลผู้รับเงิน

GEThttps://api.omise.co/recipients/:id

ดึงรายละเอียดของผู้รับเงินที่ระบุ รวมถึงสถานะการยืนยันตัวตนและข้อมูลบัญชีธนาคาร (ปกปิดเพื่อความปลอดภัย)

---

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

▼

---

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

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Recipient ID (ตัวอย่าง: recp_test_...) ระบุในเส้นทาง URL

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

สำเร็จ

ดึงข้อมูลผู้รับเงินสำเร็จ ส่งคืนออบเจ็กต์ผู้รับเงินที่สมบูรณ์พร้อมคุณสมบัติทั้งหมด

คุณสมบัติของผู้รับเงินที่ส่งคืน:

• id - ตัวระบุผู้รับเงิน
• verified - บัญชีธนาคารได้รับการยืนยันหรือไม่
• active - ผู้รับเงินสามารถรับการโอนเงินได้หรือไม่
• name, email, type - รายละเอียดผู้รับเงิน
• bank_account - รายละเอียดธนาคาร (หมายเลขบัญชีถูกปกปิด)
• metadata - เมทาดาทาที่กำหนดเอง

401

ไม่ได้รับอนุญาต

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

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

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

404

ไม่พบข้อมูล

ไม่พบผู้รับเงิน

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

• Recipient ID ไม่ถูกต้อง
• ผู้รับเงินไม่ได้อยู่ในบัญชีของคุณ
• ผู้รับเงินถูกลบไปแล้ว
• ผสม ID โหมดทดสอบและโหมดจริง

---

Code samples

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const recipient = await omise.recipients.retrieve('recp_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');

Java

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

Recipient recipient = client.recipients()
    .get("recp_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipient = await client.Recipients.Get("recp_test_5xuy4w91xqz7d1w9u0t");

Go

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

recipient, _ := client.Recipients().Get("recp_test_5xuy4w91xqz7d1w9u0t")

---

Try it out

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)