PaymentSessionResult

Enriched response payload shared by /pay/ and /verify/. Legacy flat fields (order_number, verification_url, error, retry_allowed) are preserved for backward compatibility.

  • adapter
    Type: object · AdapterSummary
    • name
      Type: string | null
  • amount
    Type: string | null

    Fixed 2-decimal string, e.g. "79.00"

  • created_at
    Type: string | nullFormat: date-time

    Transaction creation timestamp (UTC, ISO-8601)

  • currency
    Type: string | null

    ISO 4217 currency code

  • error
    Type: string | null

    Legacy human-readable decline message. Prefer error_details.

  • error_details
    Type: object | null · ErrorDetails

    Populated only for declined/failed outcomes

    • code
      Type: stringenum
      values
      • insufficient_funds
      • invalid_iban
      • mandate_rejected
      • account_closed
      • do_not_honor
      • gateway_unavailable
      • unknown
    • gateway_code
      Type: string | null

      Raw adapter error code, preserved for debugging

    • gateway_message
      Type: string | null

      Raw adapter error message

    • message
      Type: string
  • lead
    Type: object | null · LeadSummary
    • id
      Type: stringFormat: uuid
  • livemode
    Type: boolean

    True in production, false in non-production environments

  • object
    Type: string

    Resource type discriminator

  • order
    Type: object | null · OrderSummary
    • id
      Type: stringFormat: uuid
    • order_number
      Type: string
    • status
      Type: string
  • order_number
    Type: string | null

    Legacy. Prefer order.order_number.

  • payment_gateway
    Type: object | null · PaymentGatewaySummary
    • descriptor
      Type: string | null
    • id
      Type: stringFormat: uuid
    • name
      Type: string
    • test_mode
      Type: boolean

      True when the MID is configured against the sandbox endpoint

  • payment_method
    Type: object · PaymentMethodSummary
    • bank_name
      Type: string | null
    • bic
      Type: string | null
    • holder_name
      Type: string | null
    • iban_country
      Type: string | null
    • iban_last4
      Type: string | null
    • type
      Type: string
  • processed_at
    Type: string | nullFormat: date-time

    When the gateway processed the transaction

  • retry_allowed
    Type: boolean | null

    Whether the customer can submit another payment attempt

  • sepa
    Type: object · SepaDetails
    • creditor_identifier
      Type: string | null
    • mandate_reference
      Type: string | null
    • sequence_type
      Type: string | nullenum

      FRST for first/one-off, RCUR for recurring rebills

      values
      • FRST
      • RCUR
      • null
  • session_token
    Type: string
  • status
    Type: stringenum
    values
    • completed
    • awaiting_verification
    • declined
    • failed
  • subscription
    Type: object | null · SubscriptionSummary

    Null for one-off purchases

    • billing_frequency
      Type: string | null
    • id
      Type: stringFormat: uuid
    • next_billing_date
      Type: string | nullFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • status
      Type: string
  • transaction
    Type: object | null · TransactionSummary
    • gateway_reference
      Type: string | null

      Gateway-assigned tracking ID; null until received

    • id
      Type: stringFormat: uuid
    • merchant_transaction_id
      Type: string
    • status
      Type: string
    • tenant_reference_id
      Type: string | null

      Merchant-owned reconciliation reference supplied at payment submission. Null when no reference was provided.

    • type
      Type: string

      Internal transaction type (e.g. sdd_sale, sdd_rebill)

  • verification_url
    Type: string | null

    Mandate verification URL (only when status is awaiting_verification)