WeChat Pay API

GeneXus 用の WeChat Pay API は、外部オブジェクトと、プロシージャー、SDT、ドメインのグループで構成されています。作成済みのアプリケーションで WeChat Pay を使用する場合に、WeChat Pay 拡張ライブラリとやり取りして決済機能と連携します。Android および iOS に対応します。

バージョン

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

構造

外部オブジェクト

WeChatPayProvider

メソッド

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

プロパティ

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

イベント

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

ドメイン

Environment (CommonPay)

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

値	説明
Production	本番環境です。実際にトランザクションが行われます。
Sandbox	テスト環境です。

ReturnCode (WeChatPay)

非同期の通知サービスに応じて WeChat Pay に送信する値を返します。

値	説明
Success	成功
Fail	失敗

構造化データタイプ

Configuration (CommonPay)

決済トランザクションの実行に必要なすべての設定に使用されます。

フィールド		ドメイン	説明
AppId		VarChar(40)	アプリケーションを WeChat Open Platform サイトに登録した際に取得するアプリケーション ID
Environment		Environment	決済トランザクションを実行する環境
CertificateFilename		VarChar(200)	WeChat Pay では使用しない
CertificatePassword		VarChar(40)	WeChat Pay では使用しない
CallbackURL		URL	決済通知サービスの URL
Timeout		Numeric(4.0)	決済トランザクションのタイムアウト (分単位)
MerchantId		VarChar(40)	WeChat Open Platform に登録したユーザー ID
MerchantKey		VarChar(80)	WeChat Open Platform のアプリケーションに割り当てられたキー
AdditionalConfig		<コレクション>	アプリケーション設定のその他の情報
	名前	VarChar(40)	その他の情報の名前
	Value	VarChar(200)	その他の情報の値

PaymentResult (CommonPay)

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

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

PaymentApplicationData (WeChatPay)

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

フィールド	ドメイン	説明
ProductCode	Character(128)	決済に含まれる 1 つまたは複数の製品のコード
ProductDescription	VarChar(200)	決済の対象となる 1 つ以上の製品の説明
Currency	Character(3)	決済トランザクションで使用する通貨
TotalAmount	Amount	決済トランザクションの金額
RandomString	Character(32)	ユーザーは設定不可。WeChat Pay の通信で使用されるランダムな値
OrderNumber	Character(64)	ユーザーは設定不可。決済トランザクションのオーダー番号

PaymentInfoParameters (WeChatPay)

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

フィールド	ドメイン	説明
AppId	Character(32)	アプリケーションを Alipay の開発者サイトに登録した際に取得するアプリケーション ID
MerchantId	Character(32)	WeChat Open Platform に登録したユーザー ID
MerchantKey	Character(64)	WeChat Open Platform のアプリケーションに割り当てられたキー
DeviceId	Character(32)	トランザクションを行うデバイスの ID (ClientInformation.Id の値を使用)
RandomString	Character(32)	WeChat Pay の通信で使用されるランダムな値
Signature	Character(32)	トランザクションパラメーターの署名
SignatureType	SignatureType	固定値: HMACSHA256
ProductDescription	Character(128)	決済の対象となる 1 つ以上の製品の説明
OrderNumber	Character(32)	決済トランザクションのオーダー番号
Currency	Character(3)	決済トランザクションで使用する通貨
TotalAmount	Numeric(9.0)	決済トランザクションの金額
TransactionStartTime	Character(14)	トランザクションの開始時間
NotificationAddress	Character(256)	決済通知サービスの URL
TransactionType	Character(16)	固定値: APP
PrepayId	Character(32)	決済の実行前に WeChat Pay サーバーから返されるトランザクション ID
Timestamp	Character(20)	決済準備時の現在時間
Package	Character(128)	固定値: Sign=WXPay

PaymentInformation (WeChatPay)

決済の実行時に WeChat Pay に送信される GetPaymentInformation プロシージャーから返される情報です。

