MERCHANT SUPPORT TOOL
INFO QUERY API
Version 9.0 (Staging)
Abstract
This content will assist our merchant to utilize the data collection from our dedicated API for
a faster and efficient result to assist your customer and operation in different situation.
feedback@help2pay.com
Contents
Summary of Merchant Info Query API List............................................................................................ 2
Responses and Return Status ................................................................................................................ 3
Query API List:
1. Get Deposit Status by Reference ID.......................................................................................... 4
2. Get Payout Status by Reference ID........................................................................................... 5
3. Get Daily Deposit List ................................................................................................................ 6
4. Get Daily Payout List ................................................................................................................. 7
5. Get Deposit Bank Status List by Currency (Active or Under maintenance) ............................ 8
6. Get Payout Bank Status List by Currency (Active or Under maintenance) ........................... 10
7. Get Merchant Balance List ...................................................................................................... 12
The implementation of Merchant Info Query API required your IT development team to review and
execute. You may approach our Help2pay team anytime if required any assistance or discussion.
1
Summary of Merchant Info Query API List
Query API Usage Query API Description
Get Deposit Status by Reference ID
To request and get a Deposit ID status by reference ID from H2P
Merchant BO to merchant own back office
Retrieve Specific
Transaction Status Get Payout Status by Reference ID
To request and get a Payout ID status by reference ID from H2P
Merchant BO to merchant own back office
Get Daily Deposit List
To request and get the Deposit list data by transaction date from
H2P Merchant BO to merchant own back office
Limit API calling intermediate time by 5 minutes
Retrieve Daily
Transaction Report Get Daily Payout List
To request and get the Payout list data by transaction date from
H2P Merchant BO to merchant own back office
Limit API calling intermediate time by 5 minutes
Get Deposit Bank Status List by Currency
To request and check whether the Deposit bank is active or under
maintenance by currency from H2P Merchant BO to merchant own
back office
Retrieve Help2pay Max 5 API calls per minute
Bank status
Get Payout Bank Status List by Currency
To request and check whether the Payout bank is active or under
maintenance by currency from H2P Merchant BO to merchant own
back office
Max 5 API calls per minute
Get Merchant Balance List
To get their balance summary from H2P Merchant BO to merchant
Retrieve Merchant own back office
Balance Cache 5 minutes (Balance data will remain the same within the
duration)
Disclaimer: Merchant will be subjected to suspension from using this add-on service if
found abnormal calling or usage of the Query API function.
2
Responses and Return Status
This IP Whitelist action is mandatory to prevent unknown API response from
unauthorized location
**Please provide your server IP to whitelist access
Staging {ApiUrl}: https://query.testingzone88.com/
All request use POST method.
Response:
Invalid request will return as error html
Valid request will return the transaction info in XML format, please refer document for
detailed Status Code.
Deposit Return Status
Code Status Description
000 Success Deposit process is successful.
001 Failed Transfer process is incomplete. Possible reasons: The Bank or the user
terminates the process before it is completed
002 Lost Error happens on the time of transfer.
006 Approved The transfer approved by Gateway after verified that the transfer was
completed.
007 Rejected The transfer reject by Gateway after verifying the transfer was not
completed or failed.
008 Canceled The transfer has been cancelled.
009 Pending The transfer still in pending status.
Payout Return Status
Code Status Description
000 Success/Approved Payout process is successful.
001 Failed/Rejected Transfer process is incomplete. Possible reasons: The user details is
incorrect
002 Pending The payout still in pending status.
003 Processing The payout is processing.
Error Message
Message Description
Duplicated Reference ID had Error occurred due to got more than 1 reference ID, please contact
been submitted operation for further assists.
3
Get Deposit Status by Reference ID
(Staging) API: {ApiUrl}/Services/Merchants/{MerchantCode}/TransferStatus/{RefID}
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/TransferStatus/12345678
Parameter:
{MerchantCode}: Your merchant code
{RefID}: Your system transaction ID, the reference ID that passing with deposit request
Result:
<MerchantService.CheckStatus
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Amount>100.0000</Amount>
<CurrencyCode>THB</CurrencyCode>
<CustomerID>Custormer111</CustomerID>
<ErrorCode>AccountIssue</ ErrorCode>
<ID>126736</ID>
<Key>12DASD2312DAD</Key>
<Message>000</Message>
<StatusCode>000</StatusCode>
<UpdatedDate>2019-03-03T01:35:54.557</UpdatedDate>
</MerchantService.CheckStatus>
4
Get Payout Status by Reference ID
(Staging) API: {ApiUrl}/Services/Merchants/{MerchantCode}/FundOutStatus/{RefID}
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/FundOutStatus/12345678
Parameter:
{MerchantCode}: Your merchant code
{RefID}: Your system transaction ID, the reference ID that passing with deposit request
Result:
<MerchantService.CheckStatus
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Amount>10.0000</Amount>
<CurrencyCode>MYR</CurrencyCode>
<CustomerID>Customer100</CustomerID>
<ID>5122</ID>
<Message>009</Message>
<StatusCode>009</StatusCode>
<UpdatedDate>2019-01-30T04:06:35.78</UpdatedDate>
</MerchantService.CheckStatus>
5
Get Daily Deposit List
(Staging) API: {ApiUrl}/Services/Merchants/{MerchantCode}/CheckDailyDeposits/{Date}
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/CheckDailyDeposits/20200411
Parameter:
{MerchantCode}: Your merchant code
{Date}: Your system transaction date, format in “yyyyMMdd”
**Please be informed to ensure good query performance, system will limit API calling intermediate
time by 5 minutes for this function.
Result:
<MerchantService.ReturnResult
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Errors xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<Success>true</Success>
<TransactionObject>
<MerchantService.TransactionObject>
<Amount>50.0000</Amount>
<CreatedDate>20200411055009</CreatedDate>
<CurrencyCode>MYR</CurrencyCode>
<Customer>Custormer111</Customer>
<Fee>0.5000</Fee>
<ID>148901</ID>
<ReferenceID>2020041105500276</ReferenceID>
<StatusCode>009</StatusCode>
<TransactionDate>20200411125002</TransactionDate>
<UpdatedDate>20200411055040</UpdatedDate>
</MerchantService.TransactionObject>
</TransactionObject>
<UpdatedDate>20200424085441</UpdatedDate>
</MerchantService.ReturnResult>
Return Data:
date in format: yyyyMMddHHmmss
6
Get Daily Payout List
(Staging) API: {ApiUrl}/Services/Merchants/{MerchantCode}/CheckDailyPayouts/{Date}
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/CheckDailyPayouts/20200411
Parameter:
{MerchantCode}: Your merchant code
{Date}: Your system transaction date, format in “yyyyMMdd”
**Please be informed to ensure good query performance, system will limit API calling intermediate
time by 5 minutes for this function.
Result:
<MerchantService.ReturnResult
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Errors i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<Success>true</Success>
<TransactionObject>
<MerchantService.TransactionObject>
<Amount>357.0000</Amount>
<CreatedDate>20200415102248</CreatedDate>
<CurrencyCode>MYR</CurrencyCode>
<Customer>player01</Customer>
<Fee>35.7000</Fee>
<ID>7058</ID>
<ReferenceID>140073791</ReferenceID>
<StatusCode>009</StatusCode>
<TransactionDate>20200415182233</TransactionDate>
<UpdatedDate/>
</MerchantService.TransactionObject>
</TransactionObject>
<UpdatedDate>20200424090243</UpdatedDate>
</MerchantService.ReturnResult>
Return Data:
All date in format: yyyyMMddHHmmss
7
Get Deposit Bank Status List by Currency (Active or Under maintenance)
(Staging): {ApiUrl}/Services/Merchants/{MerchantCode}/DepositBank/{CurrencyCode}
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/DepositBank/MYR
Parameter:
{MerchantCode}: Your merchant code
{CurrencyCode} Your requested bank currency
**Please be informed to ensure good query performance, system will limit maximum 5 API calls per
minute for this function.
Result Model
MerchantService.ReturnBankStatusResult
Property Data Type Description
Success boolean API status
UpdatedDate string API queried date time (Format:
yyyyMMddHHmmss)
Errors Array of string List of error message(s)
BankObject Array of Display list of banks and its
MerchantService.BankStatus maintenance status
MerchantService.BankStatus
Property Data Type Description
BankCode string Bank Code
IsMaintenance boolean Bank under maintenance status
MaintenanceEndDate string Bank’s maintenance end date (Format:
yyyy-MM-dd HH:mm:ss)
8
Result:
<MerchantService.ReturnBankStatusResult
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<BankObject>
<MerchantService.BankStatus>
<BankCode>MBB</BankCode>
<IsMaintenance>true</IsMaintenance>
<MaintenanceEndDate>2021-07-30 00:00:00</MaintenanceEndDate>
</MerchantService.BankStatus>
</BankObject>
<Errors i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<Success>true</Success>
<UpdatedDate>20210729073207</UpdatedDate>
</MerchantService.ReturnBankStatusResult>
9
Get Payout Bank Status List by Currency (Active or Under maintenance)
(Staging): {ApiUrl}/Services/Merchants/{MerchantCode}/PayoutBank/{CurrencyCode}
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/PayoutBank/MYR
Parameter:
{MerchantCode}: Your merchant code
{CurrencyCode} Your requested bank currency
**Please be informed to ensure good query performance, system will limit maximum 5 API calls per
minute for this function.
Result Model
MerchantService.ReturnBankStatusResult
Property Data Type Description
Success boolean API status
UpdatedDate string API queried date time (Format:
yyyyMMddHHmmss)
Errors Array of string List of error message(s)
BankObject Array of Display list of banks and its
MerchantService.BankStatus maintenance status
MerchantService.BankStatus
Property Data Type Description
BankCode string Bank Code
IsMaintenance boolean Bank under maintenance status
MaintenanceEndDate string Bank’s maintenance end date (Format:
yyyy-MM-dd HH:mm:ss)
10
Result:
<MerchantService.ReturnBankStatusResult
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<BankObject>
<MerchantService.BankStatus>
<BankCode>MBB</BankCode>
<IsMaintenance>false</IsMaintenance>
<MaintenanceEndDate i:nil="true"/>
</MerchantService.BankStatus>
</BankObject>
<Errors i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<Success>true</Success>
<UpdatedDate>20210729071105</UpdatedDate>
</MerchantService.ReturnBankStatusResult>
11
Get Merchant Balance List
(Staging): {ApiUrl}/Services/Merchants/{MerchantCode}/MerchantBalance
e.g.: https://query.testingzone88.com/Services/Merchants/TEST01/MerchantBalance
Parameter:
{MerchantCode}: Your merchant code
**Please be informed to ensure good query performance, system will cache 5 minutes (Balance data
will remain the same within the duration) for this function.
Result Model
MerchantService.ReturnMerchantBalanceResult
Property Data Type Description
Success Boolean API status
BalanceUpdatedDate string Balance updated date (Format:
yyyyMMddHHmmss)
Errors Array of string List of error message(s)
BalanceObject Array of Display list of currency and balance
MerchantService.BalanceObject
MerchantService.BalanceObject
Property Data Type Description
AvailableBalance decimal Merchant’s available balance
CurrencyCode string Merchant’s supported currency code
CurrentBalance decimal Merchant’s current balance
PendingFundOut decimal Merchant’s pending fund out amount
PendingSettlement decimal Merchant’s pending settlement amount
12
Result:
<MerchantService.ReturnMerchantBalanceResult
xmlns="http://schemas.datacontract.org/2004/07/Services.Public"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<BalanceObject>
<MerchantService.BalanceObject>
<AvailableBalance>203646981.0000</AvailableBalance>
<CurrencyCode>IDR</CurrencyCode>
<CurrentBalance>203646981.0000</CurrentBalance>
<PendingFundOut>101002.0000</PendingFundOut>
<PendingSettlement>0.0000</PendingSettlement>
</MerchantService.BalanceObject>
</BalanceObject>
<BalanceUpdatedDate>20210729071637</BalanceUpdatedDate>
<Errors i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
<Success>true</Success>
</MerchantService.ReturnMerchantBalanceResult>
13
