Withdrawal

Withdrawal API

Withdraw Payout Order

POST https://example.com/auto/withdraw

Headers

Name	Type	Description
x-partnerid*	String	partner id
x-signature*	String	signature
Content-Type*	application/json	-

Request Body

Name	Type	Description
refId*	String	reference/transaction id
amount*	Number	Amount
userId*	String	user Id
accountName*	String	Account Name
accountNo*	String	Account Number
bankCode*	String	Bank Code
key*	String	Bank Key
extendParams	Object	For adding data to be returned in the callback.
timestamp*	Date	ISO Date (UTC+0)

Example Request

{
    "refId": "REF_ID",
    "amount": 100,
    "userId": "USER_ID",
    "accountName": "ekpay",
    "accountNo": "1234567890",
    "bankCode": "KBANK",
    "key": "KEY",
    "extendParams": {
        "username": "ekpay",
    },
    "timestamp": "2023-02-05T16:34:57.956Z"
}

200: OK Success

{
    "data": {
        "status": "QUEUED", //"QUEUED" or "PAYING" 
        "refId": "REF_ID",
        "transactionId": "TRANSACTION_ID",
        "amount": 100,
        "method": "Payout",
        "payee": {
            "accountNo": "1112223333",
            "accountName": "ekpay",
            "bankCode": "KBANK",
        },
        "extendParams": {
            "username": "ekpay",
        },
        "fee": 0,
        "transferAmount": 100,
        "successTime": null,
        "timestamp": "2023-02-05T16:25:23.708Z"
    },
    "code": 0,
    "msg": "Success",
    "cause": ""
}

400: Unable to process

หมายเหตุ

ทางเราแนะนำให้ใช้ค่าจาก code ในการตรวจสอบว่าทำรายการสำเร็จไหมแทนนะครับ

code == 0 หมายถึง ทาง ekpay ได้นำรายการเข้าระบบแล้ว

code != 0 หมายถึง ทำรายการไม่สำเร็จ