3.2 payoutQueuePayout (CallBack)
This API is provided by partners and requested by payment vendors at the following times
(1) When the transaction is uploaded to the payment provider
(2) When the withdrawal person withdraws money from an offline store
(3) When the customer cancels the transaction
(4) When the transaction fails
(5) When the transaction information is successfully modified
(6) When transaction information modification fails
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 payoutQueuePayout(Fixed parameter values) - Ex:"action":"payoutQueuePayout" |
authentication | string | 50 | YES | Verification Code Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670" |
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 |
payType | int | 1 | YES | Payment status: 1: upload: uploaded, representing payment information of transaction data, notified to payment unit 2: layout: paid, payment unit completed payment, return notification of payment success message 3: cancel: payment cancelled, not paid, partner notified to cancel transaction, return notification of successful cancellation transaction 4: failure: payment failed=>payment error, Return payment failure message 5: Amended Success: Data modification successful 6: Amended Failure: Data modification failed |
dealTime | DateTime | YES | Trading Hours : 1: Uploaded Time 2: paid Time: upon completion of payment 3: canceled Time: cancellation of transaction 4: fail time: payment failure time 5: Amed Success Time: modification of data success time 6: Amed Failure Time: modification of data failure time | |
failDescription | string | Option | YES | Fail description |
referenceNumber | string | Option | deny | relating codes Returned when using ML payment callback with payType 1 and 5 statusreferenceNumber(upload and Amended Success) |
Post data
{
: ,
: ,
: ,
: ,
: ,
: ,
: ,
}
Output parameters:
parameter | type | length | describe |
---|---|---|---|
responseTime | DateTime | 50 | Return time yyyy-MM-dd HH:mm:ss.SSSS |
responseCode | int | 4 | Return code 1000 |
responseDescription | string | 255 | Return content description Success |
Output data:
{
: ,
: ,
:
}
Return code
Status Code | Status Description |
---|---|
1000 | Success |