jp.pay.android

クラス Payjp

jp.pay.android.Payjp

すべての実装されたインタフェース:

PayjpTokenService

public class Payjp
implements PayjpTokenService

Entry point for payjp-android

We recommend use as singleton instance.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	Payjp.Companion

インタフェースから継承されたネストされたクラス/インタフェース jp.pay.android.PayjpTokenService

PayjpTokenService.DefaultImpls

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static Payjp.Companion	Companion

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Payjp(PayjpConfiguration configuration) Constructor for configuration.
Payjp(java.lang.String publicKey) Constructor for publicKey

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Task<jp.pay.android.model.Token>	createToken(PayjpTokenParam param) Create token from param
Task<jp.pay.android.model.CardBrandsAcceptedResponse>	getAcceptedBrands(TenantId tenantId) Get accepted brands with tenant id (for platform)
static Payjp	getInstance() Get singleton instance. You must call Payjp#init(String publicKey) or Payjp#init(PayjpConfiguration configuration) that create singleton instance if needed, before use it. You can also manage instance yourself with initialized by constructor.
Task<jp.pay.android.model.Token>	getToken(java.lang.String id) Obtain token from token id.
static void	handleCardFormResult(android.content.Intent data, PayjpCardFormResultCallback callback) Handle the result from the activity which is started by Payjp.startCardForm. Use this at Activity.onActivityResult in the activity that you call Payjp.startCardForm.
static Payjp	init(java.lang.String publicKey) Initialize managed-singleton instance.
static Payjp	init(PayjpConfiguration configuration) Initialize managed-singleton instance.
static void	startCardForm(android.app.Activity activity, java.lang.Integer requestCode, TenantId tenant) Start card form screen from Activity.
static void	startCardForm(android.app.Activity activity, java.lang.Integer requestCode) Start card form screen from Activity.
static void	startCardForm(android.app.Activity activity) Start card form screen from Activity.
static void	startCardForm(androidx.fragment.app.Fragment fragment, java.lang.Integer requestCode, TenantId tenant) Start card form screen from Fragment.
static void	startCardForm(androidx.fragment.app.Fragment fragment, java.lang.Integer requestCode) Start card form screen from Fragment.
static void	startCardForm(androidx.fragment.app.Fragment fragment) Start card form screen from Fragment.

インタフェースから継承されたメソッド jp.pay.android.PayjpTokenService

createToken, createToken, getAcceptedBrands, getAcceptedBrands, getToken

フィールドの詳細

Companion

public static Payjp.Companion Companion

コンストラクタの詳細

Payjp

public Payjp(@NotNull
             PayjpConfiguration configuration)

Constructor for configuration.

パラメータ:

configuration - create with configuration

Payjp

public Payjp(@NotNull
             java.lang.String publicKey)

Constructor for publicKey

パラメータ:

publicKey - PAY.JP public key.

メソッドの詳細

createToken

@NotNull
public Task<jp.pay.android.model.Token> createToken(@NotNull
                                                             PayjpTokenParam param)

Create token from param

パラメータ:

param - param

戻り値:

task to create token.

getToken

@NotNull
public Task<jp.pay.android.model.Token> getToken(@NotNull
                                                          java.lang.String id)

Obtain token from token id.

パラメータ:

id - token id

getAcceptedBrands

@NotNull
public Task<jp.pay.android.model.CardBrandsAcceptedResponse> getAcceptedBrands(@Nullable
                                                                                        TenantId tenantId)

Get accepted brands with tenant id (for platform)

パラメータ:

tenantId - tenant id (only for platformer)

戻り値:

task of accepted brands

getInstance

@JvmStatic
 @NotNull
public static Payjp getInstance()

Get singleton instance. You must call Payjp#init(String publicKey) or Payjp#init(PayjpConfiguration configuration) that create singleton instance if needed, before use it. You can also manage instance yourself with initialized by constructor.

Payjp(PayjpConfiguration)

init

@JvmStatic
 @NotNull
public static Payjp init(@NotNull
                                              java.lang.String publicKey)

Initialize managed-singleton instance.

パラメータ:

publicKey - public API Key. You must NOT use secret key.

init

@JvmStatic
 @NotNull
public static Payjp init(@NotNull
                                              PayjpConfiguration configuration)

Initialize managed-singleton instance.

パラメータ:

configuration - configuration for class Payjp

startCardForm

@JvmStatic
 @JvmOverloads
public static void startCardForm(@NotNull
                                                           android.app.Activity activity,
                                                           @Nullable
                                                           java.lang.Integer requestCode,
                                                           @Nullable
                                                           TenantId tenant)

Start card form screen from Activity.

パラメータ:

activity - activity

requestCode - requestCode. The default is PayjpCardFormActivity.DEFAULT_CARD_FORM_REQUEST_CODE

tenant - tenant (only for platformer)

startCardForm

@JvmStatic
 @JvmOverloads
public static void startCardForm(@NotNull
                                                           android.app.Activity activity,
                                                           @Nullable
                                                           java.lang.Integer requestCode)

Start card form screen from Activity.

パラメータ:

activity - activity

requestCode - requestCode. The default is PayjpCardFormActivity.DEFAULT_CARD_FORM_REQUEST_CODE

startCardForm

@JvmStatic
 @JvmOverloads
public static void startCardForm(@NotNull
                                                           android.app.Activity activity)

Start card form screen from Activity.

パラメータ:

activity - activity

startCardForm

@JvmStatic
 @JvmOverloads
public static void startCardForm(@NotNull
                                                           androidx.fragment.app.Fragment fragment,
                                                           @Nullable
                                                           java.lang.Integer requestCode,
                                                           @Nullable
                                                           TenantId tenant)

Start card form screen from Fragment.

パラメータ:

fragment - fragment

requestCode - requestCode. The default is PayjpCardFormActivity.DEFAULT_CARD_FORM_REQUEST_CODE

tenant - tenant (only for platformer)

startCardForm

@JvmStatic
 @JvmOverloads
public static void startCardForm(@NotNull
                                                           androidx.fragment.app.Fragment fragment,
                                                           @Nullable
                                                           java.lang.Integer requestCode)

Start card form screen from Fragment.

パラメータ:

fragment - fragment

requestCode - requestCode. The default is PayjpCardFormActivity.DEFAULT_CARD_FORM_REQUEST_CODE

startCardForm

@JvmStatic
 @JvmOverloads
public static void startCardForm(@NotNull
                                                           androidx.fragment.app.Fragment fragment)

Start card form screen from Fragment.

パラメータ:

fragment - fragment

handleCardFormResult

@JvmStatic
public static void handleCardFormResult(@Nullable
                                                   android.content.Intent data,
                                                   @NotNull
                                                   PayjpCardFormResultCallback callback)

Handle the result from the activity which is started by Payjp.startCardForm. Use this at Activity.onActivityResult in the activity that you call Payjp.startCardForm.

パラメータ:

data - the intent from Activity.onActivityResult.

callback - you can get card token if it is success.

関連項目:

Payjp.startCardForm, Activity.onActivityResult, Payjp.startCardForm