amount_currencystring required
The currency of the amount represented by a string of alphabetic code from ISO 4217 Currency code
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.
{"stackTrail":"components:schemas:BasePayout:properties:custom_fields","oasType":"schema","type":"unknown","description":"Key value pairs of any additional information you want to save with the payout."}
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.
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
{"stackTrail":"components:schemas:BasePayout:properties:hidden_methods","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:BasePayout:properties:card_form","oasType":"schema","type":"unknown","nullable":true}
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
{"stackTrail":"components:schemas:BasePayout:properties:template","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:BasePayout:properties:custom_webhook_headers","oasType":"schema","type":"unknown","nullable":true}
intent_sdk_statestring nullable
{"stackTrail":"components:schemas:BasePayout:properties:intent_sdk_state_details","oasType":"schema","type":"unknown","nullable":true}
mh_versionstring nullable
{"stackTrail":"components:schemas:BasePayout:properties:risk_data","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:BasePayout:properties:provider_fields","oasType":"schema","type":"unknown","nullable":true}
max_payout_amountstring decimal nullable
{"stackTrail":"components:schemas:BasePayout:properties:billing_data","oasType":"schema","type":"unknown","nullable":true}
success_messagestring nullable
fail_messagestring nullable
success_pagestring uri nullable
fail_pagestring uri nullable
merchant_referencestring nullable
polymorphic_ctypeinteger nullable required
pay_out_methodstring nullable
active_transactioninteger nullable
paying_payout_tokenstring nullable