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-Type | application/json | ||
Field | Field Length | Required | Descriptions |
mid | string(50) | Y | merchant id |
secret key | string(50) | Y | secret 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-Type | application/json | ||
Field | Field Length | Required | Descriptions |
order_id | string(50) | Y | Unique self-generated id for the order |
amount | string(12) | Y | The format will be 00.00,two decimal places。 Ex:$10,the amount submitted should be 10.00 |
product_name | string(100) | Y | |
currency | string(3) | Y | “THB” OR “PHP” |
notify_url | string(255) | Y | After successful payment, the server will push the result page , merchants can process accordingly to update the database |
pix_account | string(255) | Only for Brazil, the number of CPF (Mandatory) | |
tax_number | string(255) | Only for Brazil, this is tax number for CPF/CNPJ | |
payer_account_number | string(255) | Only for Thailand pay-in which method is BANK, this is means your paying bank account no | |
payment_type | string(255) | Y | “Qr” |
After the deposit request completed, the result will response via POST method to, parameters as below:
ContentType | application/json | |||
Field | Field Name | Field Length | Required | Descriptions |
status_code | Deposit request status code | string(2) | V | 1:Pending 2:Processing 3:Successful 4: Failed |
order_id | Order ID | string(50) | Unique id for the order | |
amount | string | The format will be 00.00,two decimal places. Ex:$10,the amount submitted should be 10.00 | ||
product_name | product | string(100) | ||
currency | currency | string(3) | “THB”, “PHP”, “BRL”, “INR”, “KRW”,”MXN” | |
qr_code | QR Code | QR Code | ||
url | Redirect url | If you get field url, please redirect this to webpage |
2.3 Payout API
The API will send through the method of POST (ContentType=”application/json”), parameters as below;
URL: api/payout/order
Content-Type | application/json | ||
Field | Field Length | Required | Descriptions |
order_id | string(50) | Y | Unique self-generated id for the order |
amount | string(12) | Y | The format will be 00.00,two decimal places。 Ex:$10,the amount submitted should be 10.00 |
product_name | string(100) | Y | |
currency | string(3) | Y | “BRL” |
notify_url | string(255) | Y | After successful payment, the server will push the result page , merchants can process accordingly to update the database |
pix_account | string(255) | Only for Brazil, the number of CPF (Mandatory) | |
tax_number | string(255) | Only for Brazil, this is tax number for CPF/CNPJ | |
account_name | string(255) | Only for India, this field required | |
account_number | string(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_number | string(255) | Only for Thailand pay-in which method is QRPAY,this is means your paying account number | |
payment_type | string(255) | Y | “CPF”, “Email” |
After the deposit request completed, the result will response via POST method to , parameters as below:
ContentType | application/json | |||
Field | Field Name | Field Length | Required | Descriptions |
status_code | Deposit request status code | string(2) | V | 1:Pending 2:Processing 3:Successful 4: Failed |
order_id | Order ID | string(50) | Unique id for the order | |
amount | string | The format will be 00.00,two decimal places. Ex:$10,the amount submitted should be 10.00 | ||
product_name | product | string(100) | ||
currency | currency | string(3) | “THB”, “PHP”, “BRL”, “INR”, “KRW”,”MXN” |
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"
}
}
Annex:
Payment Currency & Payment Type List
Currency | paytype | Method Name |
THB | QR | QR |
PHP | paymaya | E-wallet – Maya |
PHP | brankas_bdo | BDO Online via Brankas |
PHP | brankas_landbank | Landbank Online via Brankas |
PHP | metrobank | Metrobank Online via Brankas |
PHP | dob | BPI Online |
PHP | dob_ubp | UnionBank Online |
PHP | grab_pay | E-Wallet – GrabPay |
PHP | gcash | Gcash |
MXN | spei | Spei Bank Transfer |
BRL | pix | PIX Payment |
VND | p2p | P2P Solution |
BRL | CPF | CPF |
INR | inbank_upi | India UPI |
Pay Out Currency & Payment Type List
Currency | paytype | Method Name |
BRL | CPF | CPF Payment |
BRL | CPF Payment |