5.6 Callback

1. Payment Callback

1.1. Overview

Uses callBackUrl to send the payment result to the merchant when the payment processing reaches a final state of success or failure. Merchants promote merchant-side transactions based on the payment result.

Note: If the merchant response is { "transResult": "SUCCESS" } , the callback notification will stop. If not,the callback notification will be performed in 10 sec, 5 min, 30 min, After 3 retries, the callback notification will be stopped.

1.2. Request Info

  • Method: post

  • Path: The callBackUrl parameter when the Payment

1.2.1 Request Header

Key
Value

Content-Type

application/json

1.2.2 Request Data

Name
Description
Type

success

Success flag: true/false

boolean

message

Response message

string

code

string

timestamp

Response timestamp

long

data

Result

object

> appId

Unique identifier assigned to a third-party application platform

string

> payStatus

SUCCESS/EXPIRED/PROCESSING/FAIL

string

> payMethod

Payment method: 1.Wechat; 11.Alipay+;

int

> orderType

STATIC_CODE: 静态收款码

DYNAMIC_CODE:动态收款码

MICRO_CODE:扫码收款(反扫)

MINI_APP:微信小程序

APP:线上APP

ONLINE:线上支付

AUTO_DEBIT:线上自动扣款

string

> orderAmt

Payment amount

json

>> value

amount

string

>> currency

CNY: 人民币 USD: 美元 LAK: 老挝币

string

> mchOrderNo

Order number in third party mechant.

string

> newpayOrderNo

NewPay order number

string

> subject

Commodity title

string

> settlementStatus

Settlement status: 0: No settlement; 1: In settlement;

2: Have already settled

int

> paytime

payment timestamp

long

> attach

Third party order supplementary fields

string

> sign

Data signature

string

2. Refund Callback

2.1. Overview

Uses callback url to send the refund result to the merchant when the refund processing reaches a final state of success or failure. Merchants promote merchant-side transactions based on the refund result.

Note: If the merchant response is { "transResult": "SUCCESS" } , the callback notification will stop. If not,the callback notification will be performed in 10 sec, 5 min, 30 min, After 3 retries, the callback notification will be stopped.

2.2. Request Info

  • Method: post

  • Path: The callBackUrl parameter when the Refund

2.2.1 Request Header

Key
Value

Content-Type

application/json

2.2.2 Request Data

Name
Description
Type

success

Success flag: true/false

boolean

message

Response message

string

code

string

timestamp

Response timestamp

long

data

Result

object

> newpayRefundNo

Refund order number in NewPay

string

> mchRefundNo

Refund order number in third party merchant

string

> newpayOrderNo

payment order number in NewPay

string

> refundAmt

Refund amount and currency

json

>> value

amount

string

>> currency

CNY: 人民币 USD: 美元 LAK: 老挝币

string

> orderAmt

original order amount and currency

json

>> value

amount

string

>> currency

CNY: 人民币 USD: 美元 LAK: 老挝币

string

> refundStatus

refund status: SUCCESS/FAIL/PROCESSING

int

> sign

Data signature

string

Last updated