Hosted Checkout

The Hosted Checkout integration method is ideal when you want a solution that is both secure and fast to deploy. In this integration, you create a checkout session where the Prahsys Gateway hosts a payment page UI that gathers payment information from the customer, so you need not handle sensitive data at all.


POST/merchant/{merchantId}/session

Initiate Checkout

Request to initiate a Hosted Checkout interaction, i.e. a Hosted Payment Page or Embedded Page interaction that allows the payer to select their payment details and make the payment.

Request Parameters

Required Properties for a simple request.

  • Name
    apiOperation
    Type
    string Required
    Description
    INITIATE_CHECKOUT
  • Name
    interaction
    Type
    object Required
    Description
    Information that controls the payer's checkout interaction.
  • Name
    order
    Type
    object Required
    Description
    Information about the order associated with this transaction.

Response Parameters

Required Properties for a simple request.

  • Name
    checkoutMode
    Type
    enum
    Description
    Defines how the Hosted Checkout interaction can be launched.
    Enum Options:
    WEBSITE
  • Name
    merchant
    Type
    string
    Description
    The unique identifier issued to you by your payment provider.
  • Name
    result
    Type
    enum
    Description
    A system-generated high level overall result of the operation.
    Enum Options:
    FAILUREPENDINGSUCCESSUNKNOWN
  • Name
    successIndicator
    Type
    string
    Description
    An identifier to determine the success of the hosted payment.