Skip to content

6.3 collectionCollect

This service is provided by the partner and will be triggered by the offline store cashier to confirm reimbursement.

Input parameters

parametertypelengthmustdescribe
userNamestring50YESUser name
provided by SkyPay - Ex:"userName":"AppName@skypay"
actionstring50YESCall behavior
collectionCollect(Fixed parameter values) - Ex:"action":"collectionCollect"
authenticationstring255YESVerification Code
Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670"
contractNumberstring13~15YESPayment code
prefix code 5+8-10 digits (prefix code can be obtained from the bound email) - Ex:SKY**12345678
amountdecimal10.20YESamount of money
Must be the actual amount received by the user
with a maximum of two decimal places - ex:"amount":3400.00
phonestring50YESphone number
11 digit number starting with 09/08 Ex:"phone":"09270348095"
receiptNumberstring50YESReceipt No
collectedTimeDateTimeYES(yyyy-MM-dd HH:mm:ss)
Collection time, date format yyyy-MM-dd HH:mm:ss
payChannelint5YESPayment Pipeline
For detailed instructions, please refer to Chapter 12Collection channel code

Post data

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

Output parameters

parametertypelengthdescribe
responseTimeDateTime50Return time
yyyy-MM-dd HH:mm:ss.SSSS
responseCodeint4Return 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 clearly describe the content of the return
responseDescriptionstring255Feedback Content Description
Response Information

Output data:

{

: ,
: ,
:

}

Return code:

Status CodeStatus Description
1000Success
-1001Verification failed
-1009An Unpredictable exception occurs
-1015The transaction has been collected
-1026Transactions has been paid