Getting Started

설치

Capgo AI 도구에 필요한 Capgo 기능을 추가하기 위해 다음 명령어를 사용할 수 있습니다.

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

그다음에 다음의 프롬프트를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-pay` plugin in my project.

만약 Manual Setup을 선호한다면, 다음 명령어를 실행하고 아래의 플랫폼에 따라서 지시를 따르세요:

bun add @capgo/capacitor-pay
bunx cap sync

Import

import { Pay } from '@capgo/capacitor-pay';

API 개요

isPayAvailable

현재 플랫폼에서 네이티브 결제가 사용 가능한지 확인합니다. iOS에서는 Apple Pay, Android에서는 Google Pay를 평가합니다.

import { Pay } from '@capgo/capacitor-pay';

await Pay.isPayAvailable();

requestPayment

__CAPGO_KEEP_0__ 섹션

현재 플랫폼의 네이티브 결제 시트를 표시합니다. iOS에서는 Apple Pay 구성, Android에서는 Google Pay 구성을 제공합니다.

import { Pay } from '@capgo/capacitor-pay';

await Pay.requestPayment({} as PayPaymentOptions);

클립보드에 복사

PayAvailabilityOptions

export interface PayAvailabilityOptions {
  apple?: ApplePayAvailabilityOptions;
  google?: GooglePayAvailabilityOptions;
}

PayAvailabilityResult

export interface PayAvailabilityResult {
  available: boolean;
  platform: PayPlatform;
  apple?: ApplePayAvailabilityResult;
  google?: GooglePayAvailabilityResult;
}

PayPaymentOptions

export interface PayPaymentOptions {
  apple?: ApplePayPaymentOptions;
  google?: GooglePayPaymentOptions;
}

PayPaymentResult

export type PayPaymentResult = ApplePayRequestPaymentResult | GooglePayRequestPaymentResult;

ApplePayAvailabilityOptions

export interface ApplePayAvailabilityOptions {
  /**
   * Optional list of payment networks you intend to use.
   * Passing networks determines the return value of `canMakePaymentsUsingNetworks`.
   */
  supportedNetworks?: ApplePayNetwork[];
}

GooglePayAvailabilityOptions

export interface GooglePayAvailabilityOptions {
  /**
   * Environment used to construct the Google Payments client. Defaults to `'test'`.
   */
  environment?: GooglePayEnvironment;
  /**
   * Raw `IsReadyToPayRequest` JSON as defined by the Google Pay API.
   * Supply the card networks and auth methods you intend to support at runtime.
   *
   * @see https://developers.google.com/pay/api/android/reference/request-objects#IsReadyToPayRequest
   */
  isReadyToPayRequest?: GooglePayIsReadyToPayRequest;
}

PayPlatform

export type PayPlatform = 'ios' | 'android' | 'web';

ApplePayAvailabilityResult

export interface ApplePayAvailabilityResult {
  /**
   * Indicates whether the device can make Apple Pay payments in general.
   */
  canMakePayments: boolean;
  /**
   * Indicates whether the device can make Apple Pay payments with the supplied networks.
   */
  canMakePaymentsUsingNetworks: boolean;
}

GooglePayAvailabilityResult

export interface GooglePayAvailabilityResult {
  /**
   * Whether the user is able to provide payment information through the Google Pay payment sheet.
   */
  isReady: boolean;
  /**
   * The current user's ability to pay with one or more of the payment methods specified in `IsReadyToPayRequest.allowedPaymentMethods`.
   *
   * This property only exists if `IsReadyToPayRequest.existingPaymentMethodRequired` was set to `true`. The property value will always be `true` if the request is configured for a test environment.
   */
  paymentMethodPresent: boolean | undefined;
}

ApplePayPaymentOptions

export interface ApplePayPaymentOptions {
  /**
   * Merchant identifier created in the Apple Developer portal.
   */
  merchantIdentifier: string;
  /**
   * Two-letter ISO 3166 country code.
   */
  countryCode: string;
  /**
   * Three-letter ISO 4217 currency code.
   */
  currencyCode: string;
  /**
   * Payment summary items displayed in the Apple Pay sheet.
   */
  paymentSummaryItems: ApplePaySummaryItem[];
  /**
   * Card networks to support.
   */
  supportedNetworks: ApplePayNetwork[];
  /**
   * Merchant payment capabilities. Defaults to ['3DS'] when omitted.
   */
  merchantCapabilities?: ApplePayMerchantCapability[];
  /**
   * Contact fields that must be supplied for shipping.
   */
  requiredShippingContactFields?: ApplePayContactField[];
  /**
   * Contact fields that must be supplied for billing.
   */
  requiredBillingContactFields?: ApplePayContactField[];
  /**
   * Controls the shipping flow presented to the user.
   */
  shippingType?: ApplePayShippingType;
  /**
   * Optional ISO 3166 country codes where the merchant is supported.
   */
  supportedCountries?: string[];
  /**
   * Optional opaque application data passed back in the payment token.
   */
  applicationData?: string;

  /**
   * Recurring payment configuration (iOS 16+).
   */
  recurringPaymentRequest?: ApplePayRecurringPaymentRequest;
}

GooglePayPaymentOptions

export interface GooglePayPaymentOptions {
  /**
   * Environment used to construct the Google Payments client. Defaults to `'test'`.
   */
  environment?: GooglePayEnvironment;
  /**
   * Raw `PaymentDataRequest` JSON as defined by the Google Pay API.
   * Provide transaction details, merchant info, and tokenization parameters.
   *
   * @see https://developers.google.com/pay/api/android/reference/request-objects#PaymentDataRequest
   */
  paymentDataRequest: GooglePayPaymentDataRequest;
}

ApplePayRequestPaymentResult

export interface ApplePayRequestPaymentResult {
  /**
   * Platform that resolved the payment request.
   */
  platform: 'ios';
  /**
   * Apple Pay payment payload.
   */
  apple: ApplePayPaymentResult;
}

Source Of Truth

이 페이지는 플러그인의 src/definitions.ts. upstream의 API가 변경되었을 때 다시 싱크를 실행하세요.

Getting Started에서 계속

이러한 기능을 사용하고 있다면 Getting Started를 사용하여 대시보드와 __CAPGO_KEEP_0__를 계획하고 운영할 수 있습니다. Using @API/__CAPGO_KEEP_1__-pay Using @capgo/capacitor-pay에서 native capability를 구현하는 방법 for the native capability in Using @capgo/capacitor-pay, API Overview에서 구현 세부 사항 for the implementation detail in API Overview, __CAPGO_KEEP_0__ Introduction API Keys API Keys Devices Edit page