3.1 payoutQueue (Bank/Wallet)
This API is provided by SkyPay and actively pushed by partners. When customers obtain payment transaction approval information, partners must push payment data through this interface for payment transactions.
Input parameters:
parameter | type | length | must | describe |
---|---|---|---|---|
userName | string | 50 | YES | User name provided by SkyPay - Ex:"userName":"AppName@skypay" |
action | string | 50 | YES | Call behavior payoutQueuePayout(Fixed parameter values) - Ex:"action":"payoutQueue" |
authentication | string | 50 | YES | Verification Code Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670" |
sender | string | 100 | YES | Payer Product APP Name (Required: Designed by Partner) Ex:"sender":"APP NAME" |
controlNumber | string | 13~15 | YES | Withdrawal code Prefix code 5+8-10 digits (Prefix code can be obtained from the bound email) - Ex:SKY**12345678 |
name | string | 50 | YES | Name of withdrawal person separated by commas. - Last name+","+First name+","+Middle name+","+Suffix - Ex:"name":"Lardizabal,Mary Annalou B.Lardizabal,Berja, |
phone | string | 11 | YES | phone number 11 digit number starting with 08/09 Ex:"phone":"09270348095" |
amount | string | 10.20 | YES | amount of money Payment amount supports two decimal places ex:"amount":3400.00 |
bankNo | string | 50 | YES | Bank 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 |
accountNo | string | 50 | YES | account 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) |
withdrawChannel | int | 5 | YES | Designated payment channel code refer to Chapter 12 for detailed pipeline instructionsChannel code value |
identificationId | string | 50 | deny | ID number Depending on different authentication methods, hold the ID number - Ex:"identificationId":"442301922000" |
identificationTypeId | string | 3 | deny | Verify 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" |
idType | string | 50 | deny | Optional field for verifying ID type electronic wallet for payment, bank does not have this paramete - ex:"idType":"TIN" |
idcardPicType | string | 50 | deny | Image format optional for electronic wallet payment, bank does not have this parameter - Ex:"idcardPicType":"jpg" |
idcardPicUrl | string | 500 | deny | Photo access network address optional for electronic wallet payment, bank does not have this parameterEx:"idcardPicUrl":"" |
birthday | Date | 10 | deny | Birthday format: yyyy-MM-dd - Ex:"birthday":"1991-10-02" - To write this field, the parameters need to be filled in the correct format |
birthPlace | string | 250 | deny | When making payments through the birthplace bank channel, this parameter is optional and not available in the electronic wallet |
location | string | 500 | deny | Withdrawal address Ex:"location":manila" |
provinceId | int | 5 | deny | Province 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… |
cityId | int | 5 | deny | City 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… |
expiryDate | string | 50 | deny | Certificate 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:
parameter | type | length | describe |
---|---|---|---|
responseTime | DateTime | 50 | Return time yyyy-MM-dd HH:mm:ss.SSSS |
responseCode | int | 4 | Return code Success |
responseDescription | string | 255 | Return content description Success |
Output data:
{
: ,: ,
:
}
Return code:
Status Code | Status Description |
---|---|
1000 | Success |
-1000 | Post context is not valid |
-1001 | Invalid Accountnumber |
-1008 | Control number is already exists |
-1009 | Unpredictable exception occurMerchant is not available |
-1016 | Insufficient balance |
-1020 | Bank city is incorrect |
-1021 | Bank No is incorrect |
-1022 | Invalid Accountnumber |
-1027 | balance limit exceeded |
-1028 | Has exceeded the limit of 5 transactions per day |
-1032 | Your IP xxx is not whitelisted.Please contact Support Team. |
-9999 | Service not available/Connection error |