グラフAPI
グラフAPIバージョン

支払い/{payment-id}

Facebook決済を使用してアプリ内で行われた支払いの詳細。

読み取り

グラフAPIエクスプローラ
GET /v21.0/{payment-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{payment-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{payment-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{payment-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

アクセス許可

  • 支払いを作成したアプリのアプリアクセストークンが必要です。

フィールド

名前 説明 型

id

支払いID

string

user

消費者の氏名とユーザーid。場合によっては省略されることがあります。

User

request_id

JS関数に渡される、アプリで作成された一意かつ任意の識別子(最大255文字)

string

application

この支払いと関連付けられているアプリ

App

actions

この支払いで発生したさまざまなアクションタイプのリスト。

object[]

type

この特定のアクションのタイプ。typeには次のようなものがあります。

  • charge: この支払いで行われたアクションのタイプが課金であったことを示します。課金のステータスが「completed」になっている場合は、注文を処理する必要があります。
  • refund: 「refund」タイプは、支払い金が返金されたことを示します。この取引ではこれ以上支払いが行われないため、可能であれば、消費者に販売したアイテムを回収する必要があります。
  • chargeback: 「chargeback」は、問題のある支払いについて消費者が銀行に申し立てを行うことで発生します。チャージバックが発生した場合、この注文に対する支払いは行われないため、可能であれば、その消費者から該当するインゲームアイテムを回収する必要があります。
  • chargeback_reversal: 「chargeback_reversal」は、チャージバックが遡って取り消された場合に発生します。これに対する支払いは行われることになるので、可能であれば、その消費者のインゲームアイテムを元に戻す必要があります。
  • decline: 「decline」は、一括取引の作成に使用された支払い方法が支払い処理時に却下された場合に発生します。この注文に対する支払いは行われないため、可能であれば、その消費者から該当するインゲームアイテムを回収する必要があります。一括取引と却下の詳細については、申し立てと返金の処理をご覧ください。

string

status

この特定のアクションのステータス。statusには次のようなものがあります。

  • initiated: 「initiated」の支払いは、支払いが開始されただけで完了していないことを示します。このステータスの注文は処理しないようにしてください。また、このステータスの支払いについてはリアルタイムで最新情報を受け取ることができません。該当する取引が完了すると、リアルタイムで最新情報が届きます。「initiated」の状態は、決済までに時間がかかる支払い方法の場合に発生することがあります。例えば、消費者がオンラインフォームに入力し、受領書を印刷し、銀行に行ってオフラインで支払う必要がある場合などです。
  • completed: 「completed」ステータスは、アクションが正常に完了したことを意味します。タイプが「charge」の場合、この時点で消費者に対して注文を処理します。また、アクションタイプが「refund」の場合、消費者からアイテムを回収します。
  • failed: アクションタイプが正常に完了しなかったことを示します。この値は、「charge」アクションタイプと「refund」アクションタイプのどちらの場合にも表示される可能性があります。

string

amount

このアクションの対象となる金額。

string

currency

このアクションにおける上記のamountの通貨。

string

time_created

このアクションが発生した日時。

datetime

time_updated

このアクションの最終更新日時。

datetime

tax_amount

Facebookが納税した税金として、支払いから差し引かれた金額。taxがnot_taxedまたはalready_paidの場合、このフィールドは省略されます。

string

items

支払いに関連するアイテム。

object[]

type

このアイテムのタイプ。

enum{IN_APP_PURCHASE, SUBSCRIPTION}

product

このアイテムの商品URL。

string

quantity

このアイテムの購入数。

integer

country

税務処理のための、購入者のISO国コード。

string

tax

「tax」パラメーターは、支払いが課税対象(付加価値税または消費税)であるかどうかを示し、課税対象の場合は税金が支払われた方法を示します。これは次のいずれかの値になります。

  • not_taxed: EU域外からの支払いであるため、この支払いに付加価値税(VAT)は課されません。
  • already_paid: この支払いに課される税金は、ユーザーの携帯電話会社など、上流の当事者により支払い済みです。

  • tax_remitted: お客様に代わり、Facebookがこの支払いに課される付加価値税を支払いました。税額は支払いから差し引かれます。詳しくはこちらをご覧ください。

  • tax_remitted_USMPF: お客様に代わり、Facebookがこの支払いに課される消費税を徴収し、支払いました。税額は支払いから差し引かれますが、課された税額は商品の価格に上乗せされているため、正味の支払い額には影響しません。詳しくはこちらをご覧ください。

string

tax_country

この購入の税額計算のためにFacebookによって指定された国。ISO 3166-1 alpha-2国コードで表されます。注: このフィールドは参考のためのものであり、再計算や照合の目的で使用しないでください。taxがnot_taxedまたはalready_paidの場合、このフィールドは省略されます。

string

created_time

支払いが最初に作成された日時。

string

payout_foreign_exchange_rate

米ドルでの支払い金額の計算に使用される為替レート。

float

disputes

申し立てが発生した際に消費者から提供されたuser_commentやuser_emailなど、申し立てに関連する情報が含まれています。さらに、申し立ての現在のステータス、申し立てが作成された日時、解決理由(あれば)が含まれます。

object[]

user_comment

申し立てが発生した際に消費者から提供されたコメント。

string

user_email

申し立てが発生した際に消費者から提供されたメールアドレス。

string

time_created

申し立てが作成された日時。

datetime

status

申し立ての現在のステータス。

enum{resolved, pending}

reason

申し立て解決のために開発者やFacebookが提示した理由。解決後に表示されます。

enum{pending, refunded_in_cash, granted_replacement_item, denied_refund, banned_user, refunded_by_facebook}

test

アプリのダッシュボードのリストにある支払いテスターが支払いを行ったときに表示される、任意のパラメーター。消費者の支払い方法に課金されていない取引を表しています。

boolean

公開

Facebook決済を使用して支払いを作成できます。

削除

このAPIを使用して支払いを削除することはできません。

更新

このエッジを使用して支払いを更新することはできません。

エッジ

名前 説明

/dispute

支払いの申し立てステータスを更新します。

/refunds

支払い金を返金します。