API Reference

Payout

Payouts and cashouts are the other key function class available in the OmniPay instant collection and payout service set. Payouts and cashouts maybe requested by partners and their merchants through real-time API connection and call.

The current supported channel for payout/cashout are:
 Bank Direct (request for list of supported Banks from OmniPay)

Future versions for the API will support InstaPay and Pesonet for local Philippine channels , and further improve options for merchants and partners with minimal programming.

Upon successful posting, the system response will contain the transaction id and a message for success.

Sample Request


{
    "merchantid": "INSTAPAYTEST001",
    "password": "INSTAPAYTESTTEST987*!",
    "trackid": "Reference id from merchant system",
    "PaymentRefDateTime": "12/13/2023 11:15",
    "BankName": "Metrobank",
    "AccountNumber": "A1234567-12345",
    "AccountName": "Juan dela cruz",
    "Amount": "15000.00",
    "Currency": "PHP"
}

Sample Response

## Success Response
{
    "type": "valid",
    "result": "Success",
    "responsecode": "0",
    "transactionid": "1885601",
    "trackid": "Reference id from merchant system",
    "merchantid": "INSTAPAYTEST001",
    "redirectUrl": null,
    "error_code_tag": null,
    "error_text": "Success"
}

## Unsuccessful Response
{
    "type": "valid",
    "result": "Not Successful",
    "responsecode": "6",
    "transactionid": "2795041",
    "trackid": "Reference id from merchant system",
    "merchantid": "INSTAPAYTEST001",
    "redirectUrl": null,
    "error_code_tag": null,
    "error_text": "Invalid partner and merchant id. Please contact OmniPay for support or check the partner and merchant id sent to you."
}
List of Institutions / Participants of Instapay
The table below lists the currently known participants of InstaPay. Please use the EXACT name as shown below.
Alipay B3 B65Philippines
Asia United Bank Corporation
Banana Fintech Services Corporation
Bank of China Limited (Manila Branch)
BDO Unibank Inc
Bank of the Philippine Islands / BPI Family
BPI Direct Banko Inc A Savings Bank
CARD MRI Rizal Bank Inc
CARD BANK Inc
Cebuana Lhuillier Rural Bank Inc
China Banking Corporation
China Bank Savings Inc
CIMB Bank Philippines Inc
City Savings Bank Inc
CIS Bayad Center Inc
Cantilan Bank Inc
Philippine Bank of Communications
Card SME Bank
CTBC Bank (Philippines) Corporation
Netbank (A Rural Bank) Inc
Development Bank of the Philippines
Dumaguete City Development Bank
DCPay (Coinsph)
Dungganon Bank (A Microfinance Rural Bank) Inc
East West Rural Bank
Entrepreneur Bank Inc (A Rural Bank)
Equicom Savings Bank Inc
East West Banking Corporation
GPay Network PH Inc
Gotyme Bank Corporation
G-Xchange Inc
Infoserve Incorporated (Nationlink)
I-Remit Inc
ISLA Bank (A Thrift Bank) Inc
Seabank Philippines Inc (A Rural Bank)
Legazpi Savings Bank
LuluMoney
Luzon Development Bank
Malayan Savings Bank Inc
Maybank Philippines Incorporated
Metropolitan Bank and Trust Company
Mindanao Consolidated Cooperative Bank
Bangko Mabuhay (A Rural Bank) Inc
Maya Bank Inc
OmniPay Inc
BDO Network Bank
AllBank (A Thrift Bank) Inc
OWN BANK THE RURAL BANK OF CAVITE CITY INC
Bank of Commerce
PayMongo Payments Inc
Maya Philippines Inc / Maya Wallet
Pacific Ace Savings Bank Inc
Philippine Digital Asset Exchange Inc
Philippine Savings Bank
Philippine Trust Company
Philippine Veterans Bank
Philippine National Bank
Philippine Business Bank Inc A Savings Bank
PPS-PEPP Financial Services Corporation
Partner Rural Bank (Cotabato) Inc
Producers Savings Bank Corporation
Queen City Development Bank Inc
Quezon Capital RB Inc
Rang-Ay Bank (A Rural Bank) Inc
Rizal Commercial Banking Corporation
Robinsons Bank Corporation
Camalig Bank Inc (A Rural Bank)
Rural Bank of Guinobatan Inc
Standard Chartered Bank
Security Bank Corporation
ShopeePay Philippines Inc
SpeedyPay Inc
Starpay Corporation
Sterling Bank of Asia Inc (A Savings Bank)
Sun Savings Bank Inc
Tayocash Inc
Tonik Bank
Land Bank of The Philippines
TOKTOKWALLET
Traxion Pay Inc
Union Bank of the Philippines
UCPB Savings Bank Inc
UNOBank Inc
UnionDIgital Bank Inc
USSC Money Services Inc
Wealth Development Bank Corporation
Zybi Tech Inc (JuanCash)
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!