PaymentRequestCreateRequest
Payload for creating a new payment request
Specifies how the payer is expected to complete the payment request
Possible values: [PAYMENT_LINK, HOSTED_PAGE]
Client-provided identifier for idempotency or external tracking
Possible values: <= 255 characters
REQ-123456Unique identifier of an existing payer. Provide either payerId or payer, but not both.
3fa85f64-5717-4562-b3fc-2c963f66afa6payer object
Inline payer details to create a new payer along with the payment request.
Provide either payer or payerId, but not both.
External ID of the payer
Possible values: <= 36 characters
EX123The type of the payer
Possible values: [INDIVIDUAL, BUSINESS]
Full legal name of the payer
Possible values: <= 255 characters
Email address of the payer
Possible values: <= 255 characters
Required if payer is crypto enabled
Possible values: <= 255 characters
Country of the payer
Possible values: non-empty
Enable to send transaction-update emails to this payer
Required if payer is crypto enabled
Possible values: <= 255 characters
Required if payer is crypto enabled and type INDIVIDUAL
Possible values: <= 255 characters
Required if payer is crypto enabled and type BUSINESS
Possible values: <= 255 characters
Required if payer is crypto enabled and type BUSINESS
Possible values: <= 255 characters
Required if payer is crypto enabled and type INDIVIDUAL
Required if payer is crypto enabled and type INDIVIDUAL
Possible values: <= 255 characters
Required if payer is crypto enabled and type BUSINESS
Possible values: [GENERAL_TRADING, MEDICAL_SUPPLIES, AUTO_SPARE_PARTS, RECRUITMENT, TEXTILES, MACHINERY_PARTS, ADVISORY_FIRM, CONSULTANCY, HEALTHCARE_AND_DENTISTRY, FOODSTUFF, HOTEL_SUPPLIES, SHIPPING_AND_TRANSPORT, MEAT, PERFUMES_TRADING, WHOLESALERS, PET_SUPPLIES_AND_FOODS, AGRICULTURE_SUPPLIES, FLOWER_SHOPS, RAW_MATERIALS, INFORMATION_TECHNOLOGY, CHOCOLATE_AND_SWEETS, MARINE_SUPPLIES, EDUCATION, ELECTRICAL_TRADING, ACCOUNTING_TAXATION_PAYROLL_SERVICES, ADULT_ENTERTAINMENT_AND_OR_PORNOGRAPHY, ADVERTISING_MARKETING_AND_PR, ADVOCACY_ORGANIZATIONS, AEROSPACE_AND_DEFENSE, AGRICULTURE, AIRCRAFT_MANUFACTURER_AND_SPARE_PARTS, AIRLINES, AIR_CARGO, AIRPORT_HARBOR_AND_TERMINAL_OPERATIONS, ALCOHOLIC_BEVERAGES, ALTERNATIVE_ENERGY_SOURCES, AMUSEMENT_PARKS_AND_ATTRACTIONS, ANIMAL_TRADING, APPAREL_AND_ACCESSORIES_RETAILERS_AND_WHOLESALERS, ARCHITECTURE_ENGINEERING_AND_DESIGN, ARMS_MANUFACTURERS_AND_DEALERS, AUCTION_SERVICES, AUDIO_VIDEO_AND_PHOTOGRAPHY, AUTOMOBILE_DEALERS_NEW_VEHICLES, AUTOMOBILE_PARTS_WHOLESALERS, AUTOMOTIVE_REPAIR_AND_MAINTENANCE, BANKING_AND_FINANCIAL_SERVICES, BEAUTY_SUPPLIES_AND_COSMETICS, BIOTECHNOLOGY, BLOOD_ORGANS_BODY_PARTS, BOAT_AND_YACHT_DEALERS, BUILDING_MATERIALS_CONCRETE_AND_GLASS, CABLE_AND_TELEVISION_PROVIDERS, CALL_CENTERS, CAR_WASH_SERVICES, CASINOS_GAMBLING_WAGERING_INSTITUTIONS_AND_ONLINE_GAMBLING, CHEMICALS_PETROCHEMICALS_AND_PETROLEUM_PRODUCTS, CLOTHING_AND_SHOE_STORES, COLLEGES_AND_UNIVERSITIES, COMPUTER_AND_ELECTRONICS, COMMERCIAL_BROKERS, COMPANY_SERVICE_PROVIDERS, CONSTRUCTION_AND_REMODELING, CONSTRUCTION_EQUIPMENT_AND_SUPPLIES, CONSULTING_SERVICES, COUNTERFEIT_PIRATED_GOODS, CROWDFUNDING, CRUISE_SHIP_OPERATIONS, CRYPTO_CURRENCY_VIRTUAL_ASSETS_NFT, CYBER_LOCKERS, DATA_ANALYTICS_AND_MANAGEMENT, DATA_AND_RECORDS_MANAGEMENT, DATING_AGENCIES, DEBT_COLLECTION_SERVICES, DEPARTMENTAL_AND_GROCERY_STORES, DIAGNOSTIC_LABORATORIES, DIAMOND_GOLD_JEWELRY_PRECIOUS_METAL_AND_STONES_DEALERS, DOCTORS_AND_HEALTH_CARE_PRACTITIONERS, DRY_CLEANERS_AND_LAUNDRIES, E_COMMERCE_AND_INTERNET_BUSINESS, EDUCATION_SERVICES, EMBASSIES_DIPLOMATIC_MISSIONS_AND_CONSULATE, EXCHANGE_HOUSE, FACILITIES_MANAGEMENT_AND_MAINTENANCE, FISHING_HUNTING_AND_FORESTRY_AND_LOGGING, FOLLOWER_AND_LIKE_FARMS, FOOD_AND_BEVERAGE_SUPPLIERS, FOOD_AND_DAIRY_PRODUCT_MANUFACTURING_AND_PACKAGING, FLAVORS_AND_FRAGRANCES, FREIGHT_HAULING_RAIL_AND_TRUCK, FUNERAL_HOMES_AND_SERVICES, FURNITURE_STORES_AND_MANUFACTURING, GAMING, GIFT_CARDS, GENERAL_TRADING_OR_GOODS_WHOLESALERS, GOVERNMENT_ORGANIZATIONS, HACKING_MATERIALS, HAIRDRESSERS_BARBER_SHOPS_AND_SALONS, HARDWARE_AND_BUILDING_MATERIAL_DEALERS, HEALTHCARE_AND_HOSPITALS, HEAVY_EQUIPMENT_AND_MACHINERY_SPARE_PARTS_TRADING, HOTELS, HR_AND_RECRUITING_SERVICES, INTERNATIONAL_BODIES_AND_ORGANIZATIONS, INTERNET_PUBLISHING, INVESTMENT, IT_AND_NETWORK_SERVICES_AND_SUPPORT, LAUNDRY_AND_DRY_CLEANING, LAW_FIRMS_AND_LEGAL_SERVICES, LENDING_AND_MORTGAGES, LEASING_AIRCRAFTS, LIBRARIES_ARCHIVES_AND_MUSEUMS, LITIGATION_FINANCE_COMPANIES, MACHINERY_AND_EQUIPMENT, MARIJUANA_CANNABIS_INDUSTRY_AND_OTHER_RECREATIONAL_DRUG_INDUSTRIES, MARINE_AND_INLAND_SHIPPING_AND_CARGO, MARINE_EQUIPMENT_TRADING, MASSAGE_PARLOURS, MEAT_TRADERS, MEDIA_AND_ENTERTAINMENT, MEDICAL_DEVICES_AND_EQUIPMENT_MANUFACTURERS_AND_SUPPLIERS, METAL_AND_MINERAL_WHOLESALERS, MINING_AND_QUARRYING, MONEY_BROKERS, MONEY_SERVICES_BUSINESS_PAYMENT_SERVICES_PROVIDERS, MOTION_PICTURE_AND_RECORDING_PRODUCERS, MOVING_COMPANIES_AND_SERVICES, MULTI_LEVEL_MARKETING_OR_PYRAMID_SCHEMES, NAIL_SALONS, NETWORK_EQUIPMENT_AND_SECURITY_PRODUCTS, NEWSPAPER_BOOKS_AND_PERIODICALS_PUBLISHERS, NIGHT_CLUBS, NON_GOVERNMENT_ORGANIZATIONS_CHARITIES_OR_TRUSTS, OFFICE_EQUIPMENT_AND_SUPPLIERS_AND_WHOLESALERS, OIL_AND_GAS, OIL_AND_GAS_MACHINERY_AND_EQUIPMENT, PAPER_AND_PAPER_PRODUCTS, PARKING_LOTS_AND_GARAGE_MANAGEMENT, PAWN_BROKERS_AND_SHOPS, PAYDAY_LOAN_COMPANIES, PENSION_FUNDS, PHARMACEUTICALS, PLASTIC_WHOLESALER, PLASTICS_AND_RUBBER_MANUFACTURING, POSTAL_EXPRESS_DELIVERY_AND_COURIERS, PRECISION_INSTRUMENTS_AND_CONTROLS, PRIVATE_SECURITY_FIRMS_AND_PRIVATE_MILITARY_CONTRACTORS, PROLIFERATION_OF_WEAPONS_OF_MASS_DESTRUCTION, PROPERTY_LEASING_AND_MANAGEMENT, PROSTITUTION_MODEL_AGENCIES_ESCORT, PROVIDERS_OF_PRIVATE_ONLINE_LOTTERY_MAIL_ORDER_LOTTERIES_AND_SWEEPSTAKES, RADIO_AND_TELEVISION_BROADCASTING, REAL_ESTATE_AGENTS_AND_APPRAISERS, REAL_ESTATE_CONSTRUCTION_AND_DEVELOPERS, RELIGIOUS_ORGANIZATIONS_AND_PLACES_OF_WORSHIP, RENTAL_CARS, RESIDENTIAL_AND_LONG_TERM_CARE_FACILITIES, RESTAURANTS_AND_BARS, SAUNA_HAMMAM_OR_BATH_HOUSES, SCRAP_METAL, SCUBA_DIVING_EQUIPMENT, SECURITIES_AND_COMMODITY_EXCHANGES, SECURITIES_AGENTS_AND_BROKERS, SEMICONDUCTOR_AND_MICROCHIP_MANUFACTURING, SEWAGE_TREATMENT_FACILITIES, SHELL_BANKS, SMOKING_CLUBS, SOCIAL_AND_MEMBERSHIP_ORGANIZATIONS, SOCIAL_MEDIA, SOFTWARE_SERVICES, SPORTS_GAMBLING, SPORTS_ARTS_AND_RECREATION, TATTOO_SHOPS, TAXI_BUSES_AND_TRANSIT_SYSTEMS, TECHNICAL_AND_TRADE_SCHOOLS, TELECOMMUNICATIONS_EQUIPMENT_AND_ACCESSORIES, TELEPHONE_SERVICE_PROVIDERS_AND_CARRIERS, TEXTILES_APPAREL_AND_ACCESSORIES, TOBACCO_VAPE_E_CIGARETTES_CONTROLLED_PRODUCTS, TOOLS_AND_HARDWARE, TRADE_GROUPS_AND_LABOR_UNIONS, TRADING_FOR_RETAIL_CUSTOMERS, TRAVEL_AGENTS_AND_SERVICES, TRAVEL_TOURISM_RECREATIONS_AND_LEISURE, TRUST_FIDUCIARY_AND_CUSTODIAN_ACTIVITIES, UNAUTHORISED_TICKET_SELLERS, UNLAWFUL_INTERNET_GAMBLING, USED_AUTOMOBILE_DEALERS_AND_SELLERS_OF_USED_CAR_PARTS, VETERINARY_CLINICS_AND_SERVICES, VIDEO_AND_LIVE_STREAMING, VIDEO_AND_TELECONFERENCING, WAREHOUSING_AND_STORAGE, WASTE_MANAGEMENT_AND_RECYCLING, WATER_TREATMENT_AND_UTILITIES, OTHER]
Required if payer is crypto enabled and type BUSINESS
Possible values: <= 255 characters
Set to true to allow this payer to make cryptocurrency payments
ISO 4217 or crypto currency code for settlement
Possible values: <= 5 characters, Value must match regular expression [A-Z]{3,5}
AEDAmount expected to be received
99.99Optional due date for the payment to be completed
2025-06-30Document reference such as an invoice or PO number
Possible values: <= 255 characters
INV-2025-001UUID of the uploaded document associated with this payment request. May be required based on merchant configuration and selected payment method(s).
123e4567-e89b-12d3-a456-426614174000List of accepted payment methods for the payer
Possible values: [CARD, BANK_TRANSFER, CRYPTO], >= 1
["CARD","CRYPTO"]URL to redirect the payer when they have successfully completed their payment journey.
Important: This redirect does NOT confirm that funds have been received. For asynchronous payment methods like bank transfers, the payer may have successfully submitted payment instructions, but funds may not yet be received by Hubpay.
Always verify payment status via webhooks or API lookup before fulfilling orders or providing services.
Hubpay will append paymentRequestId and paymentId as query parameters to this URL
during the redirect flow only.
Possible values: <= 255 characters
https://example.com/successURL to redirect the user after payment cancellation
Possible values: <= 255 characters
https://example.com/cancelWhen true, the payment link will be automatically sent to the payer's email address upon creation.
falsepayoutDetails object
Details for payout to a beneficiary. If this is provided then evey payment made against this request will be paid out to the provided beneficiary. Omit this object to have funds settled to your Hubpay wallet.
Unique identifier of the payout beneficiary
Reference for the payout, such as an invoice number or transaction ID
Possible values: <= 255 characters
Purpose of the payout, indicating the reason for the payment to the beneficiary
Possible values: [COMPUTER_SERVICES, FAMILY_SUPPORT, EDUCATION, MEDICAL_TREATMENT, MAINTENANCE_EXPENSES, TRAVEL, SMALL_VALUE_REMITTANCE, CONSTRUCTION_EXPENSES, HOTEL_ACCOMMODATION, ADVERTISING_EXPENSES, ADVISORY_FEES, BUSINESS_INSURANCE, INSURANCE_CLAIMS, DELIVERY_FEES, EXPORTED_GOODS, SERVICE_CHARGES, LOAN_PAYMENT, OFFICE_EXPENSES, PROPERTY_PURCHASE, PROPERTY_RENTAL, ROYALTY_FEES, SHARES_INVESTMENT, FUND_INVESTMENT, TAX_PAYMENT, TRANSPORTATION_FEES, UTILITY_BILLS, PERSONAL_TRANSFER, SALARY_PAYMENT, INFLUENCER_PAYMENT, DIVIDEND_PAYMENT, REWARD_PAYMENT, OTHER_FEES, OTHER]
{
"executionMode": "PAYMENT_LINK",
"externalId": "REQ-123456",
"payerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payer": {
"externalId": "EX123",
"type": "INDIVIDUAL",
"fullLegalName": "string",
"emailAddress": "string",
"phoneNumber": "string",
"country": "string",
"notificationEnabled": true,
"address": "string",
"areaOrCity": "string",
"provinceOrState": "string",
"postalCode": "string",
"dateOfBirth": "2024-07-29",
"occupation": "string",
"primaryIndustry": "GENERAL_TRADING",
"registrationNumber": "string",
"cryptoEnabled": true
},
"currency": "AED",
"amount": 99.99,
"dueDate": "2025-06-30",
"documentReference": "INV-2025-001",
"documentId": "123e4567-e89b-12d3-a456-426614174000",
"paymentMethods": [
"CARD",
"CRYPTO"
],
"successRedirectUrl": "https://example.com/success",
"cancelRedirectUrl": "https://example.com/cancel",
"autoSendPaymentLink": false,
"payoutDetails": {
"payoutBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"payoutReference": "string",
"payoutPurposeOfPayment": "COMPUTER_SERVICES"
}
}