Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice el siguiente prompt:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siga las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-pay
bunx cap sync

Importar

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

API Resumen

isPayAvailable

Verifica si el pago nativo está disponible en la plataforma actual. En iOS, evalúa Apple Pay, mientras que en Android evalúa Google Pay.

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

const result = await Pay.isPayAvailable();
console.log(result);

requestPayment

Presenta la hoja de pago nativa para la plataforma actual. Proporciona la configuración de Apple Pay en iOS y la configuración de Google Pay en Android.

Esta promesa es el camino de finalización en ambas plataformas.

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

const result = await Pay.requestPayment({
  apple: {
    merchantIdentifier: 'merchant-identifier-123',
    countryCode: 'US',
    currencyCode: 'USD',
    paymentSummaryItems: [
      {
        label: 'Hello from Capacitor',
        amount: 'amount',
      },
    ],
    supportedNetworks: ['AmEx'],
  },
});
// The result holds sensitive values: use it without logging it.

Referencia de tipo

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;
}

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola y API operaciones, conecta con Usando @capgo/capacitor-pay para la capacidad nativa en Usando @capgo/capacitor-pay, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.