Announcement

Terms and Conditions

**We would like to inform you that merchants should consider maintaining a balance in their wallets. In case of a freeze by the service-providing bank, legal issues, or actions by government authorities, we will not be held responsible under any circumstances.

Merchants can set a deposit limit in the menu. Settings > Deposit limit

ข้อกำหนดเเละเงื่อนไข

**ทางเราข้อเเจ้งให้ท่านทราบว่า ขอให้ร้านค้าพิจราณาการคงเงินเหลือไว้ในกระเป๋าของท่าน หากเกิดการอายัดจากทางธนาคารผู้ให้บริการ หรือเกิดจากคดีความ เเละ เจ้าหน้าที่รัฐ เราจะไม่รับผิดชอบทุกกรณี.

โดยร้านค้าสามารถตั้งจำกัดวงเงินของการฝากได้ที่เมนู Settings > Deposit limit

Introduction

ASKMEPAY APIs This documentation describes the protocol of communication between a client and ambpayment and serves as a guide for arranging acceptance of payments for goods and (or) services. This documentation is designed for the software developers on the payee's edge.

Basic principles of communication

Before diving into the details of our API, we highly recommend that you first read through our API documentation. This comprehensive guide will provide you with essential information about obtaining and using your API key, understanding the various endpoints, and accessing our back office web page. Should you have any questions or need further assistance regarding the API key, endpoints, or any other related matters, please do not hesitate to contact our team. We are here to help ensure you have a smooth and successful experience with our API.

API - ASKMEPAY

Overview

Let's play

First, Get all service
Initital payment for deposit

Get All Service `POST`

JSON request example:

Request Body

{
    "username":"admin",
    "signature":"13a5afe60b165104fb26457d46fd61c0927ea426e9932595384e7ecd5289eedf"
}

JSON response example:

