Create payout intent

post

https://web.moneyhash.io/api/v1.4/payout/intent/

Create a payout intent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

string

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

uri

required

length ≤ 2000

A URL that the Moneyhash server will send a POST request to with payout data after.

back_url

uri

length ≤ 2000

A URL that allows your customers to go back to your website at anytime during the payout process.

custom_fields

string

Key value pairs of any additional information you want to save with the payout.

custom_form_definition

object

A json object containing custom form object to be displayed to the user during payout process.

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

Defaults to false

Use customer wallet to process the payout. If set to True, customer is required.

customer

string

Customer MoneyHash UUID

hide_loader_message

boolean

Defaults to false

Hide the loader message in the payout form.

hide_form_header_message

boolean

Defaults to false

Hide the form header message in the payout form.

processed_at

date-time | null

_raw_expires_after_seconds

integer | null

0 to 2147483647

last_indexed_at

date-time | null

request_id

string | null

sdk_cp_version

string | null

ip_address

string | null

hidden_methods

string

card_form

string

redirect_strategy

string | null

enum

redirect_inside_embed - redirect_inside_embed
redirect_entire_window - redirect_entire_window
redirect_to_new_tab - redirect_to_new_tab

Allowed:

template

string

custom_webhook_headers

string

intent_sdk_state

string | null

intent_sdk_state_details

string

mh_version

string | null

risk_data

string

max_payout_amount

string | null

billing_data

string

success_message

string | null

fail_message

string | null

success_page

uri | null

fail_page

uri | null

api_key

string | null

pay_out_method

string | null

active_transaction

integer | null

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

401