---
title: "Create Payout"
method: POST
path: "/v2/payment/payout/create"
tags: ["Payment Payouts"]
---

# Create Payout

`POST /v2/payment/payout/create`

Create a new payout order

## Headers

- `x-on-behalf-of` string
- `x-idempotency-key` string, uuid

## Request body

- PayoutCreateRequest
  - `payout_currency` string, required — Three-letter currency code
  - `payout_amount` string, required — The amount to be withdrawn through this payout.
  - `internal_note` string — Payout remark information
  - `statement_descriptor` string, required — Payout reference information displayed to the recipient's bank
  - `payout_account_id` string — The UQPAY account ID to receive the payout funds via internal transfer. Both long and short account IDs are accepted. - If omitted, the payout is sent to the pre-configured external bank account (default behavior). - If provided, the payout is processed as a UQPAY internal transfer to the specified account. Pass the account ID of the caller.

## Response `200`

Payout created successfully

- PayoutResponse
  - `payout_id` string, required — Payout UUID
  - `payout_currency` string, required — Three-letter currency code
  - `payout_amount` string, required — The amount to be withdrawn through this payout.
  - `internal_note` string — Payout remark information
  - `statement_descriptor` string, required — Payout reference information displayed to the recipient's bank
  - `payout_status` 'INITIATED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'FAILED_REFUNDED', required — Payout status enumeration. - `INITIATED`: Payout has been initiated. - `PROCESSING`: Payout is being processed (bank is processing). - `COMPLETED`: Payout completed successfully. - `FAILED`: Payout failed. - `FAILED_REFUNDED`: Payout failed and funds have been refunded.
  - `create_time` string, date/time, required
  - `completed_time` string, date/time

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)