Skip to main content

Create payout request

POST 
/svc/ts/api/v1/openapi/payout_requests

Create a payout and auto-approve it.

Required fields​

  • payout_request.reference_id
  • payout_request.payee_id
  • payout_request.currency
  • payout_request.amount

reference_id (EndToEndId) rules​

  • Length: 1–35 characters
  • Charset: a-z A-Z 0-9 / - ? : ( ) . , ' + and space
  • Must not start or end with /
  • Must not contain //
  • Must be unique within the same business (duplicate → invalid reference id)

amount rules​

  • amount is the payout / destination amount and does not include fee
  • The merchant is charged amount + fee; the payee receives amount
  • Must be > 0
  • Decimal places must match the currency standard
  • Subject to the minimum and maximum for that transfer_method and currency. If none is set, the amount must be less than 1000000000

payee / currency pairing​

  • payee_id must belong to the current business
  • The payee must have a payout_account whose currency matches the request currency; otherwise the payee is invalid

remark (optional)​

  • Max 120 characters
  • Allowed: Unicode letters/numbers + payment punctuation / - ? : ( ) . , ' + (space allowed; CJK allowed)

schedule_at (optional)​

  • RFC3339 time. Omit it for an immediate payout
  • If set, it must be later than now plus 10 seconds, and within the platform's maximum schedule window
  • Otherwise → 820002 Invalid schedule time

App ID​

The merchant app ID must already be configured. Missing → 820011 App ID is not configured.

Request​

Responses​

Created successfully. transfer_status is the status when this response is returned. A future scheduled payout stays Initiated. An immediate payout is often already Processing Transfer. Suspended means the payout is held and has not been sent.

Response Headers