API ธุรกรรมจ่ายเงินออก

คำขอ

API จ่ายเงินออกช่วยให้พ่อค้าเริ่มต้นธุรกรรมการจ่ายเงินให้กับผู้รับต่างๆ รวมถึงพนักงาน ลูกค้า ผู้จัดจำหน่าย และพันธมิตร API นี้รองรับวิธีการชำระเงินหลายวิธีสำหรับการโอนเงินที่ปลอดภัยและมีประสิทธิภาพในตลาดบราซิล

เส้นทางคำขอ:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out

พารามิเตอร์ส่วนหัว

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	ข้อกำหนดประเภทเนื้อหา HTTP ค่าคงที่: application/json จำเป็นสำหรับการแยกวิเคราะห์คำขอที่เหมาะสม
X-TIMESTAMP	M	String	รูปแบบวันที่เวลา ISO 8601 พร้อมออฟเซ็ตเขตเวลา รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm ตัวอย่าง: 2020-12-17T10:55:00-03:00 หมายเหตุ: ต้องเป็นเวลาของเซิร์ฟเวอร์ปัจจุบันภายใน ±5 นาที
X-SIGNATURE	M	String	ลายเซ็นดิจิทัลสำหรับการยืนยันตัวตนคำขอ ดู การสร้างลายเซ็น
X-PARTNER-ID	M	String	ตัวระบุพ่อค้าเฉพาะที่กำหนดโดยแพลตฟอร์ม รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการยืนยันตัวตนพ่อค้าและการกำหนดเส้นทางธุรกรรม กรุณาใส่ merchantID

พารามิเตอร์เนื้อหา

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
orderNo	M	String(32)	ตัวระบุธุรกรรมเฉพาะ รูปแบบ: สตริงตัวอักษรและตัวเลข (เฉพาะตัวเลขและตัวอักษร) ความยาว: 6-32 ตัวอักษร ใช้สำหรับการติดตามธุรกรรมและการอ้างอิง
purpose	M	String(64)	วัตถุประสงค์หรือคำอธิบายธุรกรรม รูปแบบ: สตริงที่เข้ารหัส UTF-8 ความยาวสูงสุด: 64 ตัวอักษร ใช้สำหรับการระบุธุรกรรมและการรายงาน
merchant	M	Object	ภาชนะข้อมูลพ่อค้า ประกอบด้วยการระบุตัวตนพ่อค้าและรายละเอียดธุรกิจ ดู โมเดลพ่อค้า
merchantId	M	String	ตัวระบุพ่อค้าหลักที่กำหนดโดยแพลตฟอร์ม รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการยืนยันตัวตนพ่อค้าและการกำหนดเส้นทางธุรกรรม
merchantName	O	String	ชื่อธุรกิจหรือชื่อแสดงผลของพ่อค้า รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุธุรกรรมและการรายงาน
subMerchantId	O	String	ตัวระบุพ่อค้าย่อยสำหรับโครงสร้างพ่อค้าหลายระดับ รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการกำหนดเส้นทางธุรกรรมพ่อค้าย่อย
subMerchantName	O	String	ชื่อธุรกิจหรือชื่อแสดงผลของพ่อค้าย่อย รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุตัวตนพ่อค้าย่อยและการรายงาน
money	M	Object	รายละเอียดจำนวนธุรกรรมพร้อมข้อกำหนดสกุลเงิน ประกอบด้วยจำนวนการชำระเงินและข้อมูลสกุลเงิน ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: BRL (เรอัลบราซิล) กำหนดกฎการประมวลผลการชำระเงินและสกุลเงินการชำระบัญชี
amount	M	Number	จำนวนธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด รูปแบบ: ค่าจำนวนเต็ม ตัวอย่าง: 100 แทน BRL 100.00 ช่วง: 100-999999999
paymentMethod	M	String(6)	ข้อกำหนดวิธีการชำระเงิน รูปแบบ: รหัสวิธีการชำระเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: CPF, CNPJ, PHONE, EMAIL, EVP กำหนดช่องทางการประมวลผลการชำระเงินและกฎ ดู รายการวิธีการชำระเงิน
cashAccount	M	String(32)	ตัวระบุบัญชีผู้รับ รูปแบบ: หมายเลขบัญชี CPF/CNPJ/โทรศัพท์/อีเมล/EVP ตัวอย่าง: "12532481501" (CPF), "+5511999999999" (PHONE) ใช้สำหรับการจ่ายเงินให้ผู้รับ
receiver	M	Object	ภาชนะข้อมูลผู้รับ ประกอบด้วยการระบุตัวตนผู้รับและรายละเอียดการยืนยัน ดู โมเดลผู้รับ
taxNumber	M	String	หมายเลขประจำตัวผู้เสียภาษีของผู้รับ รูปแบบ: CPF (11 หลัก) หรือ CNPJ (14 หลัก) ตัวอย่าง: "12345678909" ใช้สำหรับการยืนยันผู้รับและการปฏิบัติตามกฎระเบียบ
callbackUrl	O	String(256)	URL การแจ้งเตือน Webhook สำหรับการอัปเดตสถานะธุรกรรม รูปแบบ: URL HTTP/HTTPS ที่ถูกต้อง ความยาวสูงสุด: 256 ตัวอักษร ใช้สำหรับการแจ้งเตือนสถานะธุรกรรมแบบเรียลไทม์
additionalParam	O	Object	พารามิเตอร์ธุรกรรมเพิ่มเติม รูปแบบ: วัตถุ JSON มีรายละเอียดธุรกรรมเพิ่มเติมเมื่อจำเป็น

