---
title: "Payout Initiate"
method: POST
path: "/v1/payout/initiate"
tags: ["API Payout"]
---

# Payout Initiate

`POST /v1/payout/initiate`

Create a Payout Link transaction through API

## Headers

- `Signature` string, required
- `Request-Timestamp` string, utc timestamp, required
- `Client-Id` string, required
- `Request-Id` string, required

## Request body

- PayoutInitiateRequest
  - `amount` number, required — Transaction Amount. Total Amount with 2 decimal, format ISO 4217 | min length: 1 | max length: 16.2
  - `sender_name` string, required — Sender Name | min length: 1 | max length: 50
  - `receiver_name` string, required — Beneficiary / Receiver Name | min length: 1 | max length: 50
  - `receiver_phone_number` string, required — Beneficiary / Receiver Phone, Format: 62xxxxxxxxx xxxx | min length: 9 | max length: 14
  - `receiver_email` string, required — Beneficiary / Receiver Email | min length: 1 | max length: 50
  - `reference_id` string, required — Unique Reference number from merchant | min length: 1 | max length: 30
  - `description` string — Decription min length: 1 | max length: 30
  - `currency` string — Currency | min length: 1 | max length: 3

## Response `200`

item created

- PayoutInitiateResponse
  - `status` string, required — status code
  - `message` string, required — status message
  - `timestamp` string, utc timestamp — Doku's response time in yyyy-MM-ddTHH:mm:ssTZD format
  - `data` object, required
    - `reference_id` string, required — Unique Reference number from merchant | min length: 1 | max length: 30
    - `transaction_id` string, required — Unique Reference number from doku | min length: 1 | max length: 30
    - `status` string — Transaction status
    - `amount` number — Transaction Amount. Total Amount with 2 decimal, format ISO 4217 | min length: 1 | max length: 16.2
    - `sender_name` string — Sender Name | min length: 1 | max length: 50
    - `receiver_name` string — Beneficiary / Receiver Name | min length: 1 | max length: 50
    - `receiver_phone_number` string — Beneficiary / Receiver Phone, Format: 62xxxxxxxxx xxxx | min length: 9 | max length: 14
    - `receiver_email` string — Customer Email | min length: 1 | max length: 50
    - `created_time` string, utc timestamp — Doku's created time in yyyy-MM-ddTHH:mm:ssTZD format
    - `modified_time` string, utc timestamp — Doku's modified time in yyyy-MM-ddTHH:mm:ssTZD format

## Other responses

- `400` — Bad Request
- `408` — Time out
- `500` — Internal Error

---

[API](https://skmtc.net/doku/apis/direct-debit-core-system-notify-binding-to-merchant-emoney-o.md) · [All operations](https://skmtc.net/doku/apis/direct-debit-core-system-notify-binding-to-merchant-emoney-o/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/doku/direct-debit-core-system-notify-binding-to-merchant-emoney-o/revisions/7887174f57bc/schema)
