Interface CheckoutSession

Checkout session response as defined in the Wave API

Hierarchy

  • CheckoutSession

Properties

aggregated_merchant_id? amount business_name checkout_status client_reference? currency error_url id last_payment_error? payment_status restrict_payer_mobile? success_url transaction_id? wave_launch_url when_completed? when_created when_expires

Properties

Optional aggregated_merchant_id

aggregated_merchant_id?: string

ID for the aggregated merchant, if applicable

amount

amount: string

Total amount to collect from the customer (gross of fees)

business_name

business_name: string

The name of the business as shown to the customer

checkout_status

checkout_status: CheckoutSessionStatus

Status of the checkout: open, complete, or expired

Optional client_reference

client_reference?: null | string

A unique string that you provide which can be used to correlate the checkout

currency

currency: Currency

Currency for the amount

error_url

error_url: string

URL to redirect to if there's an error

id

id: string

Unique identifier for the checkout session

Optional last_payment_error

last_payment_error?: null | LastPaymentError

The reason for the last failed payment attempt

payment_status

payment_status: PaymentStatus

Status of the associated payment

Optional restrict_payer_mobile

restrict_payer_mobile?: string

This checkout session can only be paid by the Wave account with this number

success_url

success_url: string

URL to redirect to after successful payment

Optional transaction_id

transaction_id?: string

A Wave transaction ID that is also visible in the user's app

wave_launch_url

wave_launch_url: string

URL which will open the Wave app to initiate the checkout

Optional when_completed

when_completed?: string

UTC time at which the checkout session was completed or expired (not populated for open sessions)

when_created

when_created: string

UTC time that the checkout session was created

when_expires

when_expires: string

UTC time at which the checkout session will expire

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc