---
title: "Create payout intent"
method: POST
path: "/api/v1.4/payout/intent/"
tags: ["v1.1"]
---

# Create payout intent

`POST /api/v1.4/payout/intent/`

Create a payout intent

## Request body

- BasePayout
  - `id` string, required
  - `amount` string, decimal — Payout amount
  - `amount_currency` string, required — The currency of the amount represented by a string of alphabetic code from ISO 4217 Currency code
  - `payout_method` string — Payout method id
  - `webhook_url` string, uri, required — A URL that the Moneyhash server will send a POST request to with payout data after.
  - `back_url` string, uri — A URL that allows your customers to go back to your website at anytime during the payout process.
  - `custom_fields` unknown
  - `custom_form_definition` CustomFormDefinition
    - `form_title` string, required — A title to be shown to the user on the form
    - `fields` CustomFormFields[], required — Field definitions that contain name, validation...etc
      - `name` string, required — field name
      - `value` string
      - `label` string, required — Field label
      - `type` 'CharField' | 'BooleanField' | 'IntegerField' | 'ChoiceField', required — Field type * `CharField` - CharField * `BooleanField` - BooleanField * `IntegerField` - IntegerField * `ChoiceField` - ChoiceField
      - `required` boolean, required — Whether the field is required or not
      - `choices` unknown
      - `help_text` string — Field help text
      - `max_length` integer — Maximum length of the field
      - `min_length` integer — Minimum length of the field
      - `min_value` integer
      - `max_value` integer
  - `hide_payout_method_selector` boolean — Hide the payout method selector in the payout form.
  - `hide_amount_sidebar` boolean — Hide the amount sidebar in the payout form.
  - `hide_payout_header` boolean
  - `hide_header` boolean — if set to True, hides MoneyHash branding header from the returned embed form.
  - `form_only` boolean — Only show the payment form to the user without other payout choices. If this is set to true, payout_method is required to create an intent.
  - `use_wallet` boolean — Use customer wallet to process the payout. If set to True, customer is required.
  - `customer` string — Customer MoneyHash UUID
  - `hide_loader_message` boolean — Hide the loader message in the payout form.
  - `hide_form_header_message` boolean — Hide the form header message in the payout form.
  - `payout_token_id` string — Payout token UUID to disburse using saved beneficiary data
  - `ip_address` string, nullable
  - `created` string, date-time, required
  - `modified` string, date-time, required
  - `processed_at` string, date-time, nullable
  - `_raw_expires_after_seconds` integer, nullable
  - `last_indexed_at` string, date-time, nullable
  - `request_id` string, nullable
  - `sdk_cp_version` string, nullable
  - `for_sandbox` boolean, required — This field used to filter data to be used in sandbox
  - `hidden_methods` unknown
  - `card_form` unknown
  - `redirect_strategy` 'redirect_inside_embed' | 'redirect_entire_window' | 'redirect_to_new_tab' | '' | 'null', nullable — * `redirect_inside_embed` - redirect_inside_embed * `redirect_entire_window` - redirect_entire_window * `redirect_to_new_tab` - redirect_to_new_tab
  - `template` unknown
  - `custom_webhook_headers` unknown
  - `intent_sdk_state` string, nullable
  - `intent_sdk_state_details` unknown
  - `mh_version` string, nullable
  - `risk_data` unknown
  - `provider_fields` unknown
  - `max_payout_amount` string, decimal, nullable
  - `billing_data` unknown
  - `success_message` string, nullable
  - `fail_message` string, nullable
  - `success_page` string, uri, nullable
  - `fail_page` string, uri, nullable
  - `api_key` string, nullable
  - `merchant_reference` string, nullable
  - `polymorphic_ctype` integer, nullable, required
  - `pay_out_method` string, nullable
  - `active_transaction` integer, nullable
  - `paying_payout_token` string, nullable

## Response `200`

- RetrievePayoutIntent
  - `id` string, required
  - `merchant_reference` string, nullable
  - `type` string, required
  - `amount` string, decimal — Payout amount
  - `amount_currency` string, required — The currency of the amount represented by a string of alphabetic code from ISO 4217 Currency code
  - `payout_status` string, required — Unified payout status derived from disburse operation
  - `active_transaction` object, nullable, required — Active payout transaction with disburse operation
  - `transactions_history` object[], required — An array of all transactions history associated with the intent
  - `state` string, required — Intent SDK state
  - `state_details` object, required — Intent SDK state details
  - `billing_data` unknown, required
  - `created` string, required — Intent creation date

## Other responses

- `400`
- `401`

---

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