MOmoneyhash
v1.1

Create payout intent

Create a payout intent

post/api/v1.4/payout/intent/

Request

  • Base URL
    https://web.moneyhash.io
  • URL
    https://web.moneyhash.io/api/v1.4/payout/intent/
  • Auth
    • API key in header X-Api-Key
    • or API key in query parameter access_token

Request body

idstring required
amountstring decimal

Payout amount

amount_currencystring required

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

payout_methodstring

Payout method id

webhook_urlstring uri required

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

back_urlstring uri

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

custom_fieldsunknown
hide_payout_method_selectorboolean

Hide the payout method selector in the payout form.

hide_amount_sidebarboolean

Hide the amount sidebar in the payout form.

hide_payout_headerboolean
hide_headerboolean

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

form_onlyboolean

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_walletboolean

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

customerstring

Customer MoneyHash UUID

hide_loader_messageboolean

Hide the loader message in the payout form.

hide_form_header_messageboolean

Hide the form header message in the payout form.

payout_token_idstring

Payout token UUID to disburse using saved beneficiary data

ip_addressstring nullable
createdstring date-time required
modifiedstring date-time required
processed_atstring date-time nullable
_raw_expires_after_secondsinteger nullable
last_indexed_atstring date-time nullable
request_idstring nullable
sdk_cp_versionstring nullable
for_sandboxboolean required

This field used to filter data to be used in sandbox

hidden_methodsunknown
card_formunknown
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
templateunknown
custom_webhook_headersunknown
intent_sdk_statestring nullable
intent_sdk_state_detailsunknown
mh_versionstring nullable
risk_dataunknown
provider_fieldsunknown
max_payout_amountstring decimal nullable
billing_dataunknown
success_messagestring nullable
fail_messagestring nullable
success_pagestring uri nullable
fail_pagestring uri nullable
api_keystring nullable
merchant_referencestring nullable
polymorphic_ctypeinteger nullable required
pay_out_methodstring nullable
active_transactioninteger nullable
paying_payout_tokenstring nullable

Response

idstring required
merchant_referencestring nullable
typestring required
amountstring decimal

Payout amount

amount_currencystring required

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

payout_statusstring required

Unified payout status derived from disburse operation

active_transactionobject nullable required

Active payout transaction with disburse operation

transactions_historyobject[] required

An array of all transactions history associated with the intent

statestring required

Intent SDK state

state_detailsobject required

Intent SDK state details

billing_dataunknown required
createdstring required

Intent creation date

Changes

No recorded changes to this operation across all 2 revisions of this API.