Payout / Remittance

Create Payout Order

Endpoint

https://{$api_host}/api/remit
Request Parameters
FieldKeyRequiredSignedTypeExampleDescription
Merchant IDmeridYesYesstring10086Merchant ID assigned by the platform.
Merchant Order No.tnoYesYesstringtno1234578910jqkMerchant order number (max 32 chars, alphanumeric).
AmountamtYesYesstring126.35Total amount (2 decimals).
CurrencycurYesYesstringPHPCurrency code. See currency list. Uppercase required
Notify URLnotify_urlYesYesstringhttp://www.baidu.comAsync callback URL (retry at 5s/10s/30s/180s/600s on success).
Payout Account InfoacctYesYesjson{
"type": "bankcard",
"code": "PH_GCASH",
"name": "GCash",
"number": "09959350888",
"user": "BAOJUNTANG"
}		Different payout methods have different structures. See Account (Acct).
ExtraextraNoYesstringExtra parameters required by some channels.
SignaturesignYesNostringc380bec2bfd727a4.....Signature. See Signature.

!! Important:

  • Non-required fields must be removed from the signature string when empty.
  • URL fields must be URL-encoded before signing.
  • Amount keeps 2 decimals. Note that .00 may be omitted; pay special attention during signing.
  • If acct is provided, it must be flattened during signing. See acct Flattening.
  • acct fields are shown in the “acct examples” in Account (Acct). If you are unsure, you can ignore it for now.

!!! Pay special attention to how payout account info (acct) is handled during signing !!!

Request Example

{
  "merid": "10086",
  "tno": "sn1234578910jqk",
  "amt": "500.26",
  "cur": "CNY",
  "notify_url": "https://www.baidu.com",
  "extra": "",
  "acct": {
    "type": "bankcard",
    "code": "PH_GCASH",
    "name": "GCash",
    "number": "09959350888",
    "user": "BAOJUNTANG"
  },
  "sign": "9a9cba23f9075ff01b2ed2050f52f42d"
}

Success Response Example

If HTTP status is not 200, or you receive a payload like {"code": 506800,"message": "..."} (i.e. contains code), the order creation failed. Upstream issues may occasionally cause failures; handle this accordingly.

{
  "data": {
    "sn": "sn123456",
    "tno": "tno12345678910jqk",
    "amt": "100.00",
    "fee": "2.00",
    "cur": "CNY",
    "ctm": "2008-08-08 08:08:08",
    "sts": "submit"
  }
}

tips:

  1. If the HTTP status is 200, payout submission is usually successful.
  2. During testing, to simulate a payout failure, submit amount 123.45.
  3. During testing, the payout will not actually be credited. A successful submission indicates the flow is correct.
  4. After testing, contact support to switch to the production payout channel.

See Account (Acct).

Payout Query

Endpoint
https://{$api_host}/api/remit/query
Request Parameters
FieldKeyRequiredTypeExampleDescription
Merchant IDmeridYesstring10086Merchant ID assigned by the platform (not the login account).
Platform Order No.snYesstringsn1234578910jqkPlatform order number (not your business order number).
Merchant Order No.tnoYesstringtno1234578910jqkMerchant order number.
SignaturesignYesstringc380bec2bfd727a4.....Signature. See the signature algorithm.

!! Important:

  • Platform order number and merchant order number must be provided. At least one must be provided.
  • Merchant order number can only query the last 3 days of data.
Request Example
{
  "merid": "10086",
  "sn": "sn1234578910jqk",
  "sign": "9a9cba2119075ff01b2ed2050f52f42d"
}
Response Parameters
FieldKeyTypeExampleDescription
Merchant IDmeridstring10086Merchant ID assigned by the platform (not the login account).
Platform Order No.snstringsn12345678Platform order number.
Merchant Order No.tnostringtno1234578910jqkMerchant order number.
Create Timectmstring2008-08-08 08:08:08Order creation time.
Amountamtstring126.35Order amount.
CurrencycurstringCNYISO4217 currency code.
Settlement Amountsett_amtfloat5.20Settlement amount.
Statusstsstringsuccesssuccess means processed successfully. See Payout Order Status.
Signaturesignstring1d48ac07237fa..Used to verify data integrity.

Success Response Example

