Skip to content

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:

parametertypelengthmustdescribe
userNamestring50YESUser Name
Provided by SkyPay - Ex:"userName":"AppName@skypay"
actionstring50YESCall behavior
payoutQueuePayout(Fixed parameter values) - Ex:"action":"payoutQueuePayout"
authenticationstring50YESVerification Code
Verification Key - Ex:"authentication":"E1234567-123C-1234-123F-A12345670"
controlNumberstring13~15YESWithdrawal code
Prefix code 5+8-10 digits (Prefix code can be obtained from the bound email) - Ex:SKY**12345678
payTypeint1YESPayment 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
dealTimeDateTimeYESTrading 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
failDescriptionstringOptionYESFail description
referenceNumberstringOptiondenyrelating codes
Returned when using ML payment callback with payType 1 and 5 statusreferenceNumber(upload and Amended Success)

Post data

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

Output parameters:

parametertypelengthdescribe
responseTimeDateTime50Return time
yyyy-MM-dd HH:mm:ss.SSSS
responseCodeint4Return code
1000
responseDescriptionstring255Return content description
Success

Output data:

{
: ,
: ,
:
}

Return code

Status CodeStatus Description
1000Success