Skip to content

Integration overview ​

Use one signature scheme for PayIns, payouts and balance queries. Creation acceptance is separate from payment completion; obtain the payment result from a status query or webhook.

Before you start ​

  1. Obtain tenant_id, app_key and app_secret for the same merchant application.
  2. Confirm enabled payment methods, per-order limits, fees and request-IP settings.
  3. Set a notify_url that accepts POST JSON. Do not mix test and production credentials.
  4. Follow the signature rules, then send a JSON object.

API directory ​

OperationMethodPath
Create PayIn · H5POST/v1/api/collection/create_order
Create PayIn · H2HPOST/v1/api/collection/create_deeplink_order
Query PayInPOST/v1/api/collection/query_order
Query UPIPOST/v1/api/collection/query_upi
Query UTRPOST/v1/api/collection/query_utr
Submit UTRPOST/v1/api/collection/submitted_utr
Create payoutPOST/v1/api/disbursement/create_order
Query payoutPOST/v1/api/disbursement/query_order
Query balancePOST/v1/api/tenant/query_balance

Main flows ​

  • PayIn: create an H5 or H2H order → use the returned payment link and payable amount → receive a success webhook or query the order.
  • Payout: create an order → obtain the platform order ID → receive the result webhook or query the order. Creation success does not mean the beneficiary has been paid.

Important distinctions ​

  • H5 and H2H have different successful response shapes.
  • Requested, payable and paid amounts have different meanings: see amounts.
  • PayIn 43 means the payment window expired, not an irreversible failure: see statuses.
  • See request errors for handling unsuccessful requests.

OpenAPI v1 · Merchant integration