{
    "code": 0,
    "data": {},
    "message": "success",
    "result": [
        {
            "channel": "BANK_TRANSFER",
            "img_provider": "https://i.ibb.co/JzKJsSp/THLogo-01.png",
            "method": "THPAY",
            "services": [
                {
                    "active": true,
                    "channel": "BANK_TRANSFER",
                    "currency": "THB",
                    "hasActiveDepositService": true,
                    "hasActiveWithdrawService": true,
                    "image_url": "https://i.ibb.co/1G0Ywn3/rsz-thlogo-01.png",
                    "isBankAccountRequire": true,
                    "maximum_deposit": 500000,
                    "maximum_withdraw": 2000000,
                    "merchant_fee": 1.5,
                    "merchant_fee_type": "P",
                    "payout_fee": 0.5,
                    "payout_fee_type": "P",
                    "merchant_minimum_fee": 0,
                    "merchant_minimum_fee_type": "B",
                    "minimum_deposit": 30,
                    "minimum_withdraw": 20,
                    "network": "BANK_THB",
                    "option": [],
                    "provider": "BANK TRANSFER",
                    "provider_alias_name": "Bank transfer (Thailand)",
                    "service_id": 100,
                    "service_name": "BANK TRANSFER",
                    "type": "FIAT"
                }
            ]
        },
        {
            "channel": "GCASH",
            "img_provider": "https://i.ibb.co/wyQz5Gb/gcash.webp",
            "method": "GCASH",
            "services": [
                {
                    "active": true,
                    "channel": "GCASH",
                    "currency": "PHP",
                    "hasActiveDepositService": true,
                    "hasActiveWithdrawService": true,
                    "image_url": "https://i.ibb.co/1G0Ywn3/rsz-thlogo-01.png",
                    "isBankAccountRequire": false,
                    "maximum_deposit": 100000,
                    "maximum_withdraw": 50000,
                    "merchant_fee": 2.6,
                    "merchant_fee_type": "P",
                    "payout_fee": 0.5,
                    "payout_fee_type": "P",
                    "merchant_minimum_fee": 0,
                    "merchant_minimum_fee_type": "B",
                    "minimum_deposit": 50,
                    "minimum_withdraw": 100,
                    "network": "BANK_PH",
                    "option": [],
                    "provider": "GCASH",
                    "provider_alias_name": "Gcash",
                    "service_id": 300,
                    "service_name": "GCASH",
                    "type": "FIAT"
                }
            ]
        },
        {
            "channel": "USDT",
            "img_provider": "https://i.ibb.co/PvN7qdTL/usdt.png",
            "method": "USDT",
            "services": [
                {
                    "active": true,
                    "channel": "USDT",
                    "currency": "INR",
                    "hasActiveDepositService": true,
                    "hasActiveWithdrawService": true,
                    "image_url": "https://i.ibb.co/1G0Ywn3/rsz-thlogo-01.png",
                    "isBankAccountRequire": true,
                    "maximum_deposit": 200000,
                    "maximum_withdraw": 200000,
                    "merchant_fee": 50,
                    "merchant_fee_type": "P",
                    "payout_fee": 0.5,
                    "payout_fee_type": "P",
                    "merchant_minimum_fee": 0,
                    "merchant_minimum_fee_type": "B",
                    "minimum_deposit": 1,
                    "minimum_withdraw": 1,
                    "network": "CRYPTO_USDT",
                    "option": [],
                    "provider": "USDT",
                    "provider_alias_name": "USDT",
                    "service_id": 510,
                    "service_name": "USDT",
                    "type": "CRYPTO"
                }
            ]
        }
    ]
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/v4/get-all-service

Content Type

Type: application/json

Parameter Description

User can get all avaliable payment method.

Property	Type	Require	Description
`username`	string	Y	Username of Merchant account
`signature`	string	Y	HmacSha256(`username=${username}`,secret_key)

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	GetAllServiceData	Y	Return data as Array.

Get All Service Data

Property	Type	Require	Description
`channel`	string	Y	Payment channel (e.g., BANK_TRANSFER, GCASH, UPI).
`img_provider`	string	Y	Provider logo URL.
`method`	string	Y	Method of service (e.g., THPAY, GCASH, UPI).
`services`	ServicesData	Y	List of services provided under this channel.

Services Data

Property	Type	Require	Description
`active`	boolean	Y	Service availability.
`channel`	string	Y	Payment channel.
`currency`	string	Y	Currency of payment.
`hasActiveDepositService`	boolean	Y	Indicates if deposit service is active.
`hasActiveWithdrawService`	boolean	Y	Indicates if withdraw service is active.
`image_url`	string	Y	Logo URL.
`isBankAccountRequire`	boolean	Y	Whether bank account is required.
`maximum_deposit`	number	Y	Maximum deposit allowed.
`maximum_withdraw`	number	Y	Maximum withdrawal allowed.
`merchant_fee`	number	Y	Transaction fee.
`merchant_fee_type`	string	Y	Type of fee P = percent, B = baht/fixed.
`payout_fee`	number	Y	Payout fee.
`payout_fee_type`	string	Y	Type of fee P = percent, B = baht/fixed.
`merchant_minimum_fee`	number	Y	Minimum transaction fee charges to merchant.
`merchant_minimum_fee_type`	string	Y	Always charges as Baht or Percent.
`minimum_deposit`	number	Y	Minimum deposit allowed.
`minimum_withdraw`	number	Y	Minimum withdrawal allowed.
`network`	string	Y	Blockchain or network identifier.
`option`	array	Y	Optional configuration details.
`provider`	string	Y	Provider name.
`provider_alias_name`	string	Y	Provider display name.
`service_id`	number	Y	Service ID used for transaction creation.
`service_name`	string	Y	Service description/name.
`type`	string	Y	Type of service, FIAT or CRYPTO.

Initial Payment `POST`

JSON request example:

Request Body

{
    "service_id": "100",
    "amount": 1,
    "bank_name":"SCB",
    "public_key": "a48a6e20-8d02-11ed-b118-4bbf84c800c9",
    "payer_name":"mike suan",
    "payer_mobile":"",
    "payer_email":"",
    "payer_account_no": "020295778772",
    "payer_account_name":"",
    "payer_account_first_name":"ไมค์",
    "payer_account_last_name": "สวน",
    "payer_account_first_name_en":"mike",
    "payer_account_last_name_en": "suan",
    "signature":"0739aa70efa58d155c8830ab1aa698859f12e0878c748107e846bcd7175c1ded",
    "payer_username": "abc1234",
    "redirect_url": "",
    "remark": "",  
}

JSON response example:

{
"code": 0,
"message": "success",
"result": {
    "qr_link": "https://dev2.autoeasy.me/?value=iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAIAAAD2HxkiAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAN2klEQVR4nO3de4xU5R3G8ffMzM4u48IuC6wQRIUgNd5ja6ME
jb2k1mpQaworTb1UUYtNjcTUhFgr0lpDau0FG6VeqhWweElbS4wo2ihIEdC2CFTURbnIbdnlsiy7szPn9I8dtxvlzOyZPWef9yzfT0g0zDnvvDs7D2dmfvN7X8d1XQNAJ6GeAHC0S3X9J5GIRxrDum77/bxxHz9qfvNnPuXpmn88
EUJAjBACYoQQECOEgBghBMQIISDmhNtRFvc6Vdz76+JSv1XVRaPutyxvPlwJATFCCIgRQkCMEAJihBAQI4SAGCEExELuJ1TVYVT9ZmGxcz3M/hd0Prbtf+iHfkLAaoQQECOEgBghBMQIISBGCAExQgiIpYrfrNqXz7b1Qm3bt1D1
+AQVl/on+xMCRzVCCIgRQkCsxHtCaI0fPz6dTvfmyGw229zc3NzcHPWUEDpCaK9cLr/4+SWdXq8OTiVMVcJdu3b1/Pnzly9fHvHUECZCaKNNH+347aKXV/xrU2ZQZU2myjilTznY1nGg9fA5p4379UNPvv3mK7NmzWpqaop+pghB
oU1TtTrhfqJuh8yrPVabesz7J96I1dCQIwQAmKEEBAjhIAYIQTECCEgRggBsTLrhLatF+rHtnpUWPW6uNfT4r7fI/sTAgMKIQTECCEgRggBMUIIiBFCQIwQAmIl6oRR97lFLS51vKDjRH2/QUW9jqsf2+qB7E8IxBIhBMQIISBGC
AExQgiIEUJAjBACYk5cOgOBgYorISD2PzTXylDjMbvnAAAAAElFTkSuQmCC&type=base64",
    "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAIAAAD2HxkiAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAN2klEQVR4nO3de4xU5R3G8ffMzM4u48IuC6wQRIUgNd5ja6MEjb2k1mpQawor
Tb1UUYtNjcTUhFgr0lpDau0FG6VeqhWweElbS4wo2ihIEdC2CFTURbnIbdnlsiy7szPn9I8dtxvlzOyZPWef9yzfT0g0zDnvvDs7D2dmfvN7X8d1XQNAJ6GeAHC0S3X9J5GIRxrDum77/bxxHz9qfvNnPuXpmn885goMYIQQECOE
gBghBMQIISBGCAExQgiIpYrfrPo+TVh1HtvqdUHnE9bjEPTn9btf2+qBqnGCKv64cSUExAghIEYIATFCCIgRQkCMEAJihBAQK1En9KOqX/kJqx4YdJyg9b2g8wmrfmjbfGxbz0H7fOZKCIgRQkCMEAJihBAQI4SAGCEExAghIFZm
ndA2YdXroq6Dqep1ts0nqKj7QrW4EgJihBAQI4SAGCEExAghIEYIATFCCIgNkDqhStzrY6r+wIFd9wuKKyEgRggBMUIIiBFCQIwQAmKEEBAjhIBYmXXCuNRzoq7jBb1fP7btQxj179e25492PlwJATFCCIgRQkCMEAJihBAQI4SA
GCEExErUCaOup4XFtvUz476+qG3Hh8XO57ONcwKOKoQQECOEgBghBMQIISBGCAExQgqLhQsXBjqFEJZ3v34IYQD9H8Li9xv37cSjFq8Q8sEMIEYIATFCCIgRQkAs5F2ZVP1gQcXlAyE/tq1ryPOnvPkUzgphRgD6gBACYoQQECOE
CMEAJihBAQI4SAGCEExAghIFaoE8albhZ1HTLqvkHV+pxhUa0HG1b9k/0JARwBIQTECCEgRggBMUIIiBFCQIwQAmKp4jfHZb+7oMKqv0Xdh2nb/o1Rz8e2PsOg45c3f66EgBghBMQIISBGCAExQgiIEUJr+Pdv62YKOH/V8gh4fl
3py8XlyJQTECCEgRggBMUIIiBFCQIwQAmKEEBArs05oG9X+eFGvbxlW3UxVnwxr/KBU65eyPyEQS4QQECOEgBghBMQIISBGCAExQgiIDZA6YdT7/oU1TtTrhfqJuh8yrPVabesz7J96I1dCQIwQAmKEEBAjhIAYIQTECCEgRggBs
TLrhLatF+rHtnpUWPW6uNfT4r7fI/sTAgMKIQTECCEgRggBMUIIiBFCQIwQAmIl6oRR97lFLS51vKDjRH2/QUW9jqsf2+qB7E8IxBIhBMQIISBGCAExQgiIEUJAjBACYk5cOgOBgYorISD2PzTXylDjMbvnAAAAAElFTkSuQmCC",
    "service": "61",
    "id": "TRN202111103439860",
    "order": "VP1636550015",
    "amount": 100,
    "actual_amount": 98.5,
    "fee": 1.5,
    "key": "qrcode",
    "name": "QRCode",
    "description": "QR Code",
    "ref1": "202111103439860",
    "ref2": null,
    "crypto_amount": null,
    "convertion_rate": null,
    "currency": "THB",
    "address": null,
    "deposit_network": null,
    "represent_type": "QR",
    "timeout": {
            "days": "2024-07-08",
            "time": "16-29-51",
            "dateTime": "2024-07-08T16:29:51+07:00"
        },
    "type": "QR"
  }
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/v4/init-payment

Content Type

Type: application/json

Parameter Description

Property	Type	Require	Description
`service_id`	string	Y	Id inside "services" from api 2.Service Category (get-category).
`amount`	number	Y	Payment amount.
`bank_name`	string	Y	Customer's Bank Name. Appendix
`public_key`	string	Y	Public Key Generate by Askmepay.
`payer_name`	string	N	Customer's Fullname. Noted* Customer must pay with full name only.
`payer_mobile`	string	N	Customer's Phone number. Noted* Require for currency INR.
`payer_email`	string	N	Customer's Email. Noted* Require for currency INR.
`payer_account_no`	string	Y	Customer's Bank account number. Noted* Customer must pay with this bank account number only.
`payer_account_name`	string	N	Customer's Fullname.
`payer_account_first_name`	string	Y	Customer's Firstname. Noted* Customer must pay with bank account of the same firstname only.
`payer_account_last_name`	string	Y	Customer's Lastname. Noted* Customer must pay with bank account of the same lastname only.
`payer_account_first_name_en`	string	N	Customer's Firstname. in english. Noted* This will increase success rate in THB, Causes some banks send us name in English.
`payer_account_last_name_en`	string	N	Customer's Lastname. in english. Noted* This will increase success rate in THB, Causes some banks send us name in English.
`signature`	string	Y	HmacSha256(`public_key=${public_key}&service_id=${service_id}&amount=${amount}`,secret_key)
`payer_username`	string	N	Customer's Username Noted* This field is data provide for technical support.
`redirect_url`	string	N	For redirect to any page. Noted* If this field is not set, we will provide Askmepay banner.
`remark`	string	N	Any remark.
`type`	string	Y	"QR"

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	InitPaymentData	Y	Return data as Object.

Init Payment Data

Property	Type	Require	Description
`qr_link`	string	Y	Link for Qr code.
`value`	string	Y	Qr code as pnd;base64 format you can render by using "img src="data:image/png;base64,QR code value"".
`service`	string	Y	Service code for payment Gateway.
`id`	string	Y	Payment id for reference with bank.
`order`	string	Y	Order id for refernce with Askmepay.
`amount`	number	Y	Transaction amount.
`actual_amount`	number	Y	Transaction amount including fee.
`fee`	number	Y	Transaction fee.
`key`	string	Y	Type of payment channel.
`name`	string	Y	Type of service.
`description`	string	Y	"QR Code".
`ref1`	string	Y	Ref id print on customer's invoice use for reference with customer. Noted* Ref can possibly be null depending on category of payment.
`ref2`	string	Y	Ref id print on customer's invoice use for reference with customer. Noted* Ref can possibly be null depending on category of payment.
`crypto_amount`	number	N	Transaction amount in crypto. Noted* Crypto amount can possibly be null depending on category of payment.
`convertion_rate`	number	N	Convertion rate. Noted* Conversion rate can possibly be null depending on category of payment.
`currency`	string	Y	Pay with currency.
`address`	string	N	Address of crypto wallet. Noted* Address can possibly be null depending on category of payment.
`deposit_network`	string	N	Network for tranfer crypto. Noted* Network can possibly be null depending on category of payment.
`represent_type`	string	Y	"QR" or "Redirect"
`timeout`	string	Y	Time out of deposit Qr code.

Initial Crypto Payment `POST`

JSON request example:

Request Body

{
    "service_id": "510",
    "amount": 1000,
    "currency": "USDT",
    "public_key": "a48a6e20-8d02-11ed-b118-4bbf84c800c9",
    "payer_crypto_address":"0x2Eb471Cc28333dbA41e2eE70f3abf28Ca27096d5",
    "payer_crypto_network":"ERC20",
    "account_firstname": "ไมค์",    
    "account_lastname": "สวน",
    "account_middlename": "",
    "signature":"0739aa70efa58d155c8830ab1aa698859f12e0878c748107e846bcd7175c1ded",
    "payer_username": "abc1234",
    "redirect_url": "",
    "remark": ""
}

JSON response example:

{
    "code": 0,
    "message": "success",
    "result": {
        "qr_link": "https://dev2.autoeasy.me/?value=iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAIAAAD2HxkiAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAN2klEQVR4nO3de4xU5R3G8ffMzM4u48IuC6wQRIUgNd5ja6ME
    jb2k1mpQaworTb1UUYtNjcTUhFgr0lpDau0FG6VeqhWweElbS4wo2ihIEdC2CFTURbnIbdnlsiy7szPn9I8dtxvlzOyZPWef9yzfT0g0zDnvvDs7D2dmfvN7X8d1XQNAJ6GeAHC0S3X9J5GIRxrDum77/bxxHz9qfvNnPuXpmn88
    EUJAjBACYoQQECOEgBghBMQIISDmhNtRFvc6Vdz76+JSv1XVRaPutyxvPlwJATFCCIgRQkCMEAJihBAQI4SAGCEExELuJ1TVYVT9ZmGxcz3M/hd0Prbtf+iHfkLAaoQQECOEgBghBMQIISBGCAExQgiIpYrfrNqXz7b1Qm3bt1D1
    +AQVl/on+xMCRzVCCIgRQkCsxHtCaI0fPz6dTvfmyGw229zc3NzcHPWUEDpCaK9cLr/4+SWdXq8OTiVMVcJdu3b1/Pnzly9fHvHUECZCaKNNH+347aKXV/xrU2ZQZU2myjilTznY1nGg9fA5p4379UNPvv3mK7NmzWpqaop+pghB
    oU1TtTrhfqJuh8yrPVabesz7J96I1dCQIwQAmKEEBAjhIAYIQTECCEgRggBsTLrhLatF+rHtnpUWPW6uNfT4r7fI/sTAgMKIQTECCEgRggBMUIIiBFCQIwQAmIl6oRR97lFLS51vKDjRH2/QUW9jqsf2+qB7E8IxBIhBMQIISBGC
    AExQgiIEUJAjBACYk5cOgOBgYorISD2PzTXylDjMbvnAAAAAElFTkSuQmCC&type=base64",
        "value": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAIAAAD2HxkiAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAN2klEQVR4nO3de4xU5R3G8ffMzM4u48IuC6wQRIUgNd5ja6MEjb2k1mpQawor
    Tb1UUYtNjcTUhFgr0lpDau0FG6VeqhWweElbS4wo2ihIEdC2CFTURbnIbdnlsiy7szPn9I8dtxvlzOyZPWef9yzfT0g0zDnvvDs7D2dmfvN7X8d1XQNAJ6GeAHC0S3X9J5GIRxrDum77/bxxHz9qfvNnPuXpmn885goMYIQQECOE
    gBghBMQIISBGCAExQgiIpYrfrPo+TVh1HtvqdUHnE9bjEPTn9btf2+qBqnGCKv64cSUExAghIEYIATFCCIgRQkCMEAJihBAQK1En9KOqX/kJqx4YdJyg9b2g8wmrfmjbfGxbz0H7fOZKCIgRQkCMEAJihBAQI4SAGCEExAghIFZm
    ndA2YdXroq6Dqep1ts0nqKj7QrW4EgJihBAQI4SAGCEExAghIEYIATFCCIgNkDqhStzrY6r+wIFd9wuKKyEgRggBMUIIiBFCQIwQAmKEEBAjhIBYmXXCuNRzoq7jBb1fP7btQxj179e25492PlwJATFCCIgRQkCMEAJihBAQI4SA
    GCEExErUCaOup4XFtvUz476+qG3Hh8XO57ONcwKOKoQQECOEgBghBMQIISBGCAExQgqLhQsXBjqFEJZ3v34IYQD9H8Li9xv37cSjFq8Q8sEMIEYIATFCCIgRQkAs5F2ZVP1gQcXlAyE/tq1ryPOnvPkUzgphRgD6gBACYoQQECOE
    CMEAJihBAQI4SAGCEExAghIFaoE8albhZ1HTLqvkHV+pxhUa0HG1b9k/0JARwBIQTECCEgRggBMUIIiBFCQIwQAmKp4jfHZb+7oMKqv0Xdh2nb/o1Rz8e2PsOg45c3f66EgBghBMQIISBGCAExQgiIEUJr+Pdv62YKOH/V8gh4fl
    3py8XlyJQTECCEgRggBMUIIiBFCQIwQAmKEEBArs05oG9X+eFGvbxlW3UxVnwxr/KBU65eyPyEQS4QQECOEgBghBMQIISBGCAExQgiIDZA6YdT7/oU1TtTrhfqJuh8yrPVabesz7J96I1dCQIwQAmKEEBAjhIAYIQTECCEgRggBs
    TLrhLatF+rHtnpUWPW6uNfT4r7fI/sTAgMKIQTECCEgRggBMUIIiBFCQIwQAmIl6oRR97lFLS51vKDjRH2/QUW9jqsf2+qB7E8IxBIhBMQIISBGCAExQgiIEUJAjBACYk5cOgOBgYorISD2PzTXylDjMbvnAAAAAElFTkSuQmCC",
        "service": "5011",
        "id": "TRN202111103439860",
        "order": "VP1636550015",
        "amount": 100,
        "actual_amount": 98.5,
        "fee": 1.5,
        "key": "qrcode",
        "name": "QRCode",
        "description": "QR Code",
        "ref1": "202111103439860",
        "ref2": null,
        "crypto_amount": 100.2,
        "crypto_address": "0x2Eb471Cc28333dbA41e2eE70f3abf28Ca27096d5",
        "crypto_network": "ERC20",
        "convertion_rate": null,
        "currency": "THB",
        "address": null,
        "deposit_network": null,
        "represent_type": "QR",
        "timeout": {
            "days": "2024-07-08",
            "time": "16-29-51",
            "dateTime": "2024-07-08T16:29:51+07:00"
        },
        "type": "QR"
      }
    }

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/v4/init-payment/crypto

Content Type

Type: application/json

Parameter Description

Property	Type	Require	Description
`service_id`	string	Y	Id inside "services" from api 2.Service Category (get-category).
`amount`	number	Y	Payment amount.
`currency`	string	Y	List Crypto Currency. Appendix
`public_key`	string	Y	Public Key Generate by Askmepay.
`payer_crypto_address`	string	Y	Customer's Address
`payer_crypto_network`	string	Y	List Crypto Network. Appendix
`account_firstname`	string	N	Customer's Firstname. Noted* Customer must pay with bank account of the same firstname only.
`account_lastname`	string	N	Customer's Lastname. Noted* Customer must pay with bank account of the same lastname only.
`account_middlename`	string	N	Customer's Middlename. in english. Noted* This will increase success rate in THB, Causes some banks send us name in English.
`signature`	string	Y	HmacSha256(`public_key=${public_key}&service_id=${service_id}&amount=${amount}`,secret_key)
`payer_username`	string	N	Customer's Username Noted* This field is data provide for technical support.
`redirect_url`	string	N	For redirect to any page. Noted* If this field is not set, we will provide Askmepay banner.
`remark`	string	N	Any remark.

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	InitPaymentCryptoData	Y	Return data as Object.

Init Payment Crypto Data

Property	Type	Require	Description
`qr_link`	string	Y	Link for Qr code.
`value`	string	Y	Qr code as pnd;base64 format you can render by using "img src="data:image/png;base64,QR code value"".
`service`	string	Y	Service code for payment Gateway.
`id`	string	Y	Payment id for reference with bank.
`order`	string	Y	Order id for refernce with Askmepay.
`amount`	number	Y	Transaction amount.
`actual_amount`	number	Y	Transaction amount including fee.
`fee`	number	Y	Transaction fee.
`key`	string	Y	Type of payment channel.
`name`	string	Y	Type of service.
`description`	string	Y	"QR Code".
`ref1`	string	Y	Ref id print on customer's invoice use for reference with customer. Noted* Ref can possibly be null depending on category of payment.
`ref2`	string	Y	Ref id print on customer's invoice use for reference with customer. Noted* Ref can possibly be null depending on category of payment.
`crypto_amount`	number	Y	Transaction amount in crypto. Noted* Crypto amount can possibly be null depending on category of payment.
`crypto_address`	string	Y	"Destination address".
`crypto_network`	string	Y	Destination network. Noted* Network can possibly be null depending on category of payment.
`currency`	string	Y	Pay with currency.
`address`	string	Y	Source address. Noted* Address can possibly be null depending on category of payment.
`deposit_network`	string	Y	Source network. Noted* Network can possibly be null depending on category of payment.
`represent_type`	string	Y	"QR" or "Redirect"
`timeout`	string	Y	Time out of deposit Qr code.
`type`	string	Y	"QR" or "Redirect"

Payout `POST`

JSON request example:

Request Body

{
    "service_id": "100",    
    "order_id": "2a6d33dc-bef7-4034-b835-5e87e91756e2",
    "amount": "100",    
    "currency": "THB",
    "bank_name": "SCB",    
    "account_number": "020295778772",
    "account_firstname": "ไมค์",    
    "account_lastname": "สวน",
    "account_middlename": "",    
    "public_key": "a48a6e20-8d02-11ed-b118-4bbf84c800c9",
    "signature": "0739aa70efa58d155c8830ab1aa698859f12e0878c748107e846bcd7175c1ded",    
    "remark": "",
    "timestamp": 1720084986,
    "phone": "",
    "ifsc_code": "",
    "email": ""
}

JSON response example:

{
"code": 0,
    "message": "success",
    "result": {
        "before_balance": 1155.79,
        "after_balance": 1154.775,
        "fee": 0.015,
        "amount": 1,
        "amount_inc_fee": 1.015,
        "payment_id": "0be9ec5a-823f-495e-a754-05957e613212",
        "transaction_id": "2a6d33dc-bef7-4034-b835-5e87e91756e2"
    }
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/v1/init-payout

Content Type

Type: application/json

Parameter Description

Property	Type	Require	Description
`service_id`	string	Y	Id inside "services" from api 2.Service Category (get-category).
`order_id`	string	Y	Order id for refernce with Askmepay.
`amount`	number	Y	Payout amount.
`currency`	string	Y	Payout with currency.
`bank_name`	string	Y	Customer's Bank Name. Appendix
`account_number`	string	Y	Customer's Bank account number.
`account_firstname`	string	Y	Customer's Firstname. Noted* Customer should payout with bank account of the same firstname only.
`account_lastname`	string	Y	Customer's Lastname. Noted* Customer should payout with bank account of the same lastname only.
`account_middlename`	string	N	Customer's Middlename.
`public_key`	string	Y	Public Key Generate by Askmepay.
`signature`	string	Y	HmacSha256(`amount=${amount}&account_number=${account_number}&bank_name=${bank_name}&currency=${currency}&order_id=${order_id}&public_key=${public_key}&timestamp=${timestamp}`, YOUR SECRET)
`remark`	string	N	Any remark.
`timestamp`	number	Y	Current timestamp.
`phone`	string	N	Customer's Phone number. Noted* Require for currency INR.
`ifsc_code`	string	N	Customer's IFSC code. Noted* Require for currency INR.
`email`	string	N	Customer's Email. Noted* Require for currency INR.
`type`	string	Y	"WITHDRAW"

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	InitPayoutData	Y	Return data as Object.

Init Payout Data

Property	Type	Require	Description
`before_balance`	number	Y	Balance before payout.
`after_balance`	number	Y	Balance after payout.
`fee`	number	Y	Transaction fee.
`amount`	number	Y	Transaction amount.
`amount_inc_fee`	number	Y	Transaction amount including fee.
`payment_id`	string	Y	Payment id for refernce with Askmepay.
`transaction_id`	string	Y	Transaction id for refernce with Askmepay. Related with Order id.
`fee_rate`	number	N	The transaction fee rate in percentage
(#represent-type)

Payout Crypto `POST`

JSON request example:

Request Body

{
    "service_id": "100",    
    "order_id": "2a6d33dc-bef7-4034-b835-5e87e91756e2",
    "amount": "1000",    
    "currency": "USDT",
    "payer_crypto_address":"0x2Eb471Cc28333dbA41e2eE70f3abf28Ca27096d5",
    "payer_crypto_network":"ERC20",
    "account_firstname": "ไมค์",    
    "account_lastname": "สวน",
    "account_middlename": "",    
    "public_key": "a48a6e20-8d02-11ed-b118-4bbf84c800c9",
    "signature": "0739aa70efa58d155c8830ab1aa698859f12e0878c748107e846bcd7175c1ded",    
    "remark": "",
    "timestamp": 1720084986,
}

JSON response example:

{
"code": 0,
    "message": "success",
    "result": {
        "before_balance": 1155.79,
        "after_balance": 1154.775,
        "fee": 0.015,
        "amount": 1,
        "amount_inc_fee": 1.015,
        "payment_id": "0be9ec5a-823f-495e-a754-05957e613212",
        "transaction_id": "2a6d33dc-bef7-4034-b835-5e87e91756e2"
    }
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/v1/init-payout/crypto

Content Type

Type: application/json

Parameter Description

Property	Type	Require	Description
`service_id`	string	Y	Id inside "services" from api 2.Service Category (get-category).
`order_id`	string	Y	Order id for refernce with Askmepay.
`amount`	number	Y	Payout amount.
`currency`	string	Y	Payout with currency.
`payer_crypto_address`	string	Y	Customer's Address
`payer_crypto_network`	string	Y	List Crypto Network. Appendix
`account_firstname`	string	N	Customer's Firstname. Noted* Customer should payout with bank account of the same firstname only.
`account_lastname`	string	N	Customer's Lastname. Noted* Customer should payout with bank account of the same lastname only.
`account_middlename`	string	N	Customer's Middlename.
`public_key`	string	Y	Public Key Generate by Askmepay.
`signature`	string	Y	HmacSha256(`amount=${amount}&payer_crypto_address=${payer_crypto_address}&payer_crypto_network=${payer_crypto_network}&currency=${currency}&order_id=${order_id}&public_key=${public_key}&timestamp=${timestamp}`, YOUR SECRET)
`remark`	string	N	Any remark.
`timestamp`	number	Y	Current timestamp.

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	InitPayoutCryptoData	Y	Return data as Object.

Init Payout Crypto Data

Property	Type	Require	Description
`before_balance`	number	Y	Balance before payout.
`after_balance`	number	Y	Balance after payout.
`fee`	number	Y	Transaction fee.
`amount`	number	Y	Transaction amount.
`amount_inc_fee`	number	Y	Transaction amount including fee.
`payment_id`	string	Y	Payment id for refernce with Askmepay.
`transaction_id`	string	Y	Transaction id for refernce with Askmepay. Related with Order id.
`fee_rate`	number	N	The transaction fee rate in percentage
(#represent-type)

Get Balance `POST`

Request Body

{
        "public_key": "b4b40700-c095-11ec-b56f-df7291751f1d",
        "signature": "fdbdf1fa45a1c567ff4440ff127c915daa6e71580ef3bef2d4b753354de58a47"
}

JSON response example:

{
    "code": 0,
    "message": "success",
    "result": {
        "username": "askmepay",
        "asset": {
            "fiat": {
                "brl": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    }
                },
                "idr": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    }
                },
                "jpy": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    }
                },
                "krw": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    }
                },
                "myr": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    }
                },
                "php": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    }
                },
                "thb": {
                    "askmepay": {
                        "isActive": false,
                        "wallet": 1234.55,
                    }
                },
                "vnd": {
                    "askmepay": {
                        "isActive": true,
                        "wallet": 1234.55,
                    },
                    "bankAccount": [
                        {
                            "_id": "644a3b4599d849101b95c70e",
                            "accountNo": "234097532",
                            "accountBank": "BBL",
                            "accountFirstname": "สมใจ",
                            "accountLastname": "ใจดี",
                            "accountMiddlename": ""
                        }
                    ]
                }
            },
        }
    },
}

