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,
  "message": "success",
  "result": [
    {
      "merchantFee": 1.5,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "THB",
      "active": true,
      "network": "BANK_TH",
      "serviceId": 100,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/debitqr.png",
      "serviceName": "Cross bank QR (Debit)"
    },
    {
      "merchantFee": 1.5,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 10000,
      "currency": "USDT",
      "active": true,
      "network": "BEP20",
      "serviceId": 99,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/USDT-BEP20.png",
      "serviceName": "Crypto Deposit"
    },
    {
      "merchantFee": 1,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "USDT",
      "active": true,
      "network": "ERC20",
      "serviceId": 98,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/USDT-ERC20.png",
      "serviceName": "Crypto USDT (Etherium Chain)"
    },
    {
      "merchantFee": 1,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "ETH",
      "active": true,
      "network": "BEP20",
      "serviceId": 96,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/ETH-BEP20.png",
      "serviceName": "Crypto ETH (Binance Smart Chain)"
    },
    {
      "merchantFee": 1,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "ETH",
      "active": true,
      "network": "ERC20",
      "serviceId": 95,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/ETH-ERC20.png",
      "serviceName": "Crypto ETH (Etherium Chain)"
    },
    {
      "merchantFee": 1,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "BTC",
      "active": true,
      "network": "BEP20",
      "serviceId": 93,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/BTC-BEP20.png",
      "serviceName": "Crypto BTC (Binance Smart Chain)"
    },
    {
      "merchantFee": 1,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "BTC",
      "active": true,
      "network": "ERC20",
      "serviceId": 92,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/BTC-ERC20.png",
      "serviceName": "Crypto BTC (Etherium Chain)"
    },
    {
      "merchantFee": 1,
      "merchantFeeType": "P",
      "merchantMinimumFee": 0,
      "merchantMinimumFeeType": "B",
      "payoutFee": 0,
      "payoutFeeType": "P",
      "minimum": 1,
      "maximum": 50000,
      "currency": "USDT",
      "active": true,
      "network": "TRC20",
      "serviceId": 90,
      "imageUrl": "https://askmepay-logo.s3.ap-southeast-1.amazonaws.com/BTC-BTC.png",
      "serviceName": "Crypto USDT (TRON Chain)"
    }
  ]
}

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
`merchantFee`	number	Y	Transaction Fee.
`merchantFeeType`	string	Y	Type of fee P indicate % , B indicate Baht.
`merchantMinimumFee`	number	Y	Minimum transaction fee charges to merchant.
`merchantMinimumFeeType`	string	Y	Always charges as Baht.
`payoutFee`	number	Y	Transaction Fee.
`payoutFeeType`	string	Y	Type of fee P indicate % , B indicate Baht.
`minimum`	number	Y	Minimum amount require for payment.
`maximum`	number	Y	Maximum amount require for payment.
`currency`	string	Y	Currency of payment THB = Thai Baht, BTC = Bitcoin, ETH = Ethereum, USDT = US Dollar USDT coin.
`active`	boolean	Y	Service availability.
`network`	string	Y	BANK_TH = THB, BTC = Bitcoin chain, TRC20 = Tron chain, ERC20 = Ethereum chain, BEP20 = Binance smart chain
`serviceId`	number	Y	Service id of transaction use for create transaction.
`imageUrl`	string	Y	Logo.
`serviceName`	string	Y	Description.

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	N	type for switching of payment ListServiceId

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	"Crypto address".
`crypto_network`	string	Y	Network for tranfer crypto. Noted* Network can possibly be null depending on category of payment.
`currency`	string	Y	Pay with currency.
`address`	string	N	Address of 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.
`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.

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.
(#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.
(#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=${username}`,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.

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,
    "actualAmount": 394,
    "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	Require	Description
