`IOrderPaymentResponse`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IOrderPaymentResponse

Read link and link_type together. An empty link with null type is valid for methods without an external payment page.

interfaces/orionplace/orders/IOrderActions.ts

TypeScript

export interface IOrderPaymentResponse {
  // Field/general errors.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message or null.
  success_message: string | null;
  // Read `link` and `link_type` together. An empty link with null type is valid
  // for methods without an external payment page.
  page_data: {
    // Provider payment URL, or an empty string when no external payment page is
    // needed.
    link: string;
    // `EPaymentLinkType.IFRAME` or `EPaymentLinkType.REDIRECT` for a provider
    // link; otherwise null. The application decides how to open the link.
    link_type: EPaymentLinkType | null;
  } | null;
}