Alipay API

Alipay API for GeneXus は、外部オブジェクトとプロシージャー、SDT、ドメインのグループで構成されています。これらを組み合わせて Alipay の拡張ライブラリを操作し、生成した Android と iOS アプリケーションに Alipay の決済機能を組み込むことができます。

バージョン

バージョン 1.0 (2017 年 12 月 11 日) - ダウンロード

構造

外部オブジェクト

AlipayProvider

メソッド

名前	Pay
説明	Alipay で決済トランザクションを実行するために使用します。
パラメーター	PaymentInformation: SDT(PaymentInformation)
戻り値	なし

プロパティ

名前	説明
ErrorCode	Pay メソッドの結果のエラーコード
ErrorDescription	Pay メソッドの結果のエラーの説明

イベント

名前	OnPaymentFinished
説明	Alipay での決済トランザクションが完了したときにトリガーされます。
パラメーター	PaymentResult: SDT(PaymentResult)
戻り値	なし

ドメイン

Environment (CommonPay)

決済トランザクションを実行する環境です。

値	説明
Production	本番環境です。実際にトランザクションが行われます。
Sandbox	テスト環境です。Android アプリケーションにのみ使用できます。

TradeStatus (Alipay)

決済通知サービスで受け取るトランザクションステータスです。

値	説明
Closed	TRADE_CLOSED
Finished	TRADE_FINISHED
Success	TRADE_SUCCESS
WaitBuyerPaid	WAIT_BUYER_PAID

FundChannel (Alipay)

トランザクションで使用され、決済通知サービスで受け取る資金チャネルです。

値	説明
AlipayAccount	ALIPAYACCOUNT
BusinessCard	MCARD
Coupon	COUPON
Discount	DISCOUNT
FinanceAccount	FINANCEACCOUNT
MerchantCoupon	MCOUPON
MerchantDiscount	MDISCOUNT
PCredit	PCREDIT
PrepaidCard	PCARD
Point	POINT

VoucherType (Alipay)

トランザクションで使用され、決済通知サービスで受け取るバウチャータイプです。

値	説明
Discount	ALIPAY_DISCOUNT_VOUCHER
Fix	ALIPAY_FIX_VOUCHER
Item	ALIPAY_ITEM_VOUCHER

構造化データタイプ

Configuration (CommonPay)

決済トランザクションの実行に必要なすべての設定をするために使用します。

フィールド		ドメイン	説明
AppId		VarChar(40)	アプリケーションを Alipay の開発者サイトに登録した際に取得するアプリケーション ID
Environment		Environment	決済トランザクションを実行する環境
CertificateFilename		VarChar(200)	決済情報の署名に使用する PFX ファイルの名前。詳細については、こちらを参照してください。
CertificatePassword		VarChar(40)	決済情報の署名に使用する PFX ファイルのパスワード
CallbackURL		URL	決済通知サービスの URL
Timeout		Numeric(4.0)	決済トランザクションのタイムアウト (分単位) です。
MerchantId		VarChar(40)	Alipay には使用しない
MerchantKey		VarChar(80)	Alipay には使用しない
AdditionalConfig		<コレクション>	アプリケーション設定のその他の情報
	Name	VarChar(40)	その他の情報の名前
	Value	VarChar(200)	その他の情報の値

PaymentResult (CommonPay)

AlipayProvider 外部オブジェクトの OnPaymentFinished イベントに送信される情報です。

フィールド	ドメイン	説明
ErrorCode	Numeric(4.0)	決済トランザクションの結果のエラーコード
ErrorDescription	VarChar(200)	決済トランザクションの結果の説明
OrderNumber	VarChar(40)	終了した決済トランザクションのオーダー番号。アプリケーションでの決済処理に使用できます
AdditionalInfo	LongVarChar(2M)	決済トランザクションから返されたその他の情報

PaymentApplicationData (Alipay)

ユーザーが決済データ (製品の説明、金額) を設定するために使用し、GetPaymentInformation プロシージャーに入力として渡されます。

フィールド	ドメイン	説明
ProductCode	Character(20)	決済の対象となる 1 つ以上の製品の説明
TotalAmount	Amount	決済トランザクションの金額
Subject	Character(256)	トランザクションを表す件名
Body	Character(400)	決済トランザクションの詳細
TimeoutExpress	Character(20)	ユーザーは設定不可。決済トランザクションのタイムアウト
NotifyURL	URL	ユーザーは設定不可。通知サービスの URL
OrderNumber	Character(64)	ユーザーは設定不可。決済トランザクションのオーダー番号

