Create a Hosted Payments Page session and pass through all the payment information, like the amount, currency, country and reference.<\/p>\n\n\n\n bearer<\/em><\/p>\n\n\n\n HTTP Authorization Scheme: <\/strong> Bearer format: <\/strong> Request body for creating a Hosted Payments Page session.<\/p>\n\n\n\nAuthorizations<\/summary>\n
<\/h5>\n\n\n\n
HTTP: bearer<\/h5>\n\n\n\n
bearer<\/code><\/p>\n\n\n\nJWT<\/code><\/p>\n<\/details>\n\n\n\nheader Parameters<\/h5>\n\n\n\n
Authorizationrequired<\/td> stringBearer token (API Key).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Request Body schema: application\/json<\/h5>\n\n\n\n
currencyrequired<\/td> string = 3 characters The three-letter ISO currency code of the payment.<\/td><\/tr> billingrequired<\/td> objectThe billing details.<\/td><\/tr> success_urlrequired<\/td> string <= 255 characters Overrides the default success redirect URL for redirect payment methods.<\/td><\/tr> cancel_urlrequired<\/td> string <= 255 characters The URL to which the customer should be directed if they cancel the payment.<\/td><\/tr> failure_urlrequired<\/td> string <= 255 characters Overrides the default failure redirect URL for redirect payment methods.<\/td><\/tr> amount<\/td> number >= 0 The payment amount. The exact format depends on the currency.<\/td><\/tr> payment_type<\/td> string Default: “Regular” Enum:”Regular””Recurring”This must be specified for card payments where the cardholder is not present.<\/td><\/tr> payment_ip<\/td> string <= 45 characters The customer’s IP address. Only IPv4 and IPv6 addresses are accepted.<\/td><\/tr> billing_descriptor<\/td> objectAn optional description that is displayed on the customer’s statement identifying a purchase.<\/td><\/tr> reference<\/td> string <= 50 characters A reference you can use to identify the payment (max 50 chars, Amex: 30, iDEAL: 35, Benefit: unique alphanumeric).<\/td><\/tr> description<\/td> string <= 100 characters A description of the payment (max 100 chars).<\/td><\/tr> display_name<\/td> stringThe merchant name to display to customers on the checkout page.<\/td><\/tr> processing_channel_id<\/td> string^(pc)_(\\w{26})$The processing channel to be used for the payment.<\/td><\/tr> amount_allocations<\/td> Array of objectsThe sub-entities that the payment is being processed on behalf of.<\/td><\/tr> customer<\/td> objectThe customer’s details.<\/td><\/tr> shipping<\/td> objectThe address any products are being sent to.<\/td><\/tr> recipient<\/td> objectInformation about the recipient of the payment’s funds.<\/td><\/tr> processing<\/td> objectUse the processing object to influence or override the data sent during card processing.<\/td><\/tr> allow_payment_methods<\/td> Array of stringsSpecifies which payment method options to present to the customer.<\/td><\/tr> disabled_payment_methods<\/td> Array of stringsSpecifies which payment method options to not present to the customer.<\/td><\/tr> products<\/td> Array of objectsContains details about the products in the order.<\/td><\/tr> risk<\/td> objectConfigures the risk assessment performed during payment processing.<\/td><\/tr> customer_retry<\/td> objectConfigures the parameters for customer retries.<\/td><\/tr> sender<\/td> objectThe sender of the payment.<\/td><\/tr> metadata<\/td> objectAllows you to store additional information about the transaction. Only one level of depth is allowed.<\/td><\/tr> locale<\/td> string Default: “en-GB”Creates a translated version of the page in the specified language.<\/td><\/tr> 3ds<\/td> objectInformation required for 3D Secure payments.<\/td><\/tr> capture<\/td> booleanWhether to capture the payment (if applicable).<\/td><\/tr> capture_on<\/td> stringA timestamp (ISO 8601 code) that determines when the payment should be captured. Providing this field will automatically set capture to true.<\/td><\/tr> instruction<\/td> objectDetails about the payment instruction.<\/td><\/tr> payment_method_configuration<\/td> objectConfiguration options for specific payment methods.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Responses<\/h5>\n\n\n\n
201 Created Hosted Payments Page<\/summary>\n
Response Schema: application\/json<\/h5>\n\n\n\n