7.1 payoutQueryStatus

The payment status query service API is provided by Skypay and can query transaction status, with a maximum quantity of 50 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 payoutQueryStatus(Fixed parameter values) - Ex:"action":"payoutQueryStatus"
authentication	string	255	YES	Verification Code Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670"
controlNumbers	String[]		YES	Payment code array name Array(parameter tag name is controlNumber)
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

{
    "userName" : "AppName@skypay",
    "action" : "payoutQueryStatus",
    "authentication" : "30AC21B2-9EAA-4503-B0F0-7BE5C277ED75",
    "controlNumbers" :[
    {
      "controlNumber" : "SK0XXXXXXXXXX"
     },
     {
      "controlNumber" :  "SK0XXXXXXXXXX"
     }
    ]
}

Output parameters

parameter	type	length	must	describe
responseTime	DateTime	50	YES	Return time yyyy-MM-dd HH:mm:ss.SSSS
responseCode	int	4	YES	Return Code System default return code, a number of 4 in length, standard reference return code definition. When the system default return code is insufficient, users can customize the code. Please start with the number 2, a number of 4 in length, and specify the content of the return
responseDescription	string	255	YES	Feedback Content Description Response Information (Required)
controlNumbers	String[]		YES	Name of withdrawal code array Array
controlNumber	string	13~15	YES	Withdrawal code name of the payee - separated by commas。Last name+","+First name+","+Middle name+","+Suffix(Required) Regulatory requirements require retention of repayment information in archives
transactionDate	DateTime			Transaction Date yyyy-MM-dd HH:mm:ss.fff
status	int		YES	Status code : 0 Pending:Waiting 1 Completed:Completed 2 Uploaded:Complete upload 3 Cancelled:Canceled 4 Failed:fail 10 Inquiry Success:query was successful 11 Inquiry Failure:Query failed
statusDesc	String	50	YES	State Description: Pending:Waiting Completed:Complet Uploaded:Complete upload Cancelled:Canceled Failed:fail Inquiry Success:query was successful Inquiry Failure:Query failed
payTime	DateTime			Withdrawal time (yyyy-MM-dd HH:mm:ss)
cancelTime	DateTime			Cancel time (yyyy-MM-dd HH:mm:ss)
withdrawChannel	int			Payment Pipeline For detailed information, please refer to section12Channel code value
referenceNo	String	50		Receipt No GCash:reference number - Real time return receipt number
traceNo	String	50		MLExclusive payment code MLhuillier(RT) - referenceNumber MLExclusive payment code

Output data：

{
  : ,
     : ,
     : ,
     : [
       { 
          : ,
           : ,
           : ,
           : ,
           : ,
           : ,
           : ,
           : 
       },
       { 
          : ,
           : ,
           : ,
           : ,
           : ,
           : ,
           : ,
           : ,
       }
    ]
}