6.1 collectionInquiry
The API is provided by partners and will be triggered by customers when applying for repayment.
(1) collectionInquiry is used to verify whether this payment information exists
(2) collectionInquiry occurs in real time when the withdrawal person requests payment at an offline store
(3) The withdrawal person needs to provide a payment code and necessary identity verification information, and conduct payment verification through the cashier or convenience store's automatic payment machine
(4) The trigger point for the collectionInquiry function is that when the offline store cashier or cash withdrawal person selects the "send collectionInquiry" function request through the convenience store kiosk, they will send it to SkyPay
(1) collectionCollect is used by offline stores to reply to confirmed completed payment transactions
(2) After the cashier completes the confirmation, a real-time collectionCollect message will be sent back
(3) Function trigger point, at the cashier, select collectionCollect and reply with a successful payment message to the SkyPay server
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 collectionInquiry(Fixed parameter values) - Ex:"action":"collectionInquiry" |
authentication | string | 255 | YES | Verification Code Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670" |
contractNumber | string | 13~15 | YES | Payment code prefix code 5+8-10 digits (prefix code can be obtained from the bound email) - Ex:SKY**12345678 |
amount | decimal | 10.20 | YES | amount of money Must be the actual amount received by the user with a maximum of two decimal places - ex:"amount":3400.00 |
phone | string | 11 | YES | phone number 11 digit number starting with 09/08 Ex:"phone":"09270348095" |
Post data
{
: ,
: ,
: ,
: ,
: ,
:
}
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 clearly describe the content of the return |
responseDescription | string | 255 | YES | Return content description response information |
amount | decimal | 10.20 | YES | Receipt amount Payment amount can only be two decimal places (required). Regulatory requirements require repayment information to be kept in a file |
payerName | string | 255 | YES | Reparer's name separated by commas。Last name+","+First name+","+Middle name+","+Suffix Regulatory requirements require repayment information to be retained in a file |
payerAddress | string | 255 | YES | The regulatory requirements for the borrower's address require the retention of repayment information in a file |
payerPhone | string | 11 | YES | Repayment person's phone number 11 digits starting with 09/08. Regulatory requirements require repayment information to be retained in a file |
Output data
{
: ,
: ,
: ,
: ,
: ,
: ,
:
}
Return code:
Status Code | Status Description |
---|---|
1000 | Success |
-1001 | Verification error |
-1009 | Unpredictable exception occurs |
-1015 | The contract number is invalid. |
-1026 | Transactions has been paid |