Create payment Intent

post

https://web.moneyhash.io/api/v1.4/direct/payments/intent/

Create a payment intent

Recipes

🦉

Tokenize card with direct API for new MoneyHash customer

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

description

string

amount

string

required

The amount to charge. The field must have no more than 14 total digits and no more than 2 decimal places.

amount_currency

string

required

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

operation

string

enum

The type of the current intent which can be one of 'purchase', 'authorize' or 'capture'. Note that operation is required if flow_id is not provided.

purchase - purchase
authorize - authorize
PURCHASE - PURCHASE
AUTHORIZE - AUTHORIZE

Allowed:

webhook_url

uri

required

length ≤ 2000

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

billing_data

object

Customer billing data to pass them to the payment provider automatically to save the user time

shipping_data

object

Customer shipping data

fees

array of objects

An array of fee objects. Each object contains a multilingual title and a numeric value. The sum of all fee values must equal the total amount. Fee value can't be negative

fees

statement_descriptor

object

More info about your business so banks can help their customers to understand the transaction

account

string

flow_id

string

MoneyHash flow ID to be used during payment. If provided, operation shouldn't be provided.

payment_provider

string | null

The ID of a specific payment provider method you want to directly return for the user. If not provided, the user will be presented with a list of payment providers to choose from.

product_items

array of objects

product_items

fraud_data

object

The data will be used to communicate with the fraud detection service

custom_fields

string

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

custom_form_definition

object

A json object containing custom form object to be displayed to the user during payment

card_token

string

The ID of a card token you wish to process this payment with

card_token_data

object

bankaccount_token

string

tokenize_card

boolean

customer

string

The ID of a specific customer you wish to associate this payment with.

hide_amount_sidebar

boolean

If set to true, the payment amount overview side panel will be hidden from the embed

hide_payment_method_selector

boolean

hide_payment_header

boolean

hide_header

boolean

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

form_only

boolean

Only show the payment form to the user without other payment choices.

back_url

uri

length ≤ 2000

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

top_up_wallet

boolean

Defaults to false

If you want to top up a customer wallet using a payment, set this to true. If set to true, customer is required to create payment intent.

use_wallet

boolean

Defaults to false

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

authorization_type

string

enum

incremental - incremental
final - final
INCREMENTAL - INCREMENTAL
FINAL - FINAL

Allowed:

threeds

object

show_save_card_checkbox

boolean

Defaults to false

Will show a save card checkbox if it's applicable and the user can proceed without ticking the box

allow_tokenize_card

boolean

Defaults to false

Allowing non-embedded experience to control whether to save the card for future use

show_mandatory_save_card_checkbox

boolean

Defaults to false

Will show a save card checkbox if it's applicable and the user can NOT proceed without ticking the box

expires_after_seconds

integer

The number of seconds after which the intent will expire

show_countdown_timer

boolean

Defaults to false

Shows a countdown timer till intent expires, only valid in combination with expires_after_seconds

hidden_methods

array of strings

A list of payment methods to hide from the user

hidden_methods

create_customer

boolean

Defaults to false

Use details in customer_details to create a new customer

customer_details

string

Customer details to be used to create a new customer, required if create_customer is true

hide_loader_message

boolean

Defaults to false

hide_form_header_message

boolean

Defaults to false

hide_navigation_to_payment_methods

boolean

Defaults to false

successful_redirect_url

uri

length ≤ 2000

A URL to redirect to after a successful payment transaction

pending_external_action_redirect_url

uri

length ≤ 2000

A URL to redirect to after a payment transaction pending external action

failed_redirect_url

uri

length ≤ 2000

A URL to redirect to after a failed payment transaction

processed_redirect_url

uri

length ≤ 2000

A URL to redirect to after a payment intent is processed

closed_redirect_url

uri

length ≤ 2000

A URL to redirect to after a payment intent is closed

time_expired_redirect_url

uri

length ≤ 2000

A URL to redirect to after a payment intent is expired

use_external_api

boolean

Defaults to false

To use intent without any hosted pages. Note that your business has to be PCI compliant

ip_address

string

User's IP address to be used inside Flows and Risk rules, used only when use_direct_api is true

payment_type

string

enum

This must be specified for card payments where the cardholder is not present (i.e., recurring or mail order / telephone order)

