跳到主要内容

Payment

payment.get​

決済情報を取得する為の API です。

API の定義​

REST Base URIhttp://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox )
REST HTTP MethodGET
REST URI Fragment``` payment/{userId}/{groupId}/{appId}{-prefix
REST Query ParametersGetPayment-Request-Parameters
Return ObjectPayment

認可​

typepermissiondescription
ANONYMOUSfalse未認証でのアクセス
SECURITY_TOKENfalseセキュリティトークンを用いた認証
OAUTH_MOBILEfalseモバイル用で発行された OAuth Token を用いた認証
OAUTH_CONSUMERtrueConsumer Request を用いた認証

RESTful API レスポンスコード​

HTTP Status CodeHTTP Status MessageJSON-RPC Error CodesMeaning
200OK–データの取得が成功した場合
400Bad Request-32700, -32600, -32601, -32602, 400クライアント側のリクエストデータが不正です
401Unauthorized401認証エラーです
403Forbidden403リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です
404Not Found404存在しないリソースです
405Method Not Allowed405その操作が許可されていない場合です
500Internal Server Error-32603API サーバー側のエラーです
503Service Unavailable–一時的に API が利用不可となっている場合です

JSON-RPC エラーコード​

エラー時の Error オブジェクトの code フィールドに含まれる値です。

RPC CodeMeaning
-32700 (Parse error)不正な JSON format です
-32600 (Invalid Request)不正な JSON-RPC リクエストです
-32601 (Method not found)存在しないメソッドまたは利用不能なメソッドです
-32602 (Invalid params)不正な API リクエストパラメータです
-32603 (Internal server error)API サーバー側のエラーです
400 (Bad Request)他のエラーに該当しないクライアント側の不正なリクエストです
401 (Unauthorized)認証エラーです
403 (Forbidden)リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です
404 (Not Found)存在しないリソースです
405 (Method Not Allowed)その操作が許可されていない場合です

データ型​

Get-Payment-Request-Parameters​

userId, groupId, appId, paymentId は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。

NameTypeDescription
userIdUserIdRequired
groupIdGroupIdRequired '@self' のみ指定可能
appIdAppIdRequired '@app' のみ指定可能
paymentIdPaymentIdRequired UUID形式

ベースとなるデータ型

  • Starndard-Request-Parameters
Starndard-Request-Parameters​

サポートしているフィールド一覧は下記になります。

NameTypeDescription
formatStringOptional 'json' のみ指定可能

詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。

Payment​

NameTypeDescription
idStringPayment オブジェクトの id 値です。UUID 形式です。
appIdIntegerこの決済トランザクションを行うアプリケーションの id です。
userIdStringこの決済トランザクションを行うユーザーの guid です。
statusIntegerこの決済トランザクションのステータス値です。
entryArrayPaymentEntry オブジェクトのコレクションです。
callbackUrlStringパートナー様側の決済完了通知用の URL (モバイル用)
finishUrlStringパートナー様側の決済終了画面用の URL (モバイル用)
endpointUrlStringこの決済トランザクションを実行する Mobage 側の URL
deviceIdString決済を行った device の 種別です。PC: PC / Mobile: 携帯
publishedDate生成日時
updatedDate更新日時
status カラム値​
値説明
0決済開始時
1エラー
10成功

PaymentEntry​

NameTypeDescription
paymentIdStringPayment オブジェクトの id。
itemIdIntegerパートナー様がアイテムを区別するための識別子です。(SKU_ID と同じです)
nameStringアイテムの名称です。
unitPriceIntegerアイテムの単価 (コイン) です。
amountIntegerアイテムの購入個数です。
imageUrlStringアイテム画像のあるURLです。
descriptionStringアイテムの説明文です。

サンプルデータ​

RESTful API​

Payment情報を取得する​
GET /social/api/restful/v2/payment/99999/@self/@app/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Host: app.sb.mbga-platform.jp

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"entry" : [
{
"itemId" : 1,
"amount" : 5,
"imageUrl" : "http://example.com/img/example.gif",
"paymentId" : "3E37C512-6891-35C1-84FE-B081B5443997",
"name" : "金庫",
"unitPrice" : 100,
"description" : "今は購入出来ない伝説のアイテムです"
}
],
"status" : 10,
"userId" : "sb.mbga.jp:99999",
"endpointUrl" : "",
"appId" : 99999999,
"callbackUrl" : "",
"finishUrl" : "",
"id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"deviceId": "PC",
"published" : "2010-02-15T11:21:58",
"updated" : "2010-02-15T11:21:58"
}

更新履歴​

  • 2010/12/09
    • status カラム値 から "キャンセル" を削除