Skip to content

3.1 payoutQueue (Bank/Wallet)

This API is provided by SkyPay and actively pushed by partners. 4 When customers obtain payment transaction approval information, partners must push payment data through this interface for payment transactions.

Input parameters:

parametertypelengthmustdescribe
userNamestring50YESUser name
provided by SkyPay - Ex:"userName":"AppName@skypay"
actionstring50YESCall behavior
payoutQueuePayout(Fixed parameter values) - Ex:"action":"payoutQueue"
authenticationstring50YESVerification Code
Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670"
senderstring100YESPayer
Product APP Name (Required: Designed by Partner)
Ex:"sender":"APP NAME"
controlNumberstring13~15YESWithdrawal code
Prefix code 5+8-10 digits (Prefix code can be obtained from the bound email) - Ex:SKY**12345678
namestring50YESName of withdrawal person
separated by commas. - Last name+","+First name+","+Middle name+","+Suffix - Ex:"name":"Lardizabal,Mary Annalou B.Lardizabal,Berja,
phonestring11YESphone number
11 digit number starting with 08/09
Ex:"phone":"09270348095"
amountstring10.20YESamount of money
Payment amount supports two decimal places
ex:"amount":3400.00
bankNostring50YESBank code
When making payments through bank channels, this parameter is mandatory. This parameter is not available in electronic wallets. Please refer to Chapter 10 Interface 10.6 Get Bank Code, which consists of 3 characters
accountNostring50YESaccount number:
The account is a mobile phone number with the first 11 digits of 09 for the withdrawal person
Bank:The designated bank account of the withdrawer (specify a valid bank account)
withdrawChannelint5YESDesignated payment channel code
refer to Chapter 12 for detailed pipeline instructionsChannel code value
identificationIdstring50denyID number
Depending on different authentication methods, hold the ID number - Ex:"identificationId":"442301922000"
identificationTypeIdstring3denyVerify ID Document Category
Reference8.3 Get Identification Type - Optional when making payments through bank channels, this parameter is not available in electronic wallets - Ex:":identificationTypeId":"2"
idTypestring50denyOptional field for verifying ID type
electronic wallet for payment, bank does not have this paramete - ex:"idType":"TIN"
idcardPicTypestring50denyImage format
optional for electronic wallet payment, bank does not have this parameter - Ex:"idcardPicType":"jpg"
idcardPicUrlstring500denyPhoto access network address
optional for electronic wallet payment, bank does not have this parameterEx:"idcardPicUrl":""
birthdayDate10denyBirthday format:
yyyy-MM-dd - Ex:"birthday":"1991-10-02" - To write this field, the parameters need to be filled in the correct format
birthPlacestring250denyWhen making payments through the birthplace bank channel, this parameter is optional and not available in the electronic wallet
locationstring500denyWithdrawal address
Ex:"location":manila"
provinceIdint5denyProvince ID
Please refer to Chapter 10 Interface10.5 Get Province - Optional when making payments through bank channels, this parameter is not available in electronic wallets - Ex:ProvinceId Province1 Abra - 2 Agusan del Norte…
cityIdint5denyCity ID
Please refer to Chapter 10 Interface10.4 Get Town City - When making payments through bank channels, this parameter is optional and not available in the electronic wallet - Ex: Province ID City ID City Name - 47 996 Manila…
expiryDatestring50denyCertificate expiration date
optional when making payments through bank channels, this parameter is not available in electronic wallets

Post data

When paying as an electronic wallet, call the API to send out data format content:

{
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
}

When making a payment to a bank, call the API to send out the data format content:

{
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
}

Output parameters:

parametertypelengthdescribe
responseTimeDateTime50Return time
yyyy-MM-dd HH:mm:ss.SSSS
responseCodeint4Return code
Success
responseDescriptionstring255Return content description
Success

Output data:

{

: ,
: ,
:

}

Return code:

Status CodeStatus Description
1000Success
-1000Post context is not valid
-1001Invalid Accountnumber
-1008Control number is already exists
-1009Unpredictable exception occurMerchant is not available
-1016Insufficient balance
-1020Bank city is incorrect
-1021Bank No is incorrect
-1022Invalid Accountnumber
-1027balance limit exceeded
-1028Has exceeded the limit of 5 transactions per day
-1032Your IP xxx is not whitelisted.Please contact Support Team.
-9999Service not available/Connection error