chargeオブジェクトに決済手数料率のキー追加

平素よりPAY.JPをご愛顧いただきまして誠にありがとうございます。

chargeオブジェクトに決済手数料率のキー追加を予定しておりますので、お知らせさせていただきます。 この変更は2021年3月8日中のリリースを予定しております。

・追加するキー:

fee_rate 当該chargeにおける決済手数料率

・影響を受けるエンドポイント:

chargeオブジェクトが含まれる全てのAPI。

/v1/charge
/v1/transfers
/v1/tenant_transfers
/v1/events

から始まるエンドポイントにchargeオブジェクトが含まれます。

・chargeオブジェクトのレスポンスサンプル

{
  "amount": 3500,
  "amount_refunded": 0,
  "captured": true,
  "captured_at": 1433127983,
  "card": {
    "address_city": null,
    "address_line1": null,
    "address_line2": null,
    "address_state": null,
    "address_zip": null,
    "address_zip_check": "unchecked",
    "brand": "Visa",
    "country": null,
    "created": 1433127983,
    "customer": null,
    "cvc_check": "unchecked",
    "exp_month": 2,
    "exp_year": 2020,
    "fingerprint": "e1d8225886e3a7211127df751c86787f",
    "id": "car_d0e44730f83b0a19ba6caee04160",
    "last4": "4242",
    "name": null,
    "object": "card"
  },
  "created": 1433127983,
  "currency": "jpy",
  "customer": null,
  "description": null,
  "expired_at": null,
  "failure_code": null,
  "failure_message": null,
  "fee_rate": "3.00",
  "id": "ch_fa990a4c10672a93053a774730b0a",
  "livemode": false,
  "metadata": null,
  "object": "charge",
  "paid": true,
  "platform_fee": null,
  "platform_fee_rate": "10.00",
  "refund_reason": null,
  "refunded": false,
  "subscription": null,
  "tenant": "ten_121673955bd7aa144de5a8f6c262",
  "total_platform_fee": 350
}

・参考: chargeオブジェクトリファレンス https://pay.jp/docs/api/#charge%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88

該当のAPIをご利用中の方はレスポンスにキーが増えても、システム動作に問題がないかご確認をお願いいたします。

・payjp各種ライブラリについて

キーの追加の為、既存ライブラリはそのままお使い頂けます。 該当のキーを使った処理を行いたい場合、下記のライブラリはアップデートが必要となります。

payjp-java
payjp-go
payjp-node

こちらは機能リリースの同日にSDKを更新予定となっております。