Create payout intent

Create a payout intent

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Payout amount

string
required

The currency of the amount represented by a string of alphabetic code from ISO 4217 Currency code

string

Payout method id

uri
required
length ≤ 2000

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

uri
length ≤ 2000

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

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.

boolean

Hide the payout method selector in the payout form.

boolean

Hide the amount sidebar in the payout form.

boolean
boolean

if set to True, hides MoneyHash branding header from the returned embed form.

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.

boolean
Defaults to false

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

string

Customer MoneyHash UUID

boolean
Defaults to false

Hide the loader message in the payout form.

boolean
Defaults to false

Hide the form header message in the payout form.

date-time | null
integer | null
0 to 2147483647
date-time | null
string | null
string | null
string | null
string
string
string | null
enum
  • redirect_inside_embed - redirect_inside_embed
  • redirect_entire_window - redirect_entire_window
  • redirect_to_new_tab - redirect_to_new_tab
Allowed:
string
string
string | null
string
string | null
string
string | null
string
string | null
string | null
uri | null
uri | null
string | null
string | null
integer | null
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json