フィールド	ドメイン	説明
ErrorCode	Numeric(10.0)	GetPaymentInformation プロシージャーから返されるエラーコード
ErrorDescription	Character(128)	GetPaymentInformation プロシージャーから返されるエラーの説明
AppId	Character(32)	アプリケーションを Alipay の開発者サイトに登録した際に取得するアプリケーション ID
MerchantId	Character(32)	WeChat Open Platform に登録したユーザー ID
OrderNumber	Character(32)	決済トランザクションのオーダー番号
DeviceId	Character(32)	トランザクションを行うデバイスの ID (ClientInformation.Id の値を使用)
RandomString	Character(32)	WeChat Pay の通信で使用されるランダムな値
Signature	Character(32)	トランザクションパラメーターの署名
SignatureParameters	LongVarChar(2M)	署名済みの WeChat Pay に送信されるパラメーター
TransactionType	Character(16)	固定値: APP
PrepayId	Character(64)	決済の実行前に WeChat Pay サーバーから返されるトランザクション ID
Timestamp	Character(20)	決済準備時の現在時間
Package	Character(20)	固定値: Sign=WXPay
ReturnCode	Character(20)	決済情報の送信時に WeChat Pay のサーバーから返されるコード
ReturnMessage	Character(20)	決済情報の送信時に WeChat Pay のサーバーから返されるメッセージ
BusinessResult	Character(16)	決済情報の送信時に WeChat Pay のサーバーから返されるその他の情報

PaymentNotificationInfo (WeChatPay)

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

フィールド	ドメイン	説明
AppId	DateTime
PaymentBank	Character(64)
CashPaymentAmount	Character(128)
DeviceId	Character(32)
CurrencyType	Character(10)
IsSuscriber	Character(3)
MerchantId	Character(10)
RandomString	Character(256)
UserTag	Character(64)
MerchantTradeNumber	Character(64)
ResultCode	Character(64)
BusinessResult	Character(16)
Signature	Character(100)
PaymentEndTime	Character(30)
TransactionType	Email
TransactionId	TradeStatus
TotalAmount	Amount

PaymentNotificationResult (WeChatPay)

非同期の決済通知サービスが呼び出された場合に、結果を WeChat Pay に返すのに使用される情報。このタイプの変数は CallbackHandler プロシージャーで返されます。

フィールド	ドメイン	説明
ReturnCode	ReturnCode
ReturnMessage	VarChar(100)

SandboxPaymentInfo (WeChatPay)

Sandbox 環境を使用しているときに WeChat Pay サーバーに返される情報。この情報は次に GetPaymentInformation プロシージャーから返される PaymentInformation 変数に設定されます。

フィールド	ドメイン	説明
AppId	Character(32)	アプリケーションを Alipay の開発者サイトに登録した際に取得するアプリケーション ID
MerchantId	Character(32)	WeChat Open Platform に登録したユーザー ID
RandomString	Character(32)	WeChat Pay の通信で使用されるランダムな値
Signature	Character(32)	トランザクションパラメーターの署名
PrepayId	Character(64)	決済の実行前に WeChat Pay サーバーから返されるトランザクション ID
Timestamp	Character(20)	決済準備時の現在時間
Package	Character(20)	固定値: Sign=WXPay

Procedures

LoadConfig (CommonPay)

WeChat Pay の決済の実施に必要な設定をロードします。既定では、WeChatPay_Config.xml ファイルから情報を読み込みます。

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

GetPaymentInformation (WeChatPay)

ユーザーが提供した決済データを処理して、WeChat Pay への送信の準備に必要なすべての情報 (署名済み) を返します。

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

OnAboutToPay (WeChatPay)

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

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

CallbackService (WeChatPay)

HTTP プロシージャーです。決済処理の完了後に WeChat Pay サーバーによって呼び出された非同期の決済通知サービスです。HTTP 情報を SDT (PaymentNotificationInfo) に変換して CallbackHandler プロシージャーを呼び出します。

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

CallbackHandler (Alipay)

非同期の決済通知サービスを呼び出す際に WeChat Pay サーバーによって送信されたデータの処理に使用します。

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