HTTP Request

POST {{ API_URL }}/ambpayment/frontapi/user/V3/get-balance

Content Type

Type: application/json

Parameter Description

Property	Type	Require	Description
`public_key`	string	Y	Public Key Generate by Ask me pay's staff.
`signature`	string	Y	HmacSha256(`public_key=${public_key}`,secret_key)

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	GetBalanceData	Y	Return result data as Object.

Get Balance Data

Property	Type	Require	Description
`username`	string	Y	Customer's Username.
`wallet`	number	Y	THB wallet.
`asset`	GetAssetData	Y	Return asset data as Object.

Get Asset Data

Property	Type	Require	Description
`fiat`	GetFiatData	Y	Return currency data as Object.

Get Fiat Data

Property	Type	Require	Description
`vnd`	GetVndData	Y	Return category of provider data as Object.

Get Vnd Data

Property	Type	Require	Description
`eeziepay`	GetProviderData	Y	Return provider data as Object.
`bankAccount`	GetBankaccountData	Y	Return Bank's Account data as Object.

Get Provider Data

Property	Type	Require	Description
`wallet`	number	Y	THB wallet.
`isActive`	number	Y	Service status.

Get Bankaccount Data

Property	Type	Require	Description
`_id`	string	Y	Unique id.
`accountNo`	string	Y	Customer's Bank account number.
`accountBank`	string	Y	Bank's code.
`accountFirstname`	string	Y	Customer's Firstname.
`accountLastname`	string	N	Customer's Lastname.
`accountMiddlename`	string	N	Customer's middlename.