ตัวอย่างเนื้อหา – คำขอธุรกรรมจ่ายเงินออก:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "additionalParam": {},
    "cashAccount": "12532481501",
    "receiver": {
        "taxNumber": "12345678909"
    },
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 10000,
        "currency": "BRL"
    },
    "orderNo": "2000102900000000000001",
    "paymentMethod": "CPF",
    "purpose": "Purpose For Disbursement from Java SDK"
}

การตอบสนอง

การตอบสนอง HTTP

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	ข้อกำหนดประเภทเนื้อหาการตอบสนอง HTTP ค่าคงที่: application/json ระบุรูปแบบการตอบสนอง JSON
X-TIMESTAMP	M	String	รูปแบบวันที่เวลา ISO 8601 พร้อมออฟเซ็ตเขตเวลา รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm ตัวอย่าง: 2020-12-17T10:55:00-03:00

พารามิเตอร์เนื้อหา

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
code	M	String	รหัสสถานะการตอบสนอง API ที่ระบุผลลัพธ์การดำเนินการ รูปแบบ: สตริงสองหลัก สำเร็จ: "00", ข้อผิดพลาด: รหัสอื่นๆ ใช้สำหรับการจัดการการตอบสนองแบบโปรแกรม
message	M	String	คำอธิบายสถานะการตอบสนองที่อ่านได้โดยมนุษย์ รูปแบบ: สตริงที่เข้ารหัส UTF-8 ให้ข้อมูลรายละเอียดเกี่ยวกับผลลัพธ์การดำเนินการ แปลเป็นภาษาตามภาษาของคำขอ
orderNo	M	String	หมายเลขอ้างอิงธุรกรรมพ่อค้า รูปแบบ: สตริงตัวอักษรและตัวเลข เหมือนกับ orderNo ที่ให้ในคำขอ ใช้สำหรับการติดตามธุรกรรมและการอ้างอิง
merchant	M	Object	ภาชนะข้อมูลพ่อค้า ประกอบด้วยการระบุตัวตนพ่อค้าและรายละเอียดธุรกิจ ดู โมเดลพ่อค้า
merchantId	M	String	ตัวระบุพ่อค้าหลักที่กำหนดโดยแพลตฟอร์ม รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการยืนยันตัวตนพ่อค้าและการกำหนดเส้นทางธุรกรรม
merchantName	O	String	ชื่อธุรกิจหรือชื่อแสดงผลของพ่อค้า รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุธุรกรรมและการรายงาน
subMerchantId	O	String	ตัวระบุพ่อค้าย่อยสำหรับโครงสร้างพ่อค้าหลายระดับ รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการกำหนดเส้นทางธุรกรรมพ่อค้าย่อย
subMerchantName	O	String	ชื่อธุรกิจหรือชื่อแสดงผลของพ่อค้าย่อย รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุตัวตนพ่อค้าย่อยและการรายงาน
accountNo	O	String	หมายเลขบัญชาพ่อค้าสำหรับการชำระบัญชีธุรกรรม รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการจัดสรรเงินและการชำระบัญชี
money	M	Object	รายละเอียดจำนวนธุรกรรมพร้อมข้อกำหนดสกุลเงิน ประกอบด้วยจำนวนธุรกรรมที่ยืนยันและสกุลเงิน ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: BRL (เรอัลบราซิล) กำหนดกฎการประมวลผลการชำระเงินและสกุลเงินการชำระบัญชี
amount	M	Number	จำนวนธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด รูปแบบ: ค่าจำนวนเต็ม ตัวอย่าง: 100 แทน BRL 100.00 ใช้สำหรับการแสดงจำนวนที่แม่นยำ
disbursementTime	M	String	วันที่และเวลาที่สร้างธุรกรรม รูปแบบ: yyyy-MM-ddTHH:mm:ss-03:00 (เขตเวลาบราซิล) ตัวอย่าง: 2020-12-17T10:55:00-03:00 ใช้สำหรับการติดตามเวลาและการตรวจสอบ
channel	M	Object	ภาชนะข้อมูลช่องทางการชำระเงิน ประกอบด้วยรายละเอียดวิธีการชำระเงินและข้อมูลการประมวลผล ดู โมเดลช่องทาง
paymentMethod	M	String	วิธีการชำระเงินที่ใช้สำหรับการประมวลผลธุรกรรม รูปแบบ: รหัสวิธีการชำระเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: CPF, CNPJ, PHONE, EMAIL, EVP ระบุช่องทางการชำระเงินที่ใช้จริง
cashAccount	M	String	ตัวระบุบัญชีผู้รับที่ใช้สำหรับการจ่ายเงิน รูปแบบ: หมายเลขบัญชี CPF/CNPJ/โทรศัพท์/อีเมล/EVP ใช้สำหรับการจ่ายเงินให้ผู้รับ
accountName	O	String	ชื่อผู้ถือบัญชีผู้รับ รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุตัวตนผู้รับและการยืนยัน
tradeNo	O	String	หมายเลขอ้างอิงธุรกรรมภายในสำหรับการติดตามระบบ รูปแบบ: สตริงตัวอักษรและตัวเลขที่สร้างโดยระบบ ใช้สำหรับการจัดการธุรกรรมภายในและการสนับสนุน
status	O	String	สถานะการประมวลผลธุรกรรมปัจจุบัน รูปแบบ: รหัสสถานะที่กำหนดไว้ล่วงหน้า ตัวอย่าง: PROCESSING, SUCCESS, FAILED, CANCELLED ระบุสถานะปัจจุบันของธุรกรรม ดู โมเดลสถานะ

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00

