5.1 PayoutInquiry
PayoutInquiry withdrawal verification information
(1) When the withdrawal person requests an offline store to make a withdrawal request, payoutInquire will be called in real-time to verify payment information
(2) After being called, payoutInquire will return the verification results to the partners, and offline stores will receive detailed payment information and user information
(3) The withdrawal person needs to provide the withdrawal code and necessary identity verification information, such as to the cashier
(4) After checking the withdrawal code and identity verification information, the cashier will receive a manual verification message and send it to the Skypay server
(1) After the payoutInquiry is successful, the payoutPayout will be called by the offline store, and the message that the transaction has been successfully paid will be returned
(2) This transaction will occur when the cashier confirms the payment and the payment action has been completed
(3) The actual triggering point of this function is when the cashier presses the payoutPay function button (manual operation)
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 payoutInquiry(Fixed parameter values) - Ex:"action":"payoutInquiry" |
authentication | string | 100 | YES | Verification Code Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670" |
controlNumber | string | 13~15 | YES | Payment code prefix code 5+8-10 digits (prefix code can be obtained from the bound email) - Ex:SKY**12345678 |
Post data
{
: ,
: ,
: ,
:
}
Output parameters
parameter | type | length | must | describe |
---|---|---|---|---|
responseTime | DateTime | 26 | YES | responsiveness yyyy-MM-dd HH:mm:ss.SSSS |
responseCode | int | 4 | YES | Response code 4 system default return code, a number of length 4, standard reference return code definition |
responseDescription | string | 255 | YES | Response Description Content Response Information |
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 |
sender | string | 255 | YES | Remitter Product APP Name (Required: Designed by Partner) Ex:"sender":"APP NAME" |
senderAddress | string | 255 | YES | Remittance Address |
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, |
birthday | Date | 10 | YES | Birthday format: yyyy-MM-dd - Ex:"birthday":"1991-10-02" - To write this field, the parameters need to be filled in the correct format |
identificationId | string | 50 | YES | ID number Depending on different authentication methods, hold the ID number - :"identificationId":"442301922000" |
idType | string | 50 | YES | Verify ID Type ID Type (SSS, UMID, Driver's License, TIN...) "idType": "TIN" |
phone | string | 11 | YES | phone number 11 digit number starting with 09/08 (required) Ex:"phone":"09270348095" |
amount | string | 10.20 | YES | amount of money Payment amount supports two decimal places (required) - ex:"amount":3400.00 |
idcardPicType | string | 50 | YES | Photo file format file format attachment file name (required) - Ex:"idcardPicType":"jpg" |
idcardPicUrl | string | 500 | YES | Photo access network address Ex:"idcardPicUrl":"https://12334" |
contractNumber | string | 15 | deny | Payment code prefix code 5+8-10 digits (prefix code can be obtained from the bound email) - Ex:SKY**12345678 |
location | string | 100 | YES | Address Add Address Withdrawal Address |
Output data:
{
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
: ,
:
}
Return code:
Status Code | Status Description |
---|---|
1000 | Success |
-1001 | Verification error |
-1009 | Unpredictable exception occurs |
-1012 | Control number invalid or expired |
-1014 | Prefix of Control number is incorrect. |
-1016 | Insufficient balance |
-1022 | Invalid Accountnumber |
-1026 | Transactions has been paid |