regular - regular
recurring - recurring
moto - moto
installment - installment
unscheduled - unscheduled
REGULAR - REGULAR
RECURRING - RECURRING
MOTO - MOTO
INSTALLMENT - INSTALLMENT
UNSCHEDULED - UNSCHEDULED

previous_transaction_id

string

MoneyHash transaction Id as UUID. Used to link the transaction to an existing series of transactions.

recurring_data

object

prev_cit_payload

object

custom_webhook_headers

string

Custom headers to be sent in the webhooks.

paying_with_network_token

boolean

Defaults to false

If set to true, the payment is being made with a network token

merchant_initiated

boolean

Defaults to false

Flags the payment as a merchant-initiated transaction (MIT). It must be set to true for all MITs.

discount

object | null

partial_wallet

boolean

Defaults to false

redirect_branding_data

object

aft

boolean

Defaults to false

aft_data

object

vault_region

string

enum

Defaults to default

sa - sa
default - default

Allowed:

device_info

object

Device information including user agent and optional additional details

processed_at

date-time | null

last_indexed_at

date-time | null

sdk_cp_version

string | null

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:

intent_sdk_state

string | null

intent_sdk_state_details

string

mh_version

string | null

risk_data

string

success_message

string | null

fail_message

string | null

mixpanel_status

string | null

enum

NOT_SENT - NOT_SENT
SENDING - SENDING
SENT - SENT

Allowed:

mixpanel_transition_state

string | null

hide_retry_button

boolean

hide_try_different_method_button

boolean

hide_iframe_go_back

boolean | null

intent_reseted

boolean | null

do_risk_checker

boolean | null

fraud_data_collected

string

payment_method

string | null

enum

CASH_OUTLET - CASH_OUTLET
MOBILE_WALLET - MOBILE_WALLET
CARD - CARD
USSD - USSD
KNET - KNET
CASH_COLLECTION - CASH_COLLECTION
AMAN_MASARY - AMAN_MASARY
PAYPAL - PAYPAL
PAY_AT_FAWRY - PAY_AT_FAWRY
VALU - VALU
SHAHRY - SHAHRY
CASH_ON_DELIVERY - CASH_ON_DELIVERY
BANK_INSTALLMENTS - BANK_INSTALLMENTS
BANK_TRANSFERS - BANK_TRANSFERS
REFERENCE_NUMBER - REFERENCE_NUMBER
SELFSERVE_WALLET - SELFSERVE_WALLET
APPLE_PAY - APPLE_PAY
CLICK2PAY - CLICK2PAY
GOOGLE_PAY - GOOGLE_PAY
CAREEM_PAY - CAREEM_PAY
PAY_FLEX - PAY_FLEX
M_PESA - M_PESA
MOBILE_MONEY - MOBILE_MONEY
CRYPTO_WALLET - CRYPTO_WALLET
NAPS - NAPS
FORSA - FORSA
SYMPL - SYMPL
TABBY - TABBY
SOUHOOLA - SOUHOOLA
GETGO - GETGO
SAMSUNG_PAY - SAMSUNG_PAY
QPAY - QPAY
TAMARA - TAMARA
BENEFIT - BENEFIT
RAZER - RAZER
ININAL - ININAL
STC - STC
MOKAFAA - MOKAFAA
SADAD - SADAD
EFAWATEERCOM - EFAWATEERCOM
OMANNET - OMANNET
MADA - MADA
TAPTOPAY - TAPTOPAY
GRABPAY - GRABPAY
GRABPAYPAYLATER - GRABPAYPAYLATER
SHOPEEPAY - SHOPEEPAY
SHOPEEPAYPAYLATER - SHOPEEPAYPAYLATER
ATOME - ATOME
TOUCHNGO - TOUCHNGO
BOOST - BOOST
PAYNOW - PAYNOW
UPI - UPI
ZAINCASH - ZAINCASH
WALAONE - WALAONE

recommended_payment_methods

string

paying_network_token_payload

string

bin_lookup_result

string

show_back_to_merchant_button

boolean | null

last_fraud_service

string | null

require_early_apple_pay_receipt

boolean | null

requires_early_receipt

boolean | null

merchant_reference

string | null

hide_filled_billing_fields

boolean | null

apple_pay_receipt

string

apple_pay_reset_method_button

boolean | null

google_pay_receipt

string

click2pay_receipt

string

receipt

string

is_embedded

boolean | null

merchant_origin

uri | null

paying_bankaccount_token

string | null

Responses

200

400

401