View Categories

API Documentation

1. System flow

1.1. Login to API to get a bearer token
1.2. Perform transaction API accordingly

2. API

2.1. Login Token
This is to generate the bearer token that going to use for the rest of the API

URL: api/login

Content-Typeapplication/json
FieldField Length RequiredDescriptions
midstring(50) Ymerchant id
secret_key  string(50) Ysecret key provided

2.2. Create order
Once user requests to create oder, an unique orderID is required. , The API will send through
the method of POST (ContentType=”application/json”), parameters as below;

URL: api/pay/order

Content-Typeapplication/json
FieldField Length RequiredDescriptions
order_idstring(50) YUnique self-generated id for the order
amountstring(12) YThe format will be 00.00,two decimal places。
Ex:$10,the amount submitted should be 10.00
product_namestring(100) Y
currencystring(3) Y“THB”, “PHP”, “BRL”, “INR”,  “KRW”, “MXN”, “SGD”, “USD”, “USDT”, “KRW”, “IDR” 
notify_urlstring(255) YAfter successful payment, the server will push the result page ,
merchants can process accordingly to update the database
pix_accountstring(255)Only for Brazil, the number of CPF (Mandatory)
tax_numberstring(255)Only for Brazil, this is tax number for CPF/CNPJ
payer_account_numberstring(255)Only for Thailand pay-in which method is BANK, this is means your paying bank account no
bank_no string(255) Only for IDR pay-in 
payment_typestring(255) Y“Qr”
redirect_urlstring(255) This field is required for “card” payment methods, and also required for “USD” and “SGD” currency.
back_urlstring(255) This field is required for “card” payment methods, and also required for “USD” and “SGD” currency. 

After the deposit request completed, the result will response via POST method to, parameters as below:

ContentTypeapplication/json
FieldField NameField LengthRequiredDescriptions
idgen3pay transaction id integergen3pay transaction id 
status_textDeposit request status text string (50) Deposit request raw status text 
status_codeDeposit request status codestring(2) V1:Pending
2:Processing
3:Successful
4: Failed
order_id Order ID string(50) Unique id for the order
amountstringThe format will be 00.00,two
decimal places.
Ex:$10,the amount submitted
should be 10.00
product_nameproductstring(100) 
currencycurrencystring(3) “THB”, “PHP”, “BRL”, “INR”,  “KRW”, “MXN”, “SGD”, “USD”, “USDT”, “KRW”, “IDR” 
qr_codeQR CodeQR Code

2.3 Payout API

The API will send through the method of POST (ContentType=”application/json”), parameters as below;

URL: api/payout/order

Content-Typeapplication/json
FieldField Length RequiredDescriptions
order_idstring(50) YUnique self-generated id for the order
amountstring(12) YThe format will be 00.00,two decimal places。
Ex:$10,the amount submitted should be 10.00
product_namestring(100) Y
currencystring(3) Y“BRL”
notify_urlstring(255) YAfter successful payment, the server will push the result page ,
merchants can process accordingly to update the database
pix_accountstring(255)Only for Brazil, the number of CPF (Mandatory)
tax_numberstring(255)Only for Brazil, this is tax number for CPF/CNPJ
account_namestring(255)Only for India, this field required
account_numberstring(255)Only for Brazil and India. For Brazil the number of CPF/EMAIL account  (Mandatory), and for India the number format is UPI address.
payer_account_numberstring(255)Only for Thailand pay-in which method is QRPAY,this is means your paying account number
payment_typestring(255) Y“CPF”, “Email”

After the deposit request completed, the result will response via POST method to , parameters as below:

ContentTypeapplication/json
FieldField NameField LengthRequiredDescriptions
idgen3pay transaction id integergen3pay transaction id number 
status_codeDeposit request status codestring(2) V1:Pending
2:Processing
3:Successful
4: Failed
status_textDeposit request status text string(50)Deposit request raw status text 
order_id Order ID string(50) Unique id for the order
amountstringThe format will be 00.00,two
decimal places.
Ex:$10,the amount submitted
should be 10.00
product_nameproductstring(100) 
currencycurrencystring(3) “THB”, “PHP”, “BRL”, “INR”,  
“KRW”, “MXN”, “SGD”, 
“USD”, “USDT”, “KRW”, 
“IDR” 
reference_numbertransaction reference number string (255) Transaction reference number 

2.4 Balance API

The API will send through the method of GET (Accept=”application/json”), url as below;

URL: api/merchant/credit/balances

Sample Response:

{
   "data": {
       "brl": {
           "symbol": "R$",
           "currency_name": "Brazilian Real",
           "total_amount": "990.00",
           "items": [
               {
                   "payment_type_name": "CPF",
                   "currency": "brl",
                   "total_amount": 2000,
                   "total_fee_amount": 300,
                   "total_deposit_amount": 2250,
                   "total_deposit_fee_amount": 250,
                   "total_withdrawal_amount": 450,
                   "total_withdrawal_fee_amount": 50,
                   "total_transactions": 4,
                   "settled_amount_after_fees": 2110,
                   "available_for_settlement_before_fees": 2120
               }
           ]
       }
   },
   "meta": {
       "message": "Balances"
   }
}

2.5 Get Order Status

The API will send through the method of GET (Accept=”application/json”), url as below;

URL: api/pay/order/<order id>

Sample Response: 

{ 
   "data": { 
       "id": 21, 
       "created_at": "2025-02-25 03:07:32",
       "updated_at": "2025-02-25 03:07:32", 
       "amount": "100.00", 
       "remarks": "", 
       "order_id": "12319910", 
       "product_name": "Payment",
       "reference_number": "20250225110732u4H3M", 
       "currency": "THB", 
       "qr_string": null, 
       "status_code": 1,
       "status_text": "pending" 
   } 
} 

  

Annex:

Pay In Currency & Payment Type List

CurrencypaytypeMethod Name
THBQRQR
PHPpaymayaE-wallet – Maya
PHPbrankas_bdoBDO Online via Brankas
PHPbrankas_landbankLandbank Online via Brankas
PHPmetrobankMetrobank Online via Brankas
PHPdobBPI Online
PHPdob_ubpUnionBank Online
PHPgrab_payE-Wallet – GrabPay
PHPgcashGcash
MXNspeiSpei Bank Transfer
BRLpixPIX Payment
BRLCPFCPF
VNDp2cP2C Solution 
VNDOB OB 
VNDMOMOMOMO
VNDZaloZalo
VNDViettelpayViettelpay
IDROBOB
IDRVAVA
IDRVABCAVABCA
IDRQRISQRIS
INRinbank_upiIndia UPI
USDcardcard
SGDcardcard
IDRcardCard (Visa/master card) 
KRWcardCard (Visa/master card) 
THBcardCard (Visa/master card) 
BRLcardCard (Visa/master card) 
IDRapmAlternative Payment methods 
KRWapmAlternative Payment methods 
THBapmAlternative Payment methods 
BRLapmAlternative Payment methods 

Pay Out Currency & Payment Type List

CurrencypaytypeMethod Name
BRLCPFCPF Payment
BRLEmailCPF Payment

Pay Out Currency & Payment Type List

banknobank name
BCABank Central Asia
BNIBank Negara Indonesia

Updated on August 11, 2025
This website uses cookies and asks your personal data to enhance your browsing experience. We are committed to protecting your privacy and ensuring your data is handled in compliance with the General Data Protection Regulation (GDPR).