PaymentInfoParameters (Alipay)

GetPaymentInformation プロシージャーで使用される構造です。API によって自動的に管理されるため、開発者が決済機能を組み込む際のコーディングで扱う必要はありません。

フィールド	ドメイン	説明
AppId	Character(20)	アプリケーションを Alipay の開発者サイトに登録した際に取得するアプリケーション ID
PaymentData	PaymentApplicationData	ユーザーが入力した決済データ
Charset	Character(20)	固定値: utf-8
Method	URL	固定値: alipay.trade.app.pay
SignType	SignType	固定値: RSA2
Timestamp	DateTime	決済トランザクションのタイムスタンプ
Version	Character(20)	固定値: 1.0
CertificatePath	Character(500)	決済情報の署名に使用する PFX ファイルの名前 PFX を参照する完全なパスを使用
CertificatePassword	Character(20)	決済情報の署名に使用する PFX ファイルのパスワード

PaymentInformation (Alipay)

GetPaymentInformation プロシージャーから返された情報。決済時に Alipay に送信されます。

フィールド	ドメイン	説明
ErrorCode	Numeric(10.0)	GetPaymentInformation プロシージャーから返されるエラーコード
ErrorDescription	Character(200)	GetPaymentInformation プロシージャーから返されるエラーの説明
Parameters	LongVarChar(2M)	Alipay に送信される決済情報パラメーター
Environment	Environment	決済トランザクションを実行する環境
OrderNumber	VarChar(40)	決済トランザクションのオーダー番号

PaymentNotificationInfo (Alipay)

Alipay から非同期決済通知サービスに送信される情報。開発者は、CallbackHandler プロシージャーでこの情報を使用できます。

フィールド	ドメイン	説明
NotifyTime	DateTime
NotifyType	Character(64)
NotifyId	Character(128)
AppId	Character(32)
Charset	Character(10)
Version	Character(3)
SignType	Character(10)
Sign	Character(256)
AlipayTradeNumber	Character(64)
OutTradeNumber	Character(64)
MerchantId	Character(64)
BuyerId	Character(16)
BuyerLogonId	Character(100)
SellerId	Character(30)
SellerEmail	Email
TradeStatus	TradeStatus
TotalAmount	Amount
ReceiptAmount	Amount
InvoiceAmount	Amount
BuyerPayAmount	Amount
PointAmount	Amount
RefundFee	Amount
Subject	Character(256)
Body	Character(400)
CreationDateTime	DateTime
PaymentDateTime	DateTime
RefundDateTime	DateTime
CloseDateTime	DateTime
FundBillList	<コレクション>
Amount	Amount
FundChannel	FundChannel
PassBackParameters	Character(512)
VoucherDetailList	<コレクション>
Name	Character(64)
Type	VoucherType
Amount	Amount
MerchantContribute	Amount
OtherContribute	Amount
Memo	Character(256)

プロシージャー

LoadConfig (CommonPay)

Alipay で決済するために必要な設定をロードします。既定では、Alipay_Config.xml ファイル内の情報が読み取られます。

パラメーター	PaymentProvider: Alipay
戻り値	Configuration:SDT(Configuration)

GetPaymentInformation (Alipay)

ユーザーが入力した決済データを処理し、必要なすべての情報 (署名済みで、Alipay にすぐ送信できる状態のもの) を返します。

パラメーター	PaymentApplicationData: SDT(PaymentApplicationData)
戻り値	PaymentInformation: SDT(PaymentInformation)

OnAboutToPay (Alipay)

Alipay に送信する直前に決済データを処理するために使用します。一般的には、決済情報 (特に OrderNumber) をアプリケーションのデータベーステーブルに保存する際に使用します。

パラメーター	PaymentApplicationData: SDT(PaymentApplicationData)
戻り値	-

CallbackService (Alipay)

HTTP プロシージャーです。決済プロセスの終了後に Alipay サーバーによって呼び出される非同期決済通知サービスです。データを返すものではなく、HTTP 情報を SDT (PaymentNotificationInfo) に変換し、CallbackHandler プロシージャーを呼び出します。

CallbackHandler (Alipay)

非同期決済通知サービスの呼び出し時に Alipay サーバーから送信されたデータを処理するために使用します。

パラメーター	PaymentNotificationInfo: SDT(PaymentNotificationInfo)
戻り値	-