CreateCheckoutSessionRequest

  • amount
    Type: string Pattern: ^\d+(\.\d+)?$
    required

    Payment amount as a decimal string. Must be >= 1.

  • currency
    enum
    const:  
    EUR
    required
    values
    • EUR
  • customer
    Type: object · Customer
    required

    Customer associated with the checkout session. id is required. Other fields are optional values that checkout can use when present or collect when missing.

    • id
      Type: string
      min length:  
      3
      max length:  
      255
      required

      Your customer identifier

    • dateOfBirth
      Type: stringFormat: date nullable

      Optional value. Checkout can collect this when required by the selected method.

    • email
      Type: stringFormat: email nullable

      Optional value. Checkout can collect this when required by the selected method.

    • firstName
      Type: string nullable

      Optional value. Checkout can collect this when required by the selected method.

    • ip
      Type: string nullable

      Customer IP address

    • lastName
      Type: string nullable

      Optional value. Checkout can collect this when required by the selected method.

    • nationality
      Type: string Pattern: ^[A-Z]{2}$ nullable

      Optional ISO 3166-1 alpha-2 value. Checkout can collect this when required by the selected method.

    • phone
      Type: string nullable

      Optional value in E.164 format. Checkout can collect this when required by the selected method. MB WAY can also use this value.

  • paymentMethod
    required

    Single payment method for hosted checkout. Payer-facing fields can be supplied up front. Method-specific fields must be sent when required by the selected method.

    Single payment method for hosted checkout. Payer-facing fields can be supplied up front. Method-specific fields must be sent when required by the selected method.

    • id
      Discriminator
      enum
      const:  
      mbway-eupago
      required
      values
      • mbway-eupago
    • phone
      Type: string Pattern: ^\+3519\d{8}$ nullable

      Optional prefill. Portuguese MB WAY phone in E.164 format.

  • reference
    Type: string
    min length:  
    1
    max length:  
    48
    required

    Your unique order/transaction ID. Used for idempotency.

  • returnLinks
    Type: object · ReturnLinks
    required
    • default
      Type: string
      max length:  
      2048      Format: uri
      required

      Default return URL (used for success if not specified separately)

    • cancel
      Type: string
      max length:  
      2048      Format: uri

      URL to redirect when customer cancels the payment. Must differ from default when present.

  • merchant
    Type: object · CheckoutMerchant

    Payer-facing merchant data shown on the hosted checkout page.

    • name
      Type: string
      max length:  
      140       nullable

      Merchant name shown to the payer.