`method`	string	Y	"check" or "pay".
`id`	string	Y	Payment Id.
`service_id`	string	Y	Transaction service id indicate the channel of this transaction.
`amount`	number	Y	Amount from "initial payment".
`actualAmount`	number	Y	Amount charge wiht fee.
`fee`	number	Y	Fee.
`order`	string	Y	Order id start with your username and transaction id.
`status`	string	Y	"SUCCESS" (transaction was succesed in Askmepay.)
`timestamp`	number	Y	Current timestamp.
`hash`	string	Y	HmacSha256(`method=${method}&id=${id}&service_id=${service_id}&amount=${amount}&actualAmount=${actualAmount}&order=${order}&timestamp=${timestamp}`,your_secret_key)
`remark`	string	N	Remark.
`isTrust3Party`	boolean	Y	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`)

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	Require	Description
`method`	string	Y	"check" or "pay".
`id`	string	Y	Payment Id.
`service_id`	string	Y	Transaction service id indicate the channel of this transaction.
`amount`	number	Y	Amount from "initial payment".
`actualAmount`	number	Y	Amount charge wiht fee.
`crypto_amount`	number	Y	Actual amount of crypto.
`order`	string	Y	Order id start with your username and transaction id.
`status`	string	Y	"SUCCESS" (transaction was succesed in Askmepay.)
`timestamp`	number	Y	Current timestamp.
`hash`	string	Y	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	N	Remark.
`isTrust3Party`	boolean	Y	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,
  "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	Require	Description
`method`	string	Y	"withdraw".
`id`	string	Y	Payment Id.
`service_id`	string	Y	Transaction service id indicate the channel of this transaction.
`amount`	number	Y	Amount from "initial payment".
`actualAmount`	number	Y	Amount include fee.
`fee`	number	Y	Fee.
`order`	string	Y	Order id start with your username and transaction id.
`timestamp`	number	Y	Current timestamp.
`hash`	string	Y	HmacSha256(`method=${method}&id=${id}&service_id=${service_id}&amount=${amount}&actualAmount=${actualAmount}&order=${order}&timestamp=${timestamp}`,your_secret_key)
`status`	string	Y	"SUCCESS" (transaction was succesed in Askmepay.)
`remark`	string	N	Remark.
`isTrust3Party`	boolean	Y	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

THB Bank Codes

Bank Code	English Bank Name
SCB	Siam Commercial Bank.
BAY	Bank of Ayudhya / Krungsri.
KKP	Kiatnakin Phatra Bank Public Company Limited.
KTB	Krung Thai Bank.
UOB	UOB Bank Plc.
HSBC	The Hongkong and Shanghai Banking Corporation Limited.
GHB	Government Housing Bank.
TISCO	TISCO Bank Plc.
BBL	Bangkok Bank Plc.
KBANK	Kasikorn Bank Plc.
CIMB	CIMB Thai Bank Public Company Limited .
GSB	Government Savings Bank.
BAAC	Bank for Agriculture and Agricultural Cooperatives.
LHBANK	Land and Houses Bank Public Company Limited.
ABN	ABN Amro Bank N.V.
TTB	TMB Thanachart.
CITI	Citibank N.A.
MHCB	Mizuho Corporate Bank Limited.

VND Bank Codes

Bank Code	English Bank Name
ABB	NGAN HANG TMCP AN BINH (ABBANK)
ACB	NGAN HANG TMCP A CHAU (ACB)
VBARD	Ngân hàng Nông nghiệp và Phát triển Nông thôn Việt Nam (AGRIBANK)
BACABANK	Ngân hàng TMCP Bắc Á (BAC A BANK)
BIDV	NGAN HANG TMCP DAU TU VA PHAT TRIEN VIET NAM (BIDV)
CIMB	CIMB
DAB	Ngân Hàng TMCP Đông Á (DONG A BANK)
EXIM	NGAN HANG TMCP XUAT NHAP KHAU VIET NAM (EXIMBANK)
GPBANK	Ngân hàng TM TNHH MTV (GPBANK)
HDB	NGAN HANG TMCP PHAT TRIEN TP.HCM (HDBANK)
HLBANK	NGAN HANG TNHH MTV HONGLEONG VIET NAM (HLBANK)
HSBC	HSBC Bank Vietnam Ltd (HSBC)
IVB	NGAN HANG TNHH INDOVINA (INDOVINA BANK)
KLB	Kien Long Joint-stock Commercial Bank (KienLongBank)
LVPB	NGAN HANG BUU DIEN LIEN VIET (LIENVIETPOSTBANK)
MB	NGAN HANG TMCP QUAN DOI (MB)
MSB	NGAN HANG TMCP HANG HAI VIET NAM (MARITIME BANK)
NAMABANK	Ngân hàng TMCP Nam Á (NAM A BANK)
NCB	NGAN HANG TMCP QUOC DAN (NCB)
OCB	NGAN HANG TMCP PHUONG DONG (OCB)
OJB	NGAN HANG TMCP DAI DUONG (OCEANBANK)
PGBANK	Ngân hàng TMCP Xăng dầu Petrolimex (PG Bank)
PVCOMBANK	Ngân hàng TMCP Đại Chúng Việt Nam (PVCOMBANK)
SHB	Ngân hàng TMCP Sài Gòn Công Thương (SAIGONBANK)
SCB	NGAN HANG TMCP SAI GON (SCB)
SEABANK	NGAN HANG TMCP DONG NAM A (SEABANK)
SHBVN	NGAN HANG TMCP SAI GON - HA NOI (SHB)
SHINABANK	SHINHAN Bank (Vietnam) Ltd
TCB	NGAN HANG TMCP KY THUONG VIET NAM (TCB)
TPBANK	NGAN HANG TMCP TIEN PHONG (TPBANK)
VCB	NGAN HANG TMCP NGOAI THUONG VIET NAM (VIETCOMBANK)
VIB	Ngân Hàng Quốc Tế (VIB)
VIETABANK	Ngân hàng thương mại cổ phần Việt Á (VIET A BANK)
VIETCAPITALBANK	Ngân hàng TMCP Bản Việt (VIET CAPITAL BANK)
VP	NGAN HANG TMCP VIET NAM THINH VUONG (VPBANK)
VTB	NGAN HANG TMCP CONG THUONG VIET NAM (VIETINBANK)
WOORIBANK	Woori Bank Vietnam Limited
BVB	BAO VIET BANK (BVB)
SCM	Sacombank

VND Bank Codes (E-wallet)

Bank Code	English Bank Name
MOMOPAY_VN	MOMO E-wallet

PHP Bank Codes (Gcash)

Bank Code	English Bank Name
GCASH	GCASH

PHP Bank Codes (Paymaya)

Bank Code	English Bank Name
PMP	Paymaya

IDR Bank Codes

Bank Code	English Bank Name
BANKACEH.ID	Bank Aceh (BPD Aceh)
BANKALTIMTARA_CO.ID	Bank BPD Kaltimtara
BPDNTT_CO.ID	Bank BPD NTT
BTN.ID	Bank BTN
BJG.ID	Bank Jago (BJG)
BANKNEOCOMMERCE_CO.ID	Bank Neo Commerce (BNC)
BRI.ID	Bank Rakyat Indonesia
BANKSINARMAS.ID	Bank Sinarmas
BANKSUMUT.ID	Bank Sumut (BPD Sumatera Utara)
BANKBSI.ID	Bank Syariah Indonesia
BANKBSI_CO.ID	Bank Syariah Indonesia (BSI)
UOB.ID	Bank UOB Indonesia
BCA.ID	BCA
BNI.ID	BNI
CCB_INDONESIA.ID	China Construction Bank Indonesia
CIMBNIAGA.ID	CIMB NIAGA
CITIBANKMY.ID	Citibank
COMMONWEALTH_BANK.ID	COMMONWEALTH BANK

IDR VA Bank Codes (Virtual Account)

Bank Code	English Bank Name
BCA.VA.ID	BCA Bank Virtual Account
BRI.VA.ID	BRI Rakyat Indonesia Virtual Account
BNI.VA.ID	BNI Negara Indonesia Virtual Account
BNC.VA.ID	BNC Virtual Account
BSI.VA.ID	SYARIAH INDONESIA Virtual Account
CIMB.VA.ID	CIMB NIAGA Virtual Account
DANAMON.VA.ID	DANAMON Virtual Account
MANDIRI.VA.ID	MANDIRI Virtual Account
MAYBANK.VA.ID	MAYBANK Virtual Account
PERMATA.VA.ID	PERMATA Virtual Account

IDR Bank Codes (QRIS)

Bank Code	English Bank Name
QRIS.QR.ID	QRIS

IDR Bank Codes (E-wallet)

Bank Code	English Bank Name
DANA.EWALLET.ID	DANA E-wallet
OVO.EWALLET.ID	OVO E-wallet

INR Bank Codes

Bank Code	English Bank Name
ASFB	AU Small Finance Bank
AUSFB	AUSF Business
AXIS	AXIS Bank
AXISNEO	AXIS Bank NEO Business
BAN	BANDHAN Bank
BOB	Bank of Baroda Retai
BOI	Bank of India Online Omni Neo
BB	BHARAT Pe Bank
BOMRETAIL	Bank of Maharashtra Retail
CAN	Canara bank
CBOI	Central Bank of India Personal
CUB	CITY UNION BANK
CSB	CSB Bank
FED	Federal Bank
HDFC	HDFC Bank
ICICI	ICICI Bank Personal
IDBI	IDBI Bank Personal
IDFC	IDFC First Bank Personal
IB	Indian Bank Individual (Personal)
INDIE	IndusInd Bank Personal
IOB	IO Bank (Personal)
KB	Karnataka Bank (KBL ONE) Corporate
KOTAK	KOTAK Bank
PPB	PayTM dashboard
PHONEPE	PhonePe Business Dashboard
PASB	Punjab & Sind Bank Corporate
PNB	Punjab National Bank (Personal)
RBL	RBL Bank Personal
SAR	Saraswat Co-operative Bank
SBI	State Bank of India Personal (SBI PERSONAL)
SIB	South Indian Bank (Personal)
SVCBANK	SHAMRAO VITHAL CO-OP Bank
TMBL	Tamilnad Mercantile Bank (TMB)
UB	UCO Bank Retail
USFB	Ujjivan SF Bank Personal
UBI	Union Bank
UTK	Utkarsh Small Finance Bank (Personal)
YES	YES Bank (YESFirst)
YESMSME	YES MSME (YES Bank)
YESPROSPERITY	YES Bank (YESProsperity)
YONOSBI	YONO SBI Bank Corporate

INR Bank Codes (UPI)

Bank Code	English Bank Name
ASFB	AU Small Finance Bank
AXIS	Axis Bank
BB	BHARAT BANK
BAN	Bandhan Bank
BOB	Bank of Baroda
BOI	Bank of India
BOMRETAIL	Bank of Maharashtra
CSB	CSB Bank
CAN	Canara Bank
CBOI	Central Bank of India
CUB	City Union Bank
FED	Federal Bank
ICICI	ICICI Bank
IDBI	IDBI Bank
IDFC	IDFC First Bank
IB	Indian Bank
INDIE	IndusInd Bank
KB	Karnataka Bank
KOTAK	Kotak Mahindra Bank
PPB	PAYTM PAYMENTS BANK
PNB	Punjab National Bank
PASB	Punjab and Sind Bank
RBL	RBL BANK LTD
SIB	South Indian Bank
SBI	State Bank of India
TMBL	Tamilnad Mercantile Bank Limited
UB	UCO Bank
UBI	Union Bank of India
UTK	Utkarsh Small Finance Bank
YES	Yes Bank
SAR	USaraswat bank

MYR Bank Codes

Bank Code	English Bank Name
ALB.MY	Alliance Bank
AFB.MY	Affin Bank
ARB.MY	Ambank
BIMB.MY	Bank Islam
BKR.MY	Bank Kerjasama Rakyat
BSN.MY	Bank Simpanan Nasional
CIMB.MY	CIMB Bank
HLB.MY	HONG LEONG BANK
HSBC.MY	HSBC BANK
MBB.MY	Maybank
OCBC.MY	OCBC BANK
PBB.MY	PUBLICBANK
RHB.MY	RHBBANK
SCB.MY	STANDARD CHARTERED
UOB.MY	UNITED OVERSEA BANK

BRL Bank Codes (PIX)

Bank Code	English Bank Name
PIX	PIX

KRW Bank Codes

Bank Code	English Bank Name
KYUNGNAM	BNK경남은행
DAEGU	DGB대구은행
IBK	IBK기업은행
KBSTAR	KB국민은행
NHBANK	NH농협은행
SCB	SC제일은행
KWANGJU	광주은행
BUSANBANK	부산은행
MSB	상호저축은행
KFCC	새마을금고
SUHYUP	수협은행
SHINHANSEC	신한금융투자
SHINHANCHINA	신한은행
CREDITUNION	신협
HVBKKRSE	우리은행
KOREAPOST	우정사업본부
JEONBUK	전북은행
JEJUBANK	제주은행
KAKAOBANK	카카오뱅크
TOSS	토스뱅크
HANABANK	하나은행
KDB	한국산업은행
KOREACHARTERED	한국스탠다드차타드은행
CITIBANKKOREA	한국씨티은행
KEB	한국외환은행
BOK	한국은행
HSBCKOREA	홍콩상하이은행 서울지점의 현황

KRW VA Bank Codes (Virtual Account)

Bank Code	English Bank Name
TOSS.VA	토스 뱅크
SUHYUP.VA	수협 은행
CREDITUNION.VA	신협 은행
LCB.VA	축협 은행
CITIBANKKOREA.VA	씨티 은행
BANKOFKOREA.VA	저축 은행
KBANK.VA	케이 뱅크
KFCC.VA	새마을 금고
KWANGJU.VA	광주 은행
PB.VA	우체국 은행
DAEGU.VA	대구 은행
BUSANBANK.VA	부산 은행
IBK.VA	IBK 기업 은행
SCB.VA	SC 제일 은행
HANABANK.VA	하나 은행
HVBKKRSE.VA	우리 은행
SHINHANCHINA.VA	신한 은행
LAC.VA	지역 농협
NHBANK.VA	농협 은행
KAKAOBANK.VA	카카오 뱅크
KBSTAR.VA	KB국민은행
KYUNGNAM.VA	경남 은행

TRY Bank Codes (Papara)

Bank Code	English Bank Name
PAPARA	Papara

TRY Bank Codes (PAYPIX)

Bank Code	English Bank Name
PAYPIX	Payfix

TRY Bank Codes (IBAN)

Bank Code	English Bank Name
ZIRAAT	Ziraat Bankası
ISBANK	İş Bankası
YAPIKREDI	Yapı Kredi Bankası
VAKIF	VakıfBank
HALK	Halkbank
GARANTI	Garanti BBVA
QNB	QNB Finansbank
AKBANK	Akbank
DENIZ	DenizBank
TEB	TEB (Türk Ekonomi Bankası)
ING	ING Bank
TURKIYEFINANS	Türkiye Finans Katılım Bankası
SEKER	Şekerbank
KUVEYTTURK	Kuveyt Türk Katılım Bankası
ODEABANK	Odeabank
ENPARA	Enpara (QNB Finansbank)

Service Id

List Service Id

ServiceId	Service Currency	Details
"100"	THB	THB Service Id Details
"200"	VND	VND Service Id Details
"201"	VND (E-wallet)	VND E-wallet Service Id Details
"300"	PHP (Gcash)	PHP Gcash Service Id Details
"301"	PHP (Paymaya)	PHP Paymaya 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
"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 Service Id Details
"1110"	TRY (Mefete)	TRY Service Id Details
"1120"	TRY (PayFix)	TRY Service Id Details
"1130"	TRY (Parazula)	TRY Service Id Details
"1140"	TRY (IBAN)	TRY Service Id Details

Crypto

List Crypto Currency

CurrencyId	Currency Name
"USDT"	USDT

List Crypto Network

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

Features Release

Date: 30/07/2024

Back office Askmepays

- New Feature: new provider report.

- New Feature: show approver and remarks on status.

- Improve: naming provider and report details.

- Improve: redesign cash wallet page.

- Fix Bug: two factor authentication.

System Service

- Improve: refactor payment gateway logic.

- Improve: money wallet flow.

Date: 24/07/2024

Back office Askmepays

- New Feature: show response log when AMP call to clients.

- New Feature: two factor authentication.

- New Feature: notification for third party application.

- Fix Bug: when change status with multiple request.

- Fix Bug: export data to excel on payout pages.

System Service

- New Feature: notification for third party application.

- New Feature: name verification for deposit transaction.

- New Feature: switch for bypass service.

- Improve: frequency of retry process.

- Improve: apply retry process and remove dispute status for another provider.

- Improve: settlement details for crosscheck.

- Improve: infra health checker.

- Improve: prevented double transaction on top up and deduct process.

- Improve: new api environment for testing.

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

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

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

Parameter Description

Response Description

Error Code and Description

Common Error Code

Bank Codes

THB Bank Codes

VND Bank Codes

VND Bank Codes (E-wallet)

PHP Bank Codes (Gcash)

PHP Bank Codes (Paymaya)

IDR Bank Codes

IDR VA Bank Codes (Virtual Account)

IDR Bank Codes (QRIS)

IDR Bank Codes (E-wallet)

INR Bank Codes

INR Bank Codes (UPI)

MYR Bank Codes

BRL Bank Codes (PIX)

KRW Bank Codes

Get All Service `POST`

Initial Payment `POST`

Initial Crypto Payment `POST`

Payout `POST`

Payout Crypto `POST`

Get Balance `POST`

Deposit Callback `POST`

Deposit Crypto Callback `POST`

Withdraw Callback `POST`