Skip to content

Sync Allocation Order

Updated: 9/11/26, 8:21:59 PM

Description

When an allocation order is in processing status, the merchant can actively sync the allocation status from the payment channel. Useful when the channel advances asynchronously, callbacks are delayed, or manual confirmation is needed.

Request

POST /unipay/sync/order/alloc

  • Auth: RSA signature (@PaymentVerify)
  • Response: DaxResult<AllocSyncResult>

Parameters

Common params same as Pay - Common Parameters. Business parameters:

ParameterTypeRequiredMaxDescription
allocNostringNo*100Platform allocation number
bizAllocNostringNo*100Merchant allocation number

*At least one required. Priority: allocNo > bizAllocNo

Example

json
{
  "mchNo": "M200000001",
  "appId": "APP001",
  "reqId": "REQ20241201031",
  "reqTime": "2024-12-01 12:31:00",
  "sign": "Base64Signature",
  "allocNo": "A2024120112345700001"
}

Response

DaxResult<AllocSyncResult>, data fields:

FieldTypeDescription
orderStatusstringAllocation status after sync (AllocOrderStatusEnum)
adjustbooleanWhether status was adjusted (changed)

Example

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "orderStatus": "success",
    "adjust": true
  },
  "sign": "Base64Signature",
  "resTime": "2024-12-01 12:31:00",
  "reqId": "REQ20241201031"
}

Usage Tips

  • Sync is idempotent — safe to call repeatedly; no duplicate allocation or notifications.
  • When sync triggers a status change, the platform re-sends the notification per Async Callback (events alloc.success / alloc.fail).
  • Once a terminal state (success / partial / fail) is reached, sync no longer adjusts the status — check the adjust flag.
  • For full allocation details (including per-receiver results), call Query Allocation Order.

Official Website · Released under the GNU LGPL v3.0