{
  "code": "00",
  "message": "สำเร็จ",
  "orderNo": "2000102900000000000001",
  "tradeNo": "1022000109e998347483949",
  "status": "PROCESSING",
  "disbursementTime": "2020-12-17T10:55:00-03:00",
  "merchant": {
    "merchantId": "20001",
    "merchantName": "test",
    "accountNo": "2000124234782342"
  },
  "money": {
    "currency": "BRL",
    "amount": 10000
  },
  "channel": {
    "paymentMethod": "CPF",
    "cashAccount": "12532481501",
    "accountName": "Betty"
  }
}

การแจ้งเตือน

คำขอ HTTP

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
Content-Type	M	String	ข้อกำหนดประเภทเนื้อหา HTTP สำหรับคำขอ ค่าคงที่: application/json ระบุรูปแบบคำขอ JSON
X-TIMESTAMP	M	String	รูปแบบวันที่เวลา ISO 8601 พร้อมออฟเซ็ตเขตเวลา รูปแบบ: yyyy-MM-ddTHH:mm:ss±HH:mm ตัวอย่าง: 2020-12-17T10:55:00-03:00
X-SIGNATURE	M	String	ลายเซ็นดิจิทัลสำหรับการยืนยันตัวตนการแจ้งเตือน ดู การยืนยันลายเซ็นการแจ้งเตือน

