Skip to content

5.1 PayoutInquiry

5.1offlinepayment

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

parametertypelengthmustdescribe
userNamestring50YESUser name
provided by SkyPay - Ex:"userName":"AppName@skypay"
actionstring50YESCall behavior
payoutInquiry(Fixed parameter values) - Ex:"action":"payoutInquiry"
authenticationstring100YESVerification Code
Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670"
controlNumberstring13~15YESPayment code
prefix code 5+8-10 digits (prefix code can be obtained from the bound email) - Ex:SKY**12345678

Post data

{
: ,
: ,
: ,
:
}

Output parameters

parametertypelengthmustdescribe
responseTimeDateTime26YESresponsiveness
yyyy-MM-dd HH:mm:ss.SSSS
responseCodeint4YESResponse code
4 system default return code, a number of length 4,
standard reference return code definition
responseDescriptionstring255YESResponse Description Content
Response Information
controlNumberstring13~15YESWithdrawal code
Prefix code 5+8-10 digits (Prefix code can be obtained from the bound email) - Ex:SKY**12345678
senderstring255YESRemitter
Product APP Name (Required: Designed by Partner)
Ex:"sender":"APP NAME"
senderAddressstring255YESRemittance Address
namestring50YESName of withdrawal person
separated by commas
Last name+","+
First name+","+Middle name+","+Suffix
Ex:"name":
"Lardizabal,Mary Annalou B.Lardizabal,Berja,
birthdayDate10YESBirthday format:
yyyy-MM-dd - Ex:"birthday":"1991-10-02" - To write this field, the parameters need to be filled in the correct format
identificationIdstring50YESID number
Depending on different authentication methods,
hold the ID number - :"identificationId":"442301922000"
idTypestring50YESVerify ID Type
ID Type (SSS, UMID, Driver's License, TIN...)
"idType": "TIN"
phonestring11YESphone number
11 digit number starting with 09/08 (required)
Ex:"phone":"09270348095"
amountstring10.20YESamount of money
Payment amount supports two decimal places (required) - ex:"amount":3400.00
idcardPicTypestring50YESPhoto file format
file format attachment file name (required) - Ex:"idcardPicType":"jpg"
idcardPicUrlstring500YESPhoto access network address
Ex:"idcardPicUrl":"https://12334"
contractNumberstring15denyPayment code
prefix code 5+8-10 digits
(prefix code can be obtained from the bound email) - Ex:SKY**12345678
locationstring100YESAddress
Add Address Withdrawal Address

Output data:

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

Return code:

Status CodeStatus Description
1000Success
-1001Verification error
-1009Unpredictable exception occurs
-1012Control number invalid or expired
-1014Prefix of Control number is incorrect.
-1016Insufficient balance
-1022Invalid Accountnumber
-1026Transactions has been paid