{
  "data": {
    "sn": "sn123456",
    "tno": "tno12345678910jqk",
    "amt": "100.00",
    "fee": "2.00",
    "cur": "CNY",
    "ctm": "2008-08-08 08:08:08",
    "sts": "submit"
  }
}

Payout Order Status

StatusDescription
submitSubmitted
processProcessing
successSuccess
failFailed

Payout Bank Codes

Philippines Banks (PH-PHP)

CodeDescription
PH_ALBAllBank (A Thrift Bank), Inc.
PH_APYAlipay / Lazada Wallet
PH_AUBAsia United Bank Corporation
PH_BCHBank of China
PH_BDOBDO Unibank
PH_BGBBanKo, A Subsidiary of BPI
PH_BMBBangko Mabuhay
PH_BOCBank of Commerce
PH_BPIBPI / BPI Family Savings Bank
PH_BRBBinangonan Rural Bank (BRBDigital)
PH_CBCChina Banking Corporation
PH_CBSChina Bank Savings, Inc.
PH_CCBCTBC Bank (Philippines) Corporation
PH_CISBayad
PH_CLBCebuana Lhuillier Bank / Cebuana Xpress
PH_CMGCamalig Bank
PH_CPICIMB Philippines, Inc.
PH_CRDCARD Bank Inc.
PH_DBIDungganon Bank (A Microfinance Rural Bank), Inc.
PH_DBPDevelopment Bank of the Philippines
PH_DCBDumaguete City Development Bank
PH_DCPCoins.ph (DCPay)
PH_EQBEquicom Savings Bank, Inc.
PH_ERBEntrepreneur Rural Bank, Inc./ENTRP
PH_EWBEast West Banking Corporation
PH_EWRKomo / EastWest Rural Bank
PH_GBYGrabPay
PH_GCASHGCash
PH_GOTGoTyme Bank
PH_IEMInfoserve / Nationlink
PH_INGING Bank N.V.
PH_IRII-Remit / iCASH
PH_ISLISLA Bank (A Thrift Bank), Inc.
PH_LBPLANDBANK / OFBank
PH_LDBLuzon Development Bank
PH_LSBLegazpi Savings Bank
PH_MCBMindanao Consolidated CoopBank
PH_METMetropolitan Bank and Trust Co.
PH_MPIMaybank Philippines, Inc.
PH_MSBMalayan Bank Savings and Mortgage Bank, Inc.
PH_MYAMaya Bank, Inc.
PH_NBKNetbank
PH_ONBBDO Network Bank
PH_OPIOmniPay, Inc.
PH_PARPartner Rural Bank (Cotabato), Inc.
PH_PASPacific Ace Savings Bank
PH_PBBPhilippine Business Bank, Inc., A Savings Bank
PH_PBCPhilippine Bank of Communications
PH_PNBPhilippine National Bank (PNB)
PH_PPIPayMaya Philippines, Inc.
PH_PPSPalawanPay
PH_PRBProducers Bank
PH_PSBPhilippine Savings Bank
PH_PTCPhilippine Trust Company
PH_PVBPhilippine Veterans Bank
PH_QCBQueenbank
PH_QRBQuezon Capital Rural Bank
PH_RBGAsenso
PH_RBNRobinsons Bank Corporation
PH_RCIRCBC/DiskarTech
PH_SBASterling Bank of Asia, Inc (A Savings Bank)
PH_SCBStandard Chartered Bank
PH_SEASeabank
PH_SECSecurity Bank Corporation
PH_SMECARD SME Bank
PH_SPPShopeePay
PH_SPYStarpay
PH_SSBSun Savings Bank, Inc.
PH_TCITayoCash
PH_TDBTonik Bank
PH_TPITraxionPay/DigiCOOP/COOPNET
PH_UBPUnion Bank of the Philippines
PH_UCPUnited Coconut Planters Bank (UCPB)
PH_UDBUnionDigital Bank
PH_UMSUSSC Money Services
PH_UNOUNObank
PH_USBUCPB Savings Bank
PH_WDBWealth Development Bank
PH_ZTIJuanCash (Zybi Tech Inc.)

Pakistan Banks (PK-PKR)

CodeDescription
PK_EASYPAISAEasypaisa
PK_UPAISAUpaisa
PK_JAZZCASHJazzCash