--- title: "Create payment Intent" method: POST path: "/api/v1.4/payments/intent/" tags: ["v1.1"] --- # Create payment Intent `POST /api/v1.4/payments/intent/` Create a payment intent ## Request body - BaseIntent — Base Serializer for different payments - `id` string, required - `description` string - `amount` string, decimal, 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` 'purchase' | 'authorize' | 'PURCHASE' | 'AUTHORIZE' | '' — 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 - `webhook_url` string, uri, required — A URL that the Moneyhash server will send a POST request to with payment data after payment. - `billing_data` BillingDataSerializerField - `name` string, nullable — The full name of the customer. Maximum length is 100 characters. - `first_name` string, nullable — The first name of the customer. Maximum length is 100 characters. - `last_name` string, nullable — The last name of the customer. Maximum length is 150 characters. - `email` string, nullable — The email address of the customer. - `phone_number` string, nullable — The phone number of the customer. It should be in a valid international format. - `address` string — The full address of the customer. Maximum length is 500 characters. - `address1` string — Additional address line for the customer. Maximum length is 500 characters. - `apartment` string — The apartment number of the customer. Maximum length is 10 characters. - `floor` string — The floor number of the customer's address. Maximum length is 10 characters. - `building` string — The building number or name of the customer's address. Maximum length is 255 characters. - `street` string — The street name of the customer. Maximum length is 500 characters. - `city` string — The city of the customer. Maximum length is 255 characters. - `state` string, nullable — The state or province of the customer. Maximum length is 255 characters. - `country` string — The country of the customer. Maximum length is 255 characters. - `postal_code` string — The postal code of the customer. Maximum length is 10 characters. - `mobile_wallet_number` string, nullable — The mobile wallet number of the customer. - `shipping_data` ShippingData - `first_name` string — First name of the recipient. - `last_name` string — Last name of the recipient. - `email` string, email — Email address of the recipient. - `phone_number` string — Phone number of the recipient. - `address` string — Address of the recipient. - `country` string — Country of the recipient. - `state` string — State of the recipient. - `city` string — City of the recipient. - `postal_code` string — Postal code of the recipient. - `street` string — Street name of the recipient. - `floor` string — Floor number of the recipient's residence. - `building` string — Building name or number of the recipient's residence. - `apartment` string — Apartment number of the recipient. - `description` string — Additional delivery instructions or information. - `shipping_method` string — Preferred shipping method. - `fees` Fees[] — 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 - `title` GeneralAmountsTitle, required - `en` string, required - `ar` string - `fr` string - `value` string, decimal, required - `discount` Discount - `title` GeneralAmountsTitle, required - `en` string, required - `ar` string - `fr` string - `value` string, decimal, required - `type` 'percentage' | 'amount', required — Discount type applied, it could be percentage type which is percentage of the amount or amount type which is a fixed amount * `percentage` - percentage * `amount` - amount - `statement_descriptor` StatementDescriptor - `business_name` string, nullable - `business_city` string, nullable - `business_country` string, nullable - `account` string - `flow_id` string — MoneyHash flow ID to be used during payment. If provided, `operation` shouldn't be provided. - `payment_provider` string, nullable — 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` ProductItems[] - `name` string, required — Item name - `amount` string, decimal, required — Final net amount for the entire item line - `unit_amount` string, decimal — Gross price per unit before discount (display only) - `description` string, required — A brief description of the item - `quantity` integer, required — Number of items - `category` 'Animals & Pet Supplies' | 'Apparel & Accessories' | 'Arts & Entertainment' | 'Baby & Toddler' | 'Business & Industrial' | 'Cameras & Optics' | 'Electronics' | 'Food, Beverages & Tobacco' | 'Furniture' | 'Hardware' | 'Health & Beauty' | 'Home & Garden' | 'Luggage & Bags' | 'Mature' | 'Media' | 'Office Supplies' | 'Religious & Ceremonial' | 'Software' | 'Sporting Goods' | 'Toys & Games' | 'Vehicles & Parts' | 'Crypto' — Item category * `Animals & Pet Supplies` - Animals & Pet Supplies * `Apparel & Accessories` - Apparel & Accessories * `Arts & Entertainment` - Arts & Entertainment * `Baby & Toddler` - Baby & Toddler * `Business & Industrial` - Business & Industrial * `Cameras & Optics` - Cameras & Optics * `Electronics` - Electronics * `Food, Beverages & Tobacco` - Food, Beverages & Tobacco * `Furniture` - Furniture * `Hardware` - Hardware * `Health & Beauty` - Health & Beauty * `Home & Garden` - Home & Garden * `Luggage & Bags` - Luggage & Bags * `Mature` - Mature * `Media` - Media * `Office Supplies` - Office Supplies * `Religious & Ceremonial` - Religious & Ceremonial * `Software` - Software * `Sporting Goods` - Sporting Goods * `Toys & Games` - Toys & Games * `Vehicles & Parts` - Vehicles & Parts * `Crypto` - Crypto - `subcategory` 'Live Animals' | 'Pet Supplies' | 'Clothing' | 'Clothing Accessories' | 'Costumes & Accessories' | 'Handbag & Wallet Accessories' | 'Handbags, Wallets & Cases' | 'Jewelry' | 'Shoe Accessories' | 'Shoes' | 'Event Tickets' | 'Hobbies & Creative Arts' | 'Party & Celebration' | 'Baby Bathing' | 'Baby Gift Sets' | 'Baby Health' | 'Baby Safety' | 'Baby Toys & Activity Equipment' | 'Baby Transport' | 'Baby Transport Accessories' | 'Diapering' | 'Nursing & Feeding' | 'Potty Training' | 'Swaddling & Receiving Blankets' | 'Advertising & Marketing' | 'Agriculture' | 'Automation Control Components' | 'Construction' | 'Dentistry' | 'Film & Television' | 'Finance & Insurance' | 'Food Service' | 'Forestry & Logging' | 'Hairdressing & Cosmetology' | 'Heavy Machinery' | 'Hotel & Hospitality' | 'Industrial Storage' | 'Industrial Storage Accessories' | 'Janitorial Carts & Caddies' | 'Law Enforcement' | 'Manufacturing' | 'Material Handling' | 'Medical' | 'Mining & Quarrying' | 'Piercing & Tattooing' | 'Retail' | 'Science & Laboratory' | 'Signage' | 'Work Safety Protective Gear' | 'Camera & Optic Accessories' | 'Cameras' | 'Optics' | 'Photography' | 'Arcade Equipment' | 'Audio' | 'Circuit Boards & Components' | 'Communications' | 'Components' | 'Computers' | 'Electronics Accessories' | 'GPS Accessories' | 'GPS Navigation Systems' | 'GPS Tracking Devices' | 'Marine Electronics' | 'Networking' | 'Print, Copy, Scan & Fax' | 'Radar Detectors' | 'Speed Radars' | 'Toll Collection Devices' | 'Video' | 'Video Game Console Accessories' | 'Video Game Consoles' | 'Beverages' | 'Food Items' | 'Tobacco Products' | 'Baby & Toddler Furniture' | 'Beds & Accessories' | 'Benches' | 'Cabinets & Storage' | 'Carts & Islands' | 'Chair Accessories' | 'Chairs' | 'Entertainment Centers & TV Stands' | 'Furniture Sets' | 'Futon Frames' | 'Futon Pads' | 'Futons' | 'Office Furniture' | 'Office Furniture Accessories' | 'Ottomans' | 'Outdoor Furniture' | 'Outdoor Furniture Accessories' | 'Room Divider Accessories' | 'Room Dividers' | 'Shelving' | 'Shelving Accessories' | 'Sofa Accessories' | 'Sofas' | 'Table Accessories' | 'Tables' | 'Building Consumables' | 'Building Materials' | 'Fencing & Barriers' | 'Fuel' | 'Fuel Containers & Tanks' | 'Hardware Accessories' | 'Hardware Pumps' | 'Heating, Ventilation & Air Conditioning' | 'Locks & Keys' | 'Plumbing' | 'Power & Electrical Supplies' | 'Small Engines' | 'Storage Tanks' | 'Tool Accessories' | 'Tools' | 'Health Care' | 'Jewelry Cleaning & Care' | 'Personal Care' | 'Bathroom Accessories' | 'Business & Home Security' | 'Decor' | 'Emergency Preparedness' | 'Fireplace & Wood Stove Accessories' | 'Fireplaces' | 'Flood, Fire & Gas Safety' | 'Household Appliance Accessories' | 'Household Appliances' | 'Household Supplies' | 'Kitchen & Dining' | 'Lawn & Garden' | 'Lighting' | 'Lighting Accessories' | 'Linens & Bedding' | 'Parasols & Rain Umbrellas' | 'Plants' | 'Pool & Spa' | 'Smoking Accessories' | 'Umbrella Sleeves & Cases' | 'Wood Stoves' | 'Backpacks' | 'Briefcases' | 'Cosmetic & Toiletry Bags' | 'Diaper Bags' | 'Dry Boxes' | 'Duffel Bags' | 'Fanny Packs' | 'Garment Bags' | 'Luggage Accessories' | 'Messenger Bags' | 'Shopping Totes' | 'Suitcases' | 'Train Cases' | 'Erotic' | 'Weapons' | 'Books' | 'Carpentry & Woodworking Project Plans' | 'DVDs & Videos' | 'Magazines & Newspapers' | 'Music & Sound Recordings' | 'Product Manuals' | 'Sheet Music' | 'Book Accessories' | 'Desk Pads & Blotters' | 'Filing & Organization' | 'General Office Supplies' | 'Impulse Sealers' | 'Lap Desks' | 'Name Plates' | 'Office & Chair Mats' | 'Office Carts' | 'Office Equipment' | 'Office Instruments' | 'Paper Handling' | 'Presentation Supplies' | 'Shipping Supplies' | 'Memorial Ceremony Supplies' | 'Religious Items' | 'Wedding Ceremony Supplies' | 'Computer Software' | 'Digital Goods & Currency' | 'Video Game Software' | 'Athletics' | 'Exercise & Fitness' | 'Indoor Games' | 'Outdoor Recreation' | 'Game Timers' | 'Games' | 'Outdoor Play Equipment' | 'Puzzles' | 'Toys' | 'Vehicle Parts & Accessories' | 'Vehicles' | 'Cryptocurrency' | 'Token' — Item subcategory of the selected category * `Live Animals` - Live Animals * `Pet Supplies` - Pet Supplies * `Clothing` - Clothing * `Clothing Accessories` - Clothing Accessories * `Costumes & Accessories` - Costumes & Accessories * `Handbag & Wallet Accessories` - Handbag & Wallet Accessories * `Handbags, Wallets & Cases` - Handbags, Wallets & Cases * `Jewelry` - Jewelry * `Shoe Accessories` - Shoe Accessories * `Shoes` - Shoes * `Event Tickets` - Event Tickets * `Hobbies & Creative Arts` - Hobbies & Creative Arts * `Party & Celebration` - Party & Celebration * `Baby Bathing` - Baby Bathing * `Baby Gift Sets` - Baby Gift Sets * `Baby Health` - Baby Health * `Baby Safety` - Baby Safety * `Baby Toys & Activity Equipment` - Baby Toys & Activity Equipment * `Baby Transport` - Baby Transport * `Baby Transport Accessories` - Baby Transport Accessories * `Diapering` - Diapering * `Nursing & Feeding` - Nursing & Feeding * `Potty Training` - Potty Training * `Swaddling & Receiving Blankets` - Swaddling & Receiving Blankets * `Advertising & Marketing` - Advertising & Marketing * `Agriculture` - Agriculture * `Automation Control Components` - Automation Control Components * `Construction` - Construction * `Dentistry` - Dentistry * `Film & Television` - Film & Television * `Finance & Insurance` - Finance & Insurance * `Food Service` - Food Service * `Forestry & Logging` - Forestry & Logging * `Hairdressing & Cosmetology` - Hairdressing & Cosmetology * `Heavy Machinery` - Heavy Machinery * `Hotel & Hospitality` - Hotel & Hospitality * `Industrial Storage` - Industrial Storage * `Industrial Storage Accessories` - Industrial Storage Accessories * `Janitorial Carts & Caddies` - Janitorial Carts & Caddies * `Law Enforcement` - Law Enforcement * `Manufacturing` - Manufacturing * `Material Handling` - Material Handling * `Medical` - Medical * `Mining & Quarrying` - Mining & Quarrying * `Piercing & Tattooing` - Piercing & Tattooing * `Retail` - Retail * `Science & Laboratory` - Science & Laboratory * `Signage` - Signage * `Work Safety Protective Gear` - Work Safety Protective Gear * `Camera & Optic Accessories` - Camera & Optic Accessories * `Cameras` - Cameras * `Optics` - Optics * `Photography` - Photography * `Arcade Equipment` - Arcade Equipment * `Audio` - Audio * `Circuit Boards & Components` - Circuit Boards & Components * `Communications` - Communications * `Components` - Components * `Computers` - Computers * `Electronics Accessories` - Electronics Accessories * `GPS Accessories` - GPS Accessories * `GPS Navigation Systems` - GPS Navigation Systems * `GPS Tracking Devices` - GPS Tracking Devices * `Marine Electronics` - Marine Electronics * `Networking` - Networking * `Print, Copy, Scan & Fax` - Print, Copy, Scan & Fax * `Radar Detectors` - Radar Detectors * `Speed Radars` - Speed Radars * `Toll Collection Devices` - Toll Collection Devices * `Video` - Video * `Video Game Console Accessories` - Video Game Console Accessories * `Video Game Consoles` - Video Game Consoles * `Beverages` - Beverages * `Food Items` - Food Items * `Tobacco Products` - Tobacco Products * `Baby & Toddler Furniture` - Baby & Toddler Furniture * `Beds & Accessories` - Beds & Accessories * `Benches` - Benches * `Cabinets & Storage` - Cabinets & Storage * `Carts & Islands` - Carts & Islands * `Chair Accessories` - Chair Accessories * `Chairs` - Chairs * `Entertainment Centers & TV Stands` - Entertainment Centers & TV Stands * `Furniture Sets` - Furniture Sets * `Futon Frames` - Futon Frames * `Futon Pads` - Futon Pads * `Futons` - Futons * `Office Furniture` - Office Furniture * `Office Furniture Accessories` - Office Furniture Accessories * `Ottomans` - Ottomans * `Outdoor Furniture` - Outdoor Furniture * `Outdoor Furniture Accessories` - Outdoor Furniture Accessories * `Room Divider Accessories` - Room Divider Accessories * `Room Dividers` - Room Dividers * `Shelving` - Shelving * `Shelving Accessories` - Shelving Accessories * `Sofa Accessories` - Sofa Accessories * `Sofas` - Sofas * `Table Accessories` - Table Accessories * `Tables` - Tables * `Building Consumables` - Building Consumables * `Building Materials` - Building Materials * `Fencing & Barriers` - Fencing & Barriers * `Fuel` - Fuel * `Fuel Containers & Tanks` - Fuel Containers & Tanks * `Hardware Accessories` - Hardware Accessories * `Hardware Pumps` - Hardware Pumps * `Heating, Ventilation & Air Conditioning` - Heating, Ventilation & Air Conditioning * `Locks & Keys` - Locks & Keys * `Plumbing` - Plumbing * `Power & Electrical Supplies` - Power & Electrical Supplies * `Small Engines` - Small Engines * `Storage Tanks` - Storage Tanks * `Tool Accessories` - Tool Accessories * `Tools` - Tools * `Health Care` - Health Care * `Jewelry Cleaning & Care` - Jewelry Cleaning & Care * `Personal Care` - Personal Care * `Bathroom Accessories` - Bathroom Accessories * `Business & Home Security` - Business & Home Security * `Decor` - Decor * `Emergency Preparedness` - Emergency Preparedness * `Fireplace & Wood Stove Accessories` - Fireplace & Wood Stove Accessories * `Fireplaces` - Fireplaces * `Flood, Fire & Gas Safety` - Flood, Fire & Gas Safety * `Household Appliance Accessories` - Household Appliance Accessories * `Household Appliances` - Household Appliances * `Household Supplies` - Household Supplies * `Kitchen & Dining` - Kitchen & Dining * `Lawn & Garden` - Lawn & Garden * `Lighting` - Lighting * `Lighting Accessories` - Lighting Accessories * `Linens & Bedding` - Linens & Bedding * `Parasols & Rain Umbrellas` - Parasols & Rain Umbrellas * `Plants` - Plants * `Pool & Spa` - Pool & Spa * `Smoking Accessories` - Smoking Accessories * `Umbrella Sleeves & Cases` - Umbrella Sleeves & Cases * `Wood Stoves` - Wood Stoves * `Backpacks` - Backpacks * `Briefcases` - Briefcases * `Cosmetic & Toiletry Bags` - Cosmetic & Toiletry Bags * `Diaper Bags` - Diaper Bags * `Dry Boxes` - Dry Boxes * `Duffel Bags` - Duffel Bags * `Fanny Packs` - Fanny Packs * `Garment Bags` - Garment Bags * `Luggage Accessories` - Luggage Accessories * `Messenger Bags` - Messenger Bags * `Shopping Totes` - Shopping Totes * `Suitcases` - Suitcases * `Train Cases` - Train Cases * `Erotic` - Erotic * `Weapons` - Weapons * `Books` - Books * `Carpentry & Woodworking Project Plans` - Carpentry & Woodworking Project Plans * `DVDs & Videos` - DVDs & Videos * `Magazines & Newspapers` - Magazines & Newspapers * `Music & Sound Recordings` - Music & Sound Recordings * `Product Manuals` - Product Manuals * `Sheet Music` - Sheet Music * `Book Accessories` - Book Accessories * `Desk Pads & Blotters` - Desk Pads & Blotters * `Filing & Organization` - Filing & Organization * `General Office Supplies` - General Office Supplies * `Impulse Sealers` - Impulse Sealers * `Lap Desks` - Lap Desks * `Name Plates` - Name Plates * `Office & Chair Mats` - Office & Chair Mats * `Office Carts` - Office Carts * `Office Equipment` - Office Equipment * `Office Instruments` - Office Instruments * `Paper Handling` - Paper Handling * `Presentation Supplies` - Presentation Supplies * `Shipping Supplies` - Shipping Supplies * `Memorial Ceremony Supplies` - Memorial Ceremony Supplies * `Religious Items` - Religious Items * `Wedding Ceremony Supplies` - Wedding Ceremony Supplies * `Computer Software` - Computer Software * `Digital Goods & Currency` - Digital Goods & Currency * `Video Game Software` - Video Game Software * `Athletics` - Athletics * `Exercise & Fitness` - Exercise & Fitness * `Indoor Games` - Indoor Games * `Outdoor Recreation` - Outdoor Recreation * `Game Timers` - Game Timers * `Games` - Games * `Outdoor Play Equipment` - Outdoor Play Equipment * `Puzzles` - Puzzles * `Toys` - Toys * `Vehicle Parts & Accessories` - Vehicle Parts & Accessories * `Vehicles` - Vehicles * `Cryptocurrency` - Cryptocurrency * `Token` - Token - `type` 'Physical' | 'Digital' — Whether the item is physical or digital * `Physical` - Physical * `Digital` - Digital - `image_url` string, uri, nullable — Item image URL if exists - `sku` string — The stock keeping unit of the item - `tax` string, decimal — Tax amount if applicable - `extra_information` unknown - `discount` Discount - `title` GeneralAmountsTitle, required - `en` string, required - `ar` string - `fr` string - `value` string, decimal, required - `type` 'percentage' | 'amount', required — Discount type applied, it could be percentage type which is percentage of the amount or amount type which is a fixed amount * `percentage` - percentage * `amount` - amount - `fraud_data` FraudDataSerializerField - `order_type` 'web' | 'mobile' | 'ios' | 'android' | 'mail_order' | 'merchant_initiated' | 'unknown' | 'WEB' | 'MOBILE' | 'IOS' | 'ANDROID' | 'MAIL_ORDER' | 'MERCHANT_INITIATED' | 'UNKNOWN', required — Platform order was made through * `web` - web * `mobile` - mobile * `ios` - ios * `android` - android * `mail_order` - mail_order * `merchant_initiated` - merchant_initiated * `unknown` - unknown * `WEB` - WEB * `MOBILE` - MOBILE * `IOS` - IOS * `ANDROID` - ANDROID * `MAIL_ORDER` - MAIL_ORDER * `MERCHANT_INITIATED` - MERCHANT_INITIATED * `UNKNOWN` - UNKNOWN - `primary_delivery_details` FraudDataDeliveryDetailsSerializerField, required - `delivery_type` 'DIGITAL' | 'PHYSICAL' | 'HYBRID', required — Type of delivery: PHYSICAL for any type of shipped goods. DIGITAL for non-shipped goods (services, gift cards etc.) * `DIGITAL` - DIGITAL * `PHYSICAL` - PHYSICAL * `HYBRID` - HYBRID - `delivery_method` string, required — Delivery method chosen by customer such as postal service, email, in game transfer, etc. - `account_id` string, required — The Customer identifier - `customer_created_at` integer, required — Customer creation date in epoch format - `forter_token_cookie` string — Forter cookie collected by forter sdk - `custom_fields` unknown - `custom_form_definition` CustomFormDefinition - `form_title` string, required — A title to be shown to the user on the form - `fields` CustomFormFields[], required — Field definitions that contain name, validation...etc - `name` string, required — field name - `value` string - `label` string, required — Field label - `type` 'CharField' | 'BooleanField' | 'IntegerField' | 'ChoiceField', required — Field type * `CharField` - CharField * `BooleanField` - BooleanField * `IntegerField` - IntegerField * `ChoiceField` - ChoiceField - `required` boolean, required — Whether the field is required or not - `choices` unknown - `help_text` string — Field help text - `max_length` integer — Maximum length of the field - `min_length` integer — Minimum length of the field - `min_value` integer - `max_value` integer - `card_token` string — The ID of a card token you wish to process this payment with - `card_token_data` CardTokenData - `cvv` string, nullable - `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` string, uri — A URL that allows your customers to go back to your website at anytime during the payment. - `top_up_wallet` boolean — 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 — Use customer wallet to process the payment. If set to True, customer is required. - `authorization_type` 'incremental' | 'final' | 'INCREMENTAL' | 'FINAL' | '' — * `incremental` - incremental * `final` - final * `INCREMENTAL` - INCREMENTAL * `FINAL` - FINAL - `threeds` ThreeDS - `enabled` boolean, required - `challenge_indicator` string - `show_save_card_checkbox` boolean — Will show a save card checkbox if it's applicable and the user can proceed without ticking the box - `allow_tokenize_card` boolean — Allowing non-embedded experience to control whether to save the card for future use - `show_mandatory_save_card_checkbox` boolean — 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 — Shows a countdown timer till intent expires, only valid in combination with expires_after_seconds - `hidden_methods` string[] — A list of payment methods to hide from the user - `create_customer` boolean — Use details in `customer_details` to create a new customer - `customer_details` unknown - `hide_loader_message` boolean - `hide_form_header_message` boolean - `hide_navigation_to_payment_methods` boolean - `successful_redirect_url` string, uri — A URL to redirect to after a successful payment transaction - `pending_external_action_redirect_url` string, uri — A URL to redirect to after a payment transaction pending external action - `failed_redirect_url` string, uri — A URL to redirect to after a failed payment transaction - `processed_redirect_url` string, uri — A URL to redirect to after a payment intent is processed - `closed_redirect_url` string, uri — A URL to redirect to after a payment intent is closed - `time_expired_redirect_url` string, uri — A URL to redirect to after a payment intent is expired - `use_external_api` boolean — 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` 'regular' | 'recurring' | 'moto' | 'installment' | 'unscheduled' | 'REGULAR' | 'RECURRING' | 'MOTO' | 'INSTALLMENT' | 'UNSCHEDULED' | '' — 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` RecurringData - `mh_subscription_id` string - `agreement_id` string - `number_of_payments` integer - `days_between_payments` integer - `expiry_date` string, date - `prev_cit_payload` PrevCitPayload - `CKO` CKOPrevCitPayload - `previous_payment_id` string, required — The previous payment ID from Checkout.com - `NOON` NOONPrevCitPayload - `subscription` NoonSubscription, required - `identifier` string, required — The subscription identifier from NOON Payments - `APS` APSPrevCitPayload - `agreement_id` string, required — The agreement ID from Amazon Payment Services - `MPGS` MPGSPrevCitPayload - `agreement` MPGSAgreement, required - `id` string, required — The agreement ID from Mastercard Payment Gateway Services - `GEIDEA` GEIDEAPrevCitPayload - `cofAgreement` GeideaCofAgreement, required - `id` string, required — The COF agreement ID from Geidea - `CYBERSOURCE` CYBERSOURCEPrevCitPayload - `agreementId` string, required — The agreement ID from CyberSource - `custom_webhook_headers` unknown - `paying_with_network_token` boolean — If set to true, the payment is being made with a network token - `merchant_initiated` boolean — Flags the payment as a merchant-initiated transaction (MIT). It must be set to true for all MITs. - `discount` Discount - `title` GeneralAmountsTitle, required - `en` string, required - `ar` string - `fr` string - `value` string, decimal, required - `type` 'percentage' | 'amount', required — Discount type applied, it could be percentage type which is percentage of the amount or amount type which is a fixed amount * `percentage` - percentage * `amount` - amount - `partial_wallet` boolean - `redirect_branding_data` RedirectBrandingData - `color` string - `background_color` string - `size` string - `icon` string, uri - `animate` string - `aft` boolean - `aft_data` AftData - `type` 'account_to_account' | 'supplier_payments' | 'bank_initiated_p2p' | 'bill_payment' | 'cash_deposit' | 'card_bill_payment' | 'funds_disbursement' | 'funds_transfer' | 'government_disbursement' | 'loyalty' | 'merchant_settlement' | 'gambling_payout' | 'payroll' | 'p2p' | 'prepaid_topup' | 'wallet_transfer' | 'cryptocurrency' | 'b2b_payment' | 'debit_topup' | 'other', required — Transfer type * `account_to_account` - Account to Account * `supplier_payments` - Supplier Payments * `bank_initiated_p2p` - Bank Initiated P2P * `bill_payment` - Bill Payment * `cash_deposit` - Cash Deposit * `card_bill_payment` - Card Bill Payment * `funds_disbursement` - Funds Disbursement * `funds_transfer` - Funds Transfer * `government_disbursement` - Government Disbursement * `loyalty` - Loyalty * `merchant_settlement` - Merchant Settlement * `gambling_payout` - Gambling Payout * `payroll` - Payroll * `p2p` - P2P * `prepaid_topup` - Prepaid Topup * `wallet_transfer` - Wallet Transfer * `cryptocurrency` - Cryptocurrency * `b2b_payment` - B2B Payment * `debit_topup` - Debit Topup * `other` - Other - `purpose` 'family_support' | 'expatriation' | 'travel' | 'education' | 'medical_treatment' | 'emergency_need' | 'savings' | 'gifts' | 'other' | 'salary' | 'crowd_lending' | 'crypto_purchase' | 'high_risk_securities' | 'donations' | 'financial_services' | 'insurance' | 'investment' | 'it_services' | 'leisure' | 'pension' | 'royalties' | 'high_risk' | 'income' | 'loan_payment', required — Purpose of the transfer * `family_support` - Family Support * `expatriation` - Expatriation * `travel` - Travel * `education` - Education * `medical_treatment` - Medical * `emergency_need` - Emergency Need * `savings` - Savings * `gifts` - Gifts * `other` - Other * `salary` - Salary * `crowd_lending` - Crowd Lending * `crypto_purchase` - Crypto Purchase * `high_risk_securities` - High Risk Securities * `donations` - Donations * `financial_services` - Financial Services * `insurance` - Insurance * `investment` - Investment * `it_services` - IT Services * `leisure` - Leisure * `pension` - Pension * `royalties` - Royalties * `high_risk` - High Risk * `income` - Income * `loan_payment` - Loan Payment - `sender` AFTBaseAddress, required - `first_name` string, required — First name - `last_name` string, required — Last name - `address` string — Street address - `postal_code` string — Postal/ZIP code - `city` string — City - `country` string, required — 2-letter ISO country code - `recipient` Recipient, required - `first_name` string, required — First name - `last_name` string, required — Last name - `address` string — Street address - `postal_code` string — Postal/ZIP code - `city` string — City - `country` string, required — 2-letter ISO country code - `account_type` 'wallet' | 'bank_account' | 'iban' | 'card_number', required — Recipient account type * `wallet` - Wallet * `bank_account` - Bank Account * `iban` - IBAN * `card_number` - Card Number - `id` string, required — Unique recipient identifier - `vault_region` 'sa' | 'default' | '' — * `sa` - sa * `default` - default - `device_info` Device - `user_agent` string, required — The user agent string from the device/browser - `timestamp` string — Timestamp of the device information - `language` string — Language setting of the device - `color_depth` string — Color depth of the device screen - `screen_height` string — Screen height of the device - `screen_width` string — Screen width of the device - `timezone` string — Timezone offset of the device - `created` string, date-time, required - `modified` string, date-time, required - `processed_at` string, date-time, nullable - `last_indexed_at` string, date-time, nullable - `sdk_cp_version` string, nullable - `for_sandbox` boolean, required — This field used to filter data to be used in sandbox - `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 - `intent_sdk_state` string, nullable - `intent_sdk_state_details` unknown - `mh_version` string, nullable - `risk_data` unknown - `provider_fields` unknown - `success_message` string, nullable - `fail_message` string, nullable - `mixpanel_status` 'NOT_SENT' | 'SENDING' | 'SENT' | '' | 'null', nullable — * `NOT_SENT` - NOT_SENT * `SENDING` - SENDING * `SENT` - SENT - `mixpanel_transition_state` string, nullable - `loyalty_data` unknown - `loyalty_context` unknown - `hide_retry_button` boolean - `hide_try_different_method_button` boolean - `hide_iframe_go_back` boolean, nullable - `intent_reseted` boolean, nullable - `do_risk_checker` boolean, nullable - `fraud_data_collected` unknown - `payment_method` 'CASH_OUTLET' | 'MOBILE_WALLET' | 'CARD' | 'USSD' | 'KNET' | 'CASH_COLLECTION' | 'AMAN_MASARY' | 'PAYPAL' | 'PAY_AT_FAWRY' | 'VALU' | 'SHAHRY' | 'CASH_ON_DELIVERY' | 'BANK_INSTALLMENTS' | 'BANK_TRANSFERS' | 'REFERENCE_NUMBER' | 'SELFSERVE_WALLET' | 'APPLE_PAY' | 'CLICK2PAY' | 'GOOGLE_PAY' | 'CAREEM_PAY' | 'PAY_FLEX' | 'M_PESA' | 'MOBILE_MONEY' | 'CRYPTO_WALLET' | 'NAPS' | 'FORSA' | 'SYMPL' | 'TABBY' | 'SOUHOOLA' | 'GETGO' | 'SAMSUNG_PAY' | 'QPAY' | 'TAMARA' | 'BENEFIT' | 'RAZER' | 'ININAL' | 'STC' | 'MOKAFAA' | 'SADAD' | 'EFAWATEERCOM' | 'OMANNET' | 'MADA' | 'TAPTOPAY' | 'GRABPAY' | 'GRABPAYPAYLATER' | 'SHOPEEPAY' | 'SHOPEEPAYPAYLATER' | 'ATOME' | 'TOUCHNGO' | 'BOOST' | 'PAYNOW' | 'UPI' | 'ZAINCASH' | 'WALAONE' | 'QITAF' | 'EFT' | 'CAPITEC_PAY' | '' | 'null', nullable — * `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 * `QITAF` - QITAF * `EFT` - EFT * `CAPITEC_PAY` - CAPITEC_PAY - `recommended_payment_methods` unknown - `paying_network_token_payload` unknown - `bin_lookup_result` unknown - `show_back_to_merchant_button` boolean, nullable - `last_fraud_service` string, nullable - `require_early_apple_pay_receipt` boolean, nullable - `requires_early_receipt` boolean, nullable - `merchant_reference` string, nullable - `hide_filled_billing_fields` boolean, nullable - `apple_pay_receipt` unknown - `apple_pay_reset_method_button` boolean, nullable - `google_pay_receipt` unknown - `click2pay_receipt` unknown - `receipt` unknown - `is_embedded` boolean, nullable - `merchant_origin` string, uri, nullable - `number_of_transactions` integer, nullable — Number of transactions that have been attempted for this intent. - `polymorphic_ctype` integer, nullable, required - `agentic_token` string, nullable — A unique customer identifier, identifier is V4 UUID - `paying_bankaccount_token` string, nullable - `tokenizing_subscription` string, nullable — The subscription that is using this intent to tokenize the customer card. ## Response `200` - RetrieveIntent - `id` string, required — Payment intent id unique identifier - `status` string - `amount` number, double, 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 - `type` string, required — Intent type - `account` string, required — Account ID associated with the intent - `custom_fields` object, required — Associated intent's custom fields if exists - `billing_data` object, required — Customer's billing data added during payment - `transaction_provider_fields` object, required — Key value pairs of any additional information needed from the payment provider - `active_transaction` object, required - `transactions_history` object[], required — An array of all transactions history associated with the intent - `flow` string, required — Associated flow id if provided while creating the intent - `flow_data` object, required - `is_live` true | false — * `True` - Yes * `False` - No - `created` string, required — Intent creation date - `template` unknown - `merchant_reference` string, nullable - `customer` object, required - `state` string, required — Intent SDK state - `state_details` object, required — Intent SDK state details - `customer_last_used_payment_method` string, nullable, required - `last_used_method` string, nullable, required - `payment_status` object, required ## Other responses - `400` - `401` --- [API](https://skmtc.net/moneyhash/apis/moneyhash-api.md) · [All operations](https://skmtc.net/moneyhash/apis/moneyhash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhash/moneyhash-api/versions/111e4c2e0826/schema)