พารามิเตอร์เนื้อหา

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
orderNo	M	String	หมายเลขอ้างอิงธุรกรรมพ่อค้า รูปแบบ: สตริงตัวอักษรและตัวเลข เหมือนกับ orderNo ที่ให้ในคำขอ ใช้สำหรับการติดตามธุรกรรมและการอ้างอิง
tradeNo	M	String	หมายเลขอ้างอิงธุรกรรมภายในสำหรับการติดตามระบบ รูปแบบ: สตริงตัวอักษรและตัวเลขที่สร้างโดยระบบ ใช้สำหรับการจัดการธุรกรรมภายในและการสนับสนุน
merchantId	M	String	ตัวระบุพ่อค้าหลักที่กำหนดโดยแพลตฟอร์ม รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการยืนยันตัวตนพ่อค้าและการกำหนดเส้นทางธุรกรรม
merchantName	M	String	ชื่อธุรกิจหรือชื่อแสดงผลของพ่อค้า รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุธุรกรรมและการรายงาน
subMerchantId	O	String	ตัวระบุพ่อค้าย่อยสำหรับโครงสร้างพ่อค้าหลายระดับ รูปแบบ: สตริงตัวอักษรและตัวเลข ใช้สำหรับการกำหนดเส้นทางธุรกรรมพ่อค้าย่อย
subMerchantName	O	String	ชื่อธุรกิจหรือชื่อแสดงผลของพ่อค้าย่อย รูปแบบ: สตริงที่เข้ารหัส UTF-8 ใช้สำหรับการระบุตัวตนพ่อค้าย่อยและการรายงาน
paymentMethod	M	String	วิธีการชำระเงินที่ใช้สำหรับการประมวลผลธุรกรรม รูปแบบ: รหัสวิธีการชำระเงินที่กำหนดไว้ล่วงหน้า ตัวอย่าง: CPF, CNPJ, PHONE, EMAIL, EVP ระบุช่องทางการชำระเงินที่ใช้จริง
transactionTime	M	String	วันที่และเวลาที่เสร็จสิ้นธุรกรรม รูปแบบ: yyyy-MM-ddTHH:mm:ss ตัวอย่าง: 2020-12-17T10:55:00-03:00 ใช้สำหรับการติดตามเวลาและการตรวจสอบ
money	M	Object	รายละเอียดจำนวนธุรกรรมพร้อมข้อกำหนดสกุลเงิน ประกอบด้วยจำนวนธุรกรรมที่ยืนยันและสกุลเงิน ดู โมเดลเงิน
currency	M	String	ข้อกำหนดรหัสสกุลเงิน ISO 4217 ค่าคงที่: BRL (เรอัลบราซิล) กำหนดกฎการประมวลผลการชำระเงินและสกุลเงินการชำระบัญชี
amount	M	Number	จำนวนธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด รูปแบบ: ค่าจำนวนเต็ม ตัวอย่าง: 100 แทน BRL 100.00 ใช้สำหรับการแสดงจำนวนที่แม่นยำ
status	M	String	สถานะการประมวลผลธุรกรรมสุดท้าย รูปแบบ: รหัสสถานะที่กำหนดไว้ล่วงหน้า ตัวอย่าง: SUCCESS, FAILED, CANCELLED ระบุสถานะสุดท้ายของธุรกรรม ดู โมเดลสถานะ

การคืนค่า

สำคัญ

การแจ้งเตือนกรุณาคืนเฉพาะสตริง SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 10000,
    "currency": "BRL"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "1022000109e998347483949",
  "transactionTime": "2020-12-17T10:55:00-03:00"
}

SUCCESS