圖形 API 版本

付款 /{payment-id}

在應用程式內使用 Facebook 付款完成的付款詳細資料。

讀取

圖形 API 測試工具
GET /v19.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

付款編號

string

user

消費者的姓名和用戶 id在某些情況下可以省略。

User

request_id

由應用程式建立的專屬選用識別碼,會傳遞至 JS 函式(上限 255 個字元)

string

application

與此付款相關的應用程式

App

actions

已出現在此付款中的不同動作類型清單。

object[]

type

此特定動作的類型。type 可能是:

  • charge:這表示對此付款採取的動作類型為收費。如果收費狀態為已完成,則您應該履行訂單。
  • refund:退款類型表示該款項已進行退款,而且如果可行,售出給消費者的商品應該收回,因為您不會從此交易獲得付款。
  • chargeback:刷退是由消費者發起,他們的銀行會針對有問題的款項提出異議。發生刷退時,如果可行,您應該向顧客收回遊戲內商品,因為您不會從此訂單獲得付款。
  • chargeback_reversal:若是撤回已執行的刷退,便會發生撤銷刷退(chargeback_reversal)。在此情況下,如果可行,您應該恢復消費者的遊戲內商品,因為您現在會從此款項獲得付款。
  • decline:若用於建立搭售交易的資金來源在處理付款時遭到拒絕,會發生拒絕。如果可行,您應該向消費者收回遊戲內商品,因為您不會從此訂單獲得付款。如需搭售交易和拒絕的詳細資訊,請參閱處理異議和退款

string

status

此特定動作的狀態。status 可能是:

  • initiated:已開始的付款表示僅開始付款但尚未完成。您不應向消費者履行這類型的訂單,而且您不會收到處於此狀態的付款即時更新。不過在相應的交易完成時,您會收到即時更新。針對某些需要較長時間才能結算的付款方式(例如該付款方式要求顧客必須在網路上填寫表單、列印收據,然後前往實體銀行付款),開發人員可能會看到已開始狀態。
  • completed:已完成狀態表示動作已成功完成。如果類型是收費,此時您應該向消費者履行訂單。同樣地,如果動作類型是退款,您應該向消費者收回商品。
  • failed:這表示基礎類型的動作失敗。收費動作類型和退款動作類型都可能會出現這個值。

string

amount

此動作所涵蓋的金額。

string

currency

此動作中上述 amount 的幣別。

string

time_created

此動作的發生時間。

datetime

time_updated

此動作上次更新的時間。

datetime

tax_amount

從 Facebook 繳納的任何稅款中扣除的金額。如果 tax 等於 not_taxedalready_paid,系統會省略此欄位。

string

items

與此付款相關的商品。

object[]

type

此商品的類型。

enum{IN_APP_PURCHASE, SUBSCRIPTION}

product

此商品的產品網址。

string

quantity

此商品的購買數量。

integer

country

買家的 ISO 國碼/區碼,供報稅之用。

string

tax

稅金參數會指出付款是否需要稅金(增值稅或營業稅),以及如果需要稅金,繳交方式為何。可能值如下:

  • not_taxed:這筆付款來自歐盟以外地區,因此沒有增值稅。
  • already_paid:用戶的行動電信業者或其他上游廠商已繳交這筆付款的稅金
  • tax_remitted:Facebook 已代您繳交這筆付款的增值稅。稅額將從支付給您的款項中扣除。請前往這裡查看更多資訊

  • tax_remitted_USMPF:Facebook 已代您收取並繳交營業稅。稅額將從支付給您的款項中扣除,但不會影響您的淨收取款項,因為收取的稅額已附加在商品價格中。請前往這裡查看更多資訊

string

tax_country

由 Facebook 判斷這次購買中,應以哪一個國家/地區的稅率來計算稅額(以 ISO 3166-1 alpha-2 國家/地區代碼顯示)。注意:此欄位資訊僅供參考,不得用於任何重新計算或對帳目的。如果 tax 等於 not_taxedalready_paid,系統會省略此欄位。

string

created_time

付款的原始建立時間。

string

payout_foreign_exchange_rate

用於計算支付款項的匯率,以美元匯繳。

float

disputes

包含與異議相關的資訊,包括消費者在提出異議時提供的 user_commentuser_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

針對支付款項進行退款。