---
title: "Create Payout"
method: POST
path: "/api/payout/transaction"
tags: ["Payout APIs"]
---

# Create Payout

`POST /api/payout/transaction`

## Headers

- `Content-Type` string
- `Cookie` string
- `X-Portone-Client-Key` string
- `Authorization` string

## Request body

- object
  - `key` string, required — The unique PortOne key for merchant
  - `channel_key` string, required — The Payment Channel Key listed in PortOne docs
  - `signature_hash` string, required — The SignatureHash generated for the specific payload data
  - `environment` 'live' | 'sandbox', required — The environment of the transaction is either live OR sandbox
  - `split_payouts` boolean — Indicates if split payouts are enabled
  - `txn_details` object, required
    - `virtual_acc_no` string, required — Virtual account number
    - `amount` number, float, required — Transaction amount
    - `currency` string, required — Currency of the transaction
    - `txn_ref` string, required — Merchant Reference for the transaction
    - `remarks` string — Remarks for the transaction
    - `user_message` string — Message to be sent to the user
    - `send_email` boolean — Whether to send email notifications
    - `send_sms` boolean — Whether to send SMS notifications
    - `recipient_emails` string[] — List of recipient email addresses for notifications
    - `bank_details` object, required
      - `account_no` string, required — Account number
      - `account_type` 'BANK' | 'CARD', required — The account type of the Benificiary
      - `account_name` string, required — Account holder's name
      - `bank_name` string — Name of the bank
      - `bank_no` string — Bank number
      - `email` string, email — Account holder's email address
      - `phone` string — Account holder's phone number
      - `address` string — Account holder's address
      - `country` string — Country of the account holder

## Response `200`

Successful response

- object
  - `is_success` boolean — The boolean value indicating whether Payout transaction was created successfully.

## Other responses

- `400` — Failure response
- `401` — Failure response

---

[API](https://skmtc.net/portone/apis/payment-apis.md) · [All operations](https://skmtc.net/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portone/payment-apis/versions/f3ccea652555/schema)