API ธุรกรรมชำระเงินเข้า

คำขอ

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

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

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
production: https://gateway.smilepayz.com/v2.0/transaction/pay-in

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

ฟิลด์	จำเป็น	ประเภท	คำอธิบาย
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+07: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	จำนวนธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด รูปแบบ: ค่าจำนวนเต็ม ตัวอย่าง: 200 แทน BRL 200.00 ช่วง: 100-999999999
payer	M	Object	ภาชนะข้อมูลผู้จ่าย ประกอบด้วยการระบุตัวตนลูกค้าและรายละเอียดการชำระเงิน ดู โมเดลผู้จ่าย
pixAccount	M	String	ตัวระบุบัญชี PIX (หมายเลข CPF หรือ CNPJ) รูปแบบ: 11 หลัก (CPF) หรือ 14 หลัก (CNPJ) ตัวอย่าง: "48982488880" ใช้สำหรับการประมวลผลการชำระเงิน PIX
paymentMethod	M	String	ข้อกำหนดวิธีการชำระเงิน ค่าคงที่: PIX กำหนดช่องทางการประมวลผลการชำระเงินและกฎ ดู รายการวิธีการชำระเงิน
expiryPeriod	O	Number	เวลาหมดอายุการชำระเงินเป็นวินาที รูปแบบ: ค่าจำนวนเต็ม ค่าเริ่มต้น: 3600 (1 ชั่วโมง) ช่วง: 3600-86400 (60 นาทีถึง 24 ชั่วโมง)
redirectUrl	O	String(256)	URL การเปลี่ยนเส้นทางลูกค้าหลังจากเสร็จสิ้นการชำระเงิน รูปแบบ: URL HTTP/HTTPS ที่ถูกต้อง ความยาวสูงสุด: 256 ตัวอักษร ใช้สำหรับประสบการณ์ลูกค้าหลังการชำระเงิน

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

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

{
    "merchant": {
        "merchantId": "20011"
    },
    "payer": {
        "pixAccount": "48982488880"
    },
    "money": {
      "amount": 20000,
        "currency": "BRL"
    },
    "orderNo": "200110edbb466abb04682968b40",
    "paymentMethod": "PIX",
    "purpose": "Purpose For Transaction from Java SDK",
    "redirectUrl": "https://www.google.com/webhp"
}

การตอบสนอง

การตอบสนอง 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+07: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	จำนวนธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด รูปแบบ: ค่าจำนวนเต็ม ตัวอย่าง: 200 แทน BRL 200.00 ใช้สำหรับการแสดงจำนวนที่แม่นยำ
transactionTime	M	String	วันที่และเวลาที่สร้างธุรกรรม รูปแบบ: yyyy-MM-ddTHH:mm:ss-03:00 (เขตเวลาบราซิล) ตัวอย่าง: 2020-12-17T10:55:00-03:00 ใช้สำหรับการติดตามเวลาและการตรวจสอบ
channel	M	Object	ภาชนะข้อมูลช่องทางการชำระเงิน ประกอบด้วยรายละเอียดวิธีการชำระเงินและข้อมูลการประมวลผล ดู โมเดลช่องทางการชำระเงิน
paymentMethod	M	String	วิธีการชำระเงินที่ใช้สำหรับการประมวลผลธุรกรรม รูปแบบ: รหัสวิธีการชำระเงินที่กำหนดไว้ล่วงหน้า ค่าคงที่: PIX ระบุช่องทางการชำระเงินที่ใช้จริง
paymentUrl	M	String	URL สำหรับการเข้าถึงการประมวลผลการชำระเงินสำหรับลูกค้า รูปแบบ: URL HTTP/HTTPS ที่ถูกต้อง ใช้สำหรับการสำรวจการชำระเงินและการประมวลผล
qrString	O	String	สตริง QR รหัส PIX สำหรับแอปพลิเคชันการชำระเงินมือถือ รูปแบบ: สตริงรูปแบบ QR รหัส PIX ใช้สำหรับการประมวลผลการชำระเงินมือถือและความสะดวกสำหรับลูกค้า
additionalInfo	O	Object	ข้อมูลเพิ่มเติมสำหรับช่องทางที่เฉพาะเจาะจง รูปแบบ: วัตถุ JSON มีข้อมูลเพิ่มเติมสำหรับช่องทางการชำระเงินที่พร้อมใช้งานเมื่อมีการพร้อมใช้งาน
tradeNo	O	String	หมายเลขอ้างอิงธุรกรรมภายในสำหรับการติดตามระบบ รูปแบบ: สตริงตัวอักษรและตัวเลขที่สร้างโดยระบบ ใช้สำหรับการจัดการธุรกรรมภายในและการสนับสนุน
status	O	String	สถานะการประมวลผลธุรกรรมปัจจุบัน รูปแบบ: รหัสสถานะที่กำหนดไว้ ตัวอย่าง: PROCESSING, SUCCESS, FAILED, CANCELLED ระบุสถานะปัจจุบันของธุรกรรม ดู โมเดลสถานะธุรกรรม

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

{
    "channel": {
        "additionalInfo": {},
        "paymentMethod": "PIX",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
        "qrString": "00020101021226800014br.gov.bcb.pix2558pix.delbank.com.br/v2/cob/vcharge1f6aed0623644c24bbdc174ce5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304BC39"
    },
    "code": "00",
    "merchant": {
        "accountNo": "11320011202402290943",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "Successful",
    "money": {
      "amount": 2000,
        "currency": "BRL"
    },
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "status": "PROCESSING",
    "tradeNo": "131200112412130836186234",
    "transactionTime": "2024-12-12T23:36:19-03:00"
}

{
    "channel": {
        "additionalInfo": {
            "paymentUrl": "https://gateway.smilepayz.com/cashier/#/transfer"
        },        
        "paymentMethod": "PIX",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
        "qrString": ""
    },
    "code": "00",
    "merchant": {
        "accountNo": "11320011202402290943",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "Successful",
    "money": {
      "amount": 2000,
        "currency": "BRL"
    },
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "status": "PROCESSING",
    "tradeNo": "131200112412130836186234",
    "transactionTime": "2024-12-12T23:36:19-03:00"
}

แจ้งเตือน

คำขอ 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	วิธีการชำระเงินที่ใช้สำหรับการประมวลผลธุรกรรม รูปแบบ: รหัสวิธีการชำระเงินที่กำหนดไว้ล่วงหน้า ค่าคงที่: PIX ระบุช่องทางการชำระเงินที่ใช้จริง
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": 100000,
    "currency": "BRL"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "101200012410241325417215",
  "transactionTime": "2020-12-17T10:55:00-03:00"
}

SUCCESS