Check Status `POST`

Request Body

{
    "type": "DEPOSIT",
    "order_id" : "VTATN1653031364"
}

JSON response example:

{
  "code": 0,
  "message": "success",
  "result": {
        "amount": 100,
        "status": "SUCCESS",
        "fee": 1,
        "currency": "THB",
        "order_datetime": "2022-05-20 14:22:44"
    }
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/v1/check-status

Content Type

Type: application/json

Parameter Description

User can get all avaliable payment method.

Property	Type	Require	Description
`type`	string	Y	"DEPOSIT" or "PAYOUT"
`order_id`	string	Y	Order id for refernce with Askmepay.

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	CheckStatus	Y	Return data as Object.

Check Status

Property	Type	Require	Description
`amount`	number	Y	Amount from "initial payment".
`status`	string	Y	"SUCCESS" (The transaction succeeded), "REJECT" (The transaction rejected)
`fee`	number	Y	Fee.
`currency`	string	Y	Currency of payment THB = Thai Baht, BTC = Bitcoin, ETH = Ethereum, USDT = US Dollar USDT coin.
`order_datetime`	string	Y	time to order

Deposit Bank List `POST`

Request Body

{
    "service_id": "100",
}

JSON response example:

{
    "code": 0,
    "data": {},
    "message": "success",
    "result": [
        {
            "image": "",
            "name": "ธนาคารกรุงเทพ จำกัด (มหาชน)",
            "value": "BBL"
        },
        {
            "image": "",
            "name": "ธนาคารกสิกรไทย จำกัด (มหาชน)",
            "value": "KBANK"
        },
        {
            "image": "",
            "name": "ธนาคารกรุงไทย จำกัด (มหาชน)",
            "value": "KTB"
        },
        {
            "image": "",
            "name": "ธนาคารไทยพาณิชย์ จำกัด (มหาชน)",
            "value": "SCB"
        },
        {
            "image": "",
            "name": "ธนาคารสแตนดาร์ดชาร์เตอร์ด (ไทย) จำกัด (มหาชน)",
            "value": "SCBT"
        },
        {
            "image": "",
            "name": "ธนาคารซีไอเอ็มบี ไทย จำกัด (มหาชน)",
            "value": "CIMB"
        },
        {
            "image": "",
            "name": "ธนาคารยูโอบี จำกัด (มหาชน)",
            "value": "UOB"
        },
        {
            "image": "",
            "name": "ธนาคารกรุงศรีอยุธยา จำกัด (มหาชน)",
            "value": "BAY"
        },
        {
            "image": "",
            "name": "ธนาคารออมสิน",
            "value": "GSB"
        },
        {
            "image": "",
            "name": "ธนาคารฮ่องกงและเซี่ยงไฮ้แบงกิ้งคอร์ปอเรชั่น จำกัด",
            "value": "HSBC"
        },
        {
            "image": "",
            "name": "ธนาคารอาคารสงเคราะห์",
            "value": "GHB"
        },
        {
            "image": "",
            "name": "ธนาคารเพื่อการเกษตรและสหกรณ์การเกษตร",
            "value": "BAAC"
        },
        {
            "image": "",
            "name": "ธนาคารอิสลามแห่งประเทศไทย์",
            "value": "ISBT"
        },
        {
            "image": "",
            "name": "ธนาคารทิสโก้ จำกัด (มหาชน)",
            "value": "TISCO"
        },
        {
            "image": "",
            "name": "ธนาคารเกียรตินาคินภัทร จำกัด (มหาชน)",
            "value": "KKP"
        },
        {
            "image": "",
            "name": "ธนาคารแลนด์ แอนด์ เฮ้าส์ จำกัด (มหาชน)",
            "value": "LHBANK"
        },
        {
            "image": "",
            "name": "ธนาคารทหารไทยธนชาต จำกัด (มหาชน)",
            "value": "TTB"
        },
        {
            "image": "",
            "name": "ธนาคารทหารไทยธนชาต จำกัด (มหาชน)",
            "value": "TMB"
        },
        {
            "image": "",
            "name": "ABN Amro Bank N.V.",
            "value": "ABN"
        },
        {
            "image": "",
            "name": "Citibank N.A.",
            "value": "CITI"
        },
        {
            "image": "",
            "name": "Mizuho Corporate Bank Limited",
            "value": "MHCB"
        },
        {
            "image": "",
            "name": "Islamic Bank of Thailand",
            "value": "IBANK"
        },
        {
            "image": "",
            "name": "ธนาคารพาณิชย์อุตสาหกรรมแห่งประเทศจีน",
            "value": "ICBC"
        },
        {
            "image": "",
            "name": "ธนาคารไทยเครดิตเพื่อรายย่อย",
            "value": "TCRB"
        },
        {
            "image": "",
            "name": "ธนาคารแลนด์ แอนด์ เฮ้าส์ จำกัด (มหาชน)",
            "value": "LH"
        },
        {
            "image": "",
            "name": "Bank of China",
            "value": "BOC"
        },
        {
            "image": "",
            "name": "INDUSTRIAL AND COMMERCIAL BANK OF CHINA (THAI)",
            "value": "ICBCT"
        },
        {
            "image": "",
            "name": "เจพีมอร์แกน",
            "value": "JPM"
        },
        {
            "image": "",
            "name": "โอเวอร์ซี-ไชนีส",
            "value": "OCBC"
        },
        {
            "image": "",
            "name": "ซูมิโตโม มิตซุย แบงกิ้ง",
            "value": "SMBC"
        },
        {
            "image": "",
            "name": "อาร์ เอช บี",
            "value": "RHB"
        },
        {
            "image": "",
            "name": "เมกะ",
            "value": "MEGA"
        },
        {
            "image": "",
            "name": "ธนาคารแห่งอเมริกา",
            "value": "BOFA"
        },
        {
            "image": "",
            "name": "อินเดียน โอเวอร์ซีส์",
            "value": "INDIAN"
        },
        {
            "image": "",
            "name": "ดอยซ์แบงก์",
            "value": "DBBK"
        },
        {
            "image": "",
            "name": "มิซูโฮ",
            "value": "MIZUHO"
        },
        {
            "image": "",
            "name": "บีเอ็นพี พารีบาส์",
            "value": "BNPP"
        },
        {
            "image": "",
            "name": "ไทยเครดิต",
            "value": "TCR"
        },
        {
            "image": "",
            "name": "เอสเอ็มอีแบงก์",
            "value": "SME"
        },
        {
            "image": "",
            "name": "ธนาคารเอเอ็นแซด (ไทย)",
            "value": "ANZ"
        },
        {
            "image": "",
            "name": "LAND AND HOUSES RETAIL BANK PUBLIC COMPANY LIMITED",
            "value": "LHB"
        }
    ]
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/user/get-bank-deposit

Content Type

Type: application/json

Parameter Description

User can get all avaliable payment method.

Property	Type	Require	Description
`service_id`	string	Y	serviceId can reference ServiceId

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	BankDepositListResult	Y	Return data as Object.

Bank Deposit List Result

Property	Type	Require	Description
`name`	string	Y	Name of bank
`value`	string	Y	Bankcode to use
`image`	string	N	Image of bank

Withdraw Bank List `POST`

Request Body

{
    "service_id": "100",
}

JSON response example:

{
    "code": 0,
    "data": {},
    "message": "success",
    "result": [
        {
            "name": "ธนาคารเจพีมอร์แกน เชส",
            "value": "JPM"
        },
        {
            "name": "ธนาคารซูมิโตโม มิตซุย แบงกิ้ง คอร์ปอเรชั่น",
            "value": "SMBC"
        },
        {
            "name": "ธนาคารกรุงเทพ จำกัด (มหาชน)",
            "value": "BBL"
        },
        {
            "name": "ธนาคารอินเดียนโอเวอร์ซีส์",
            "value": "Indian"
        },
        {
            "name": "ธนาคารไทยพาณิชย์ จำกัด (มหาชน)",
            "value": "SCB"
        },
        {
            "name": "แบงค์ ออฟ ไต้หวัน",
            "value": "BKTW"
        },
        {
            "name": "ธนาคารพัฒนาวิสาหกิจขนาดกลางและขนาดย่อมแห่งประเทศไทย",
            "value": "SME"
        },
        {
            "name": "เดอะ จูโรกุ แบ๊งค์, ลิมิเต็ด",
            "value": "JURO"
        },
        {
            "name": "ธนาคารกรุงไทย จำกัด (มหาชน)",
            "value": "KTB"
        },
        {
            "name": "ธนาคารกสิกรไทย จำกัด (มหาชน)",
            "value": "KBANK"
        },
        {
            "name": "ธนาคารอาร์ เอช บี จำกัด",
            "value": "RHB"
        },
        {
            "name": "ธนาคารซีไอเอ็มบี ไทย จำกัด (มหาชน)",
            "value": "CIMB"
        },
        {
            "name": "ธนาคารทหารไทยธนชาต จำกัด (มหาชน)",
            "value": "TMB"
        },
        {
            "name": "ธนาคารยูโอบี จำกัด (มหาชน)",
            "value": "UOB"
        },
        {
            "name": "ธนาคารอิสลามแห่งประเทศไทย์",
            "value": "ISBT"
        },
        {
            "name": "เดอะ แบ๊งค์ ออฟ ฟุกุโอกะ ลิมิเต็ด",
            "value": "FKBK"
        },
        {
            "name": "เดอะชูโกคุ แบ๊งค์, ลิมิเต็ด",
            "value": "CHGK"
        },
        {
            "name": "ดีบีเอส แบงค์ ลิมิเต็ด์",
            "value": "DBSS"
        },
        {
            "name": "เฟิซท คอมเมอร์เชียล แบงค์ คัมปะนี ลิมิเต็ด์",
            "value": "FCBK"
        },
        {
            "name": "ดีอีจี-ด้อยท์เช่ อินเวสติซิโอนส์-อุนด์ เอ็นวิกคลุงส์เกเซลชัฟท์ เอ็มบีเอช",
            "value": "DEGK"
        },
        {
            "name": "เดอะ แบ๊งค์ ออฟ โยโกฮามา ลิมิเต็ด",
            "value": "HAMA"
        },
        {
            "name": "ธนาคารบีเอ็นพี พารีบาส์",
            "value": "BNPP"
        },
        {
            "name": "ดิ อาชิคากะ แบ๊งค์ ลิมิเต็ด",
            "value": "ASIK"
        },
        {
            "name": "เดอะ กุนมะ แบงค์ ลิมิเต็ด",
            "value": "GUMA"
        },
        {
            "name": "THE BANK OF NEW YORK MELLON",
            "value": "IRVT"
        },
        {
            "name": "เดอะ ชิมิซุ แบ๊งค์ ลิมิเต็ด",
            "value": "SMZG"
        },
        {
            "name": "ซีเอ็มบี เหว่ง หลง แบงค์ ลิมิเต็ด",
            "value": "WUBA"
        },
        {
            "name": "ธนาคารเมกะ สากลพาณิชย์ จำกัด (มหาชน)",
            "value": "Mega"
        },
        {
            "name": "ธนาคารโอเวอร์ซี-ไชนีสแบงกิ้งคอร์ปอเรชั่น จำกัด",
            "value": "OCBC"
        },
        {
            "name": "BANK OF THAILAND",
            "value": "BOT"
        },
        {
            "name": "ธนาคารกรุงศรีอยุธยา จำกัด (มหาชน)",
            "value": "BAY"
        },
        {
            "name": "เดอะ เซี่ยงไฮ้ คอมเมอร์เชียล แอนด์ เซฟวิ่ง แบงค์, แอลทีดี.",
            "value": "SCSB"
        },
        {
            "name": "เดอะ ซัน - อินโกโด แบ๊ง ลิมิเต็ด",
            "value": "SGBK"
        },
        {
            "name": "เดอะ ฟุคุอิ แบ๊งค์, ลิมิเต็ด",
            "value": "FKUI"
        },
        {
            "name": "ไท่ชิน อินเตอร์เนชั่นแนล แบงค์ คอมพานี ลิมิเต็ด",
            "value": "TSIB"
        },
        {
            "name": "RESONA BANK, LIMITED",
            "value": "DIWA"
        },
        {
            "name": "ธนาคารดอยซ์แบงก์",
            "value": "DBBK"
        },
        {
            "name": "เดอะ ชิกะ แบ๊งค์ ลิมิเต็ด",
            "value": "SIGA"
        },
        {
            "name": "ซีทีบีซี แบงค์ คอมปานี ลิมิเต็ด์",
            "value": "CTCB"
        },
        {
            "name": "เดอะ โชโค ชูคิน แบ๊งค์ ลิมิเต็ด",
            "value": "SKCK"
        },
        {
            "name": "เดอะ ฮยาคุโกะ แบ๊งค์ ลิมิเต็ด์",
            "value": "HYKG"
        },
        {
            "name": "เดอะ ชิบะ แบ๊งค์, ลิมิเต็ด",
            "value": "CHBA"
        },
        {
            "name": "เดอะ ฮาชิจูนิ แบ๊งค์ ลิมิเต็ด จำกัด",
            "value": "HABK"
        },
        {
            "name": "ธนาคารเกียรตินาคินภัทร จำกัด (มหาชน)",
            "value": "KKP"
        },
        {
            "name": "เครดิต อินดัสเทรียล เอ คอมเมอร์เชียล (ซี ไอ ซี)์",
            "value": "CMCI"
        },
        {
            "name": "เดอะ แบ๊งค์ ออฟ เกียวโต ลิมิเต็ด",
            "value": "BOKF"
        },
        {
            "name": "ไอเอ็นจี แบงค์ เอ็น. วี.",
            "value": "INGB"
        },
        {
            "name": "ธนาคารอาคารสงเคราะห์",
            "value": "GHB"
        },
        {
            "name": "ธนาคารเพื่อการส่งออกและนำเข้าแห่งประเทศไทย",
            "value": "EXIM"
        },
        {
            "name": "ธนาคารทิสโก้ จำกัด (มหาชน)",
            "value": "TISCO"
        },
        {
            "name": "บรรษัทประกันสินเชื่ออุตสาหกรรมขนาดย่อม",
            "value": "TCG"
        },
        {
            "name": "สเตท สตรีท แบงก์ แอนด์ ทรัสต์ คัมปะนี์",
            "value": "SBOS"
        },
        {
            "name": "เดอะ โฮคุโตะ แบ๊งค์, ลิมิเต็ด",
            "value": "HOKB"
        },
        {
            "name": "ธนาคารสแตนดาร์ดชาร์เตอร์ด (ไทย) จำกัด (มหาชน)",
            "value": "SCBT"
        },
        {
            "name": "ธนาคารเพื่อการเกษตรและสหกรณ์การเกษตร",
            "value": "BAAC"
        },
        {
            "name": "ธนาคารมิซูโฮ จำกัด สาขากรุงเทพฯ",
            "value": "MIZUHO"
        },
        {
            "name": "เดอะ กิฟุ ชินกิน แบ๊งค์",
            "value": "GFSB"
        },
        {
            "name": "ดิ เอ็กซ์พอร์ท-อิมพอร์ท แบงค์ ออฟ เดอะ รีพับบลิค ออฟ ไชน่า์",
            "value": "EIBC"
        },
        {
            "name": "หัวหนาน คอมเมอร์เชียล แบงค์ แอลทีดี",
            "value": "HNBK"
        },
        {
            "name": "NATIXIS",
            "value": "NATX"
        },
        {
            "name": "ธนาคารออมสิน",
            "value": "GSB"
        },
        {
            "name": "เดอะ ฮามามัตสึ ชินกิน แบ๊งค์",
            "value": "HMSK"
        },
        {
            "name": "โคเรีย ดีเวลลอปเมนท์ แบงก์",
            "value": "KODB"
        },
        {
            "name": "ธนาคารแห่งอเมริกาเนชั่นแนลแอสโซซิเอชั่น",
            "value": "BofA"
        },
        {
            "name": "ธนาคารแห่งประเทศจีน (ไทย) จำกัด (มหาชน)",
            "value": "BOC"
        },
        {
            "name": "ธนาคารไอซีบีซี (ไทย) จำกัด (มหาชน)",
            "value": "ICBCT"
        },
        {
            "name": "ธนาคารไทยเครดิต เพื่อรายย่อย จำกัด (มหาชน)",
            "value": "TCR"
        },
        {
            "name": "ธนาคารแลนด์ แอนด์ เฮ้าส์ จำกัด (มหาชน)",
            "value": "LHBANK"
        },
        {
            "name": "JAPAN BANK FOR INTERNATIONAL COOPERATION",
            "value": "JBIC"
        },
        {
            "name": "ชินกิน เซ็นทรัล แบ๊งค์",
            "value": "ZENB"
        },
        {
            "name": "คาเธ่ย์ ยูไนเต็ด แบงก์",
            "value": "UWCB"
        },
        {
            "name": "CREDIT SUISSE",
            "value": "CRES"
        },
        {
            "name": "เจแปน ไฟแนนซ์ คอร์ปอเรชั่น",
            "value": "JANE"
        },
        {
            "name": "เดอะ ฮิโรชิม่า แบ๊งค์ ลิมิเต็ด",
            "value": "HIRO"
        },
        {
            "name": "ธนาคารฮ่องกงและเซี่ยงไฮ้แบงกิ้งคอร์ปอเรชั่น จำกัด",
            "value": "HSBC"
        },
        {
            "name": "ธนาคารเอเอ็นแซด (ไทย) จำกัด (มหาชน)",
            "value": "ANZ"
        },
        {
            "name": "เดอะ โฮคุริคุ แบ๊งค์ ลิมิเต็ด",
            "value": "RIKB"
        },
        {
            "name": "ดิ โอคาซากิ ชินกิน แบ๊งค์",
            "value": "OKSB"
        },
        {
            "name": "นอร์ธ แปซิฟิค แบ๊งค์ ลิมิเต็ด",
            "value": "NORP"
        },
        {
            "name": "คอมเมิร์ชแบงค์ อาคเทียนเกอเซลชาฟท์",
            "value": "COBA"
        },
        {
            "name": "ธนาคารทหารไทยธนชาต",
            "value": "TTB"
        },
        {
            "name": "ธนาคารแลนด์ แอนด์ เฮ้าส์ จำกัด (มหาชน)",
            "value": "LH"
        },
        {
            "name": "ABN Amro Bank N.V.",
            "value": "ABN"
        },
        {
            "name": "Citibank N.A.",
            "value": "CITI"
        },
        {
            "name": "Mizuho Corporate Bank Limited",
            "value": "MHCB"
        },
        {
            "name": "Islamic Bank of Thailand",
            "value": "IBANK"
        },
        {
            "name": "LAND AND HOUSES RETAIL BANK PUBLIC COMPANY LIMITED",
            "value": "LHB"
        }
    ]
}

HTTP Request

POST {{ API_URL }}/ambpayment/merchant/user/get-bank-withdraw

Content Type

Type: application/json

Parameter Description

User can get all avaliable payment method.

Property	Type	Require	Description
`service_id`	string	Y	serviceId can reference ServiceId

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`result`	BankWithdrawListResult	Y	Return data as Object.

Bank Withdraw List Result

Property	Type	Require	Description
`name`	string	Y	Name of bank
`value`	string	Y	Bankcode to use
`image`	string	N	Image of bank

API - Callback

Overview

For API callbacks, it is essential that the client returns a response body in the correct format. If the response is properly formatted, we will update the transaction status from "fail" to "success." Ensuring accurate and timely responses is crucial for maintaining the integrity and accuracy of transaction records.

Remark you can retry when callback is fail at ASKMEPAY Merchant Page-> Setting -> Callback & Key Setting. Every callback have a retry if you response fail or wrong response Please check duplicate your transaction we are not responsible

Deposit Callback `POST`

Callback will send to you when user deposit is success

For method = "check" it will call to your api since customer press approve button in bank application.
For method = "pay" it is a final call to your api to tell that transaction already success. if your callback response fails, we will retry up to 3 times with intervals of every 1 minutes then exponential 5 minutes 10 minutes.

Request Body

{
    "method": "pay|check",
    "id": "TRN1720427656018581B",
    "service_id": "100",
    "amount": 400,
    "fee": 0,
    "actualAmount": 394,
    "status": "SUCCESS",
    "order": "PG0BWZZQ1720427655",
    "timestamp": "1720427733",
    "hash": "58747f57367b44cea68cc30fb171e15d82bb00dab1a070d18cf3eada65b5ced9",
    "remark": "",
    "isTrust3Party": true,
    "transferActualAmount": 400.11
}

JSON response example:

{
    "code": 0,
    "message": "success",
    "timestamp": "1562591610",
    "hash": "5455474ccccaf0a8b4bce881c2c9087f4192af92"
}

HTTP Request

POST {{ YOUR_API_URL }}

Content Type

Type: application/json

Parameter Description

Property	Type	Description
`method`	string	"check" or "pay".
`id`	string	Payment Id.
`service_id`	string	Transaction service id indicate the channel of this transaction.
`amount`	number	Amount from "initial payment".
`actualAmount`	number	Amount charge wiht fee.
`fee`	number	Fee.
`order`	string	Order id start with your username and transaction id.
`status`	string	"SUCCESS" (transaction was succesed in Askmepay.)
`timestamp`	number	Current timestamp.
`hash`	string	HmacSha256(`method=${method}&id=${id}&service_id=${service_id}&amount=${amount}&actualAmount=${actualAmount}&order=${order}&timestamp=${timestamp}`,your_secret_key)
`remark`	string	Remark.
`isTrust3Party`	boolean	Need to replace your request amount by callback amount when value is `true`.
`transferActualAmount`	number	The transaction amount.

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`timestamp`	string	Y	Response timestamp.
`hash`	string	Y	Response with HmacSha256(`code=0&message=success&timestamp=${timestamp},your_secret_key`)

Deposit Crypto Callback `POST`

Callback will send to you when user deposit is success

Request Body

{
    "method": "pay|check",
    "id": "TRN1720427656018581B",
    "service_id": "100",
    "amount": 400,
    "actualAmount": 394,
    "crypto_amount" : 399.50,
    "status": "SUCCESS",
    "order": "PG0BWZZQ1720427655",
    "timestamp": "1720427733",
    "hash": "58747f57367b44cea68cc30fb171e15d82bb00dab1a070d18cf3eada65b5ced9",
    "remark": "",
    "isTrust3Party": true
}

JSON response example:

{
    "code": 0,
    "message": "success",
    "timestamp": "1562591610",
    "hash": "5455474ccccaf0a8b4bce881c2c9087f4192af92"
}

HTTP Request

POST {{ YOUR_API_URL }}

Content Type

Type: application/json

Parameter Description

Property	Type	Description
`method`	string	"check" or "pay".
`id`	string	Payment Id.
`service_id`	string	Transaction service id indicate the channel of this transaction.
`amount`	number	Amount from "initial payment".
`actualAmount`	number	Amount charge wiht fee.
`crypto_amount`	number	Actual amount of crypto.
`order`	string	Order id start with your username and transaction id.
`status`	string	"SUCCESS" (transaction was succesed in Askmepay.)
`timestamp`	number	Current timestamp.
`hash`	string	HmacSha256(`method=${method}&id=${id}&service_id=${service_id}&amount=${amount}&actualAmount=${actualAmount}&crypto_amount=${crypto_amount}&order=${order}&timestamp=${timestamp}`,your_secret_key)
`remark`	string	Remark.
`isTrust3Party`	boolean	Need to replace your request amount by callback amount when value is `true`.

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`timestamp`	string	Y	Response timestamp.
`hash`	string	Y	Response with HmacSha256(`code=0&message=success&timestamp=${timestamp},your_secret_key`)

Withdraw Callback `POST`

Request Body

{
  "method": "withdraw",
  "id": "paymentID",
  "service_id": 61,
  "amount": 100,
  "actualAmount": 110,
  "fee": 0,
  "order": "TEST_14052024_0001",
  "timestamp": 123,
  "hash": "58747f57367b44cea68cc30fb171e15d82bb00dab1a070d18cf3eada65b5ced9",
  "status": "SUCCESS",
  "remark": "",
  "isTrust3Party": false
}

JSON response example:

{
    "code": 0,
    "message": "success",
    "timestamp": "1562591610",
    "hash": "5455474ccccaf0a8b4bce881c2c9087f4192af92"
}

HTTP Request

POST {{ YOUR_API_URL }}

Content Type

Type: application/json

Parameter Description

Property	Type	Description
`method`	string	"withdraw".
`id`	string	Payment Id.
`service_id`	string	Transaction service id indicate the channel of this transaction.
`amount`	number	Amount from "initial payment".
`actualAmount`	number	Amount include fee.
`fee`	number	Fee.
`order`	string	Order id start with your username and transaction id.
`timestamp`	number	Current timestamp.
`hash`	string	HmacSha256(`method=${method}&id=${id}&service_id=${service_id}&amount=${amount}&actualAmount=${actualAmount}&order=${order}&timestamp=${timestamp}`,your_secret_key)
`status`	string	"SUCCESS" (transaction was succesed in Askmepay.)
`remark`	string	Remark.
`isTrust3Party`	boolean	Need to replace your request amount by callback amount when value is `true`.

Response Description

Property	Type	Require	Description
`code`	number	Y	Response code indicate the status.
`message`	string	Y	Response message.
`timestamp`	string	Y	Response timestamp.
`hash`	string	Y	Response with HmacSha256(`code=0&message=success&timestamp=${timestamp},your_secret_key`)

Error Code and Description

Common Error Code

Error Code	Description
0	success
9000	ไม่สามารถทำรายการได้ กรุณาลองใหม่
9005	Request Invalid
9006	เงินที่จ่ายน้อยกว่าค่าธรรมเนียม
9007	ไม่บริการรองรับสำหรับ merchant นี้
9008	ไม่สามารถทำรายการถอนได้
9009	payer_account_no must be provide.
9010	payer_credit_card_no must be provide.
9011	รายละเอียดการจ่ายเงินไม่ตรงกับฐานข้อมูล
9012	จำนวนเงินในการถอนต้องมีมากกว่า 0
9016	Invalid signature
9016	จำนวนเงินที่ท่านทำรายการต้องไม่ต่ำกว่าที่ระบบกำหนด
9020	Duplicate Transaction
9021	Amount less than minimum or grater than maximum limit
8021	Transaction Fail
9024	ชื่อและนามสกุลไม่ถูกต้องไม่สามารถทำรายการได้
9025	ไม่มีชื่อของผู้ทำรายการ
9026	ไม่มีนามสกุลของผู้ทำรายการ
9027	เซอร์วิสนี้ไม่เปิดให้บริการ
9028	เช็ค Balance จาก Partner ล้มเหลว
9029	Balance จาก Partner ไม่เพียงพอ
9030	ไม่พบ currency
9031	Bank doesn't support
9035	UNKNOW STATUS
9036	Invalid amount
9040	Timestamp Expired
9041	Submit Withdraw Failed
9042	bank_name must be provide.
9043	phone must be provide.
9044	customer info must be provide.

Bank Codes

Can use a service Deposit BankDepositListResult and Withdraw BankWithdrawListResult

Service Id

List Service Id

ServiceId	Service Currency	Details
"100"	THB	THB Service Id Details
"101"	THB	THB 24 hours Service Id Details
"200"	VND	VND Service Id Details
"201"	VND (Momo)	VND Momo Service Id Details
"202"	VND (Zalo)	VND Zalo Service Id Details
"300"	PHP (Gcash)	PHP Gcash Service Id Details
"301"	PHP (Paymaya)	PHP Paymaya Service Id Details
"302"	PHP (Local Bank)	PHP Local bank Service Id Details
"400"	IDR	IDR Service Id Details
"401"	IDR (Virtual Account)	IDR Virtual Account Service Id Details
"402"	IDR (QRIS)	IDR QRIS Service Id Details
"403"	IDR (E-wallet)	IDR E-wallet Service Id Details
"510"	USDT	USDT Service Id Details
"502"	ETH	ETH Service Id Details
"600"	INR	INR Service Id Details
"700"	MYR	MYR Service Id Details
"710"	MYR (E-wallet)	MYR E-wallet Service Id Details
"720"	MYR (Duitnow)	MYR Duitnow Service Id Details
"730"	MYR (Touch n go)	MYR Touch n go Service Id Details
"800"	BRL (PIX)	BRL PIX Service Id Details
"900"	KRW	KRW Service Id Details
"910"	KRW (Virtual Account)	KRW Virtual Account Service Id Details
"1100"	TRY (Papara)	TRY Papara Service Id Details
"1110"	TRY (Mefete)	TRY Mefete Service Id Details
"1120"	TRY (PayFix)	TRY PayFix Service Id Details
"1130"	TRY (Parazula)	TRY Parazula Service Id Details
"1140"	TRY (IBAN)	TRY IBAN Service Id Details
"1150"	TRY (Payco)	TRY Payco Service Id Details
"1160"	TRY (Paybol)	TRY Paybol Service Id Details
"1170"	TRY (Havale)	TRY Havale Service Id Details
"1200"	AUD	AUD Service Id Details
"1210"	AUD (PAYID)	AUD PAYID Service Id Details
"1300"	HKD	HKD Service Id Details
"1310"	HKD (FPS)	HKD FPS Service Id Details

Crypto

List Crypto Currency

CurrencyId	Currency Name
"USDT"	USDT

List Crypto Network

NetworkId	Network Name
"ERC20"	Ethereum network
"TRC20"	Tron network

Announcement

Introduction

Basic principles of communication

API - ASKMEPAY

Overview

Get All Service POST

HTTP Request

Content Type

Parameter Description

Response Description

Get All Service Data

Services Data

Initial Payment POST

HTTP Request

Content Type

Parameter Description

Response Description

Init Payment Data

Initial Crypto Payment POST

HTTP Request

Content Type

Parameter Description

Response Description

Init Payment Crypto Data

Payout POST

HTTP Request

Content Type

Parameter Description

Response Description

Init Payout Data

Payout Crypto POST

HTTP Request

Content Type

Parameter Description

Response Description

Init Payout Crypto Data

Get Balance POST

HTTP Request

Content Type

Parameter Description

Response Description

Get Balance Data

Get Asset Data

Get Fiat Data

Get Vnd Data

Get Provider Data

Get Bankaccount Data

Check Status POST

HTTP Request

Content Type

Parameter Description

Response Description

Check Status

Deposit Bank List POST

HTTP Request

Content Type

Parameter Description

Response Description

Bank Deposit List Result

Withdraw Bank List POST

HTTP Request

Content Type

Parameter Description

Response Description

Bank Withdraw List Result

API - Callback

Overview

Deposit Callback POST

HTTP Request

Content Type

Parameter Description

Response Description

Deposit Crypto Callback POST

HTTP Request

Content Type

Parameter Description

Response Description

Withdraw Callback POST

HTTP Request

Content Type

Get All Service `POST`

Initial Payment `POST`

Initial Crypto Payment `POST`

Payout `POST`

Payout Crypto `POST`

Get Balance `POST`

Check Status `POST`

Deposit Bank List `POST`

Withdraw Bank List `POST`

Deposit Callback `POST`

Deposit Crypto Callback `POST`

Withdraw Callback `POST`