[Deprecated] Platform API

こちらのAPIはdeprecatedです。

Platform APIへの移行をお願いします。移管方法については旧 PAY.JP Platform からの移行をご参考ください。

認証

curl https://api.pay.jp/v1/platform/merchants \
-u sk_live_pf::

プラットフォーマーに対し、本番用のシークレットキーが1つ発行されます。

種類	用途
シークレットキー	サーバー側からBasic認証のユーザーネームとして渡すシークレットキー

シークレットキーは、全てのPlatform APIリクエストの操作が可能となる重要なキーなので、くれぐれも取扱いにご注意ください。

Platform Error

タイプ	詳細
client_error	リクエストエラー
server_error	PAY.JPや決済ネットワーク側のエラー

コード	詳細
invalid_querystring	不正なクエリー文字列
invalid_timestamp	不正なUnixタイムスタンプ
invalid_string_length	不正な文字列長
invalid_character	不正な文字
invalid_url	不正なURL
invalid_format_string	不正な文字列形式
invalid_file	不正なファイル
invalid_file_id	不正なファイルIDがセットされている
invalid_amount	不正な金額
invalid_business_type	不正な事業形態
invalid_numerical_value	不正な数値
invalid_gender	不正な性別
invalid_address_zip	不正な郵便番号
invalid_address_state	不正な都道府県
invalid_address_city	不正な市区町村
invalid_address_line	不正な番地等
invalid_phone	不正な電話番号
invalid_boolean	不正な論理値
invalid_email	不正なメールアドレス
invalid_bank_code	不正な銀行コード
invalid_bank_branch_code	不正な銀行支店コード
invalid_bank_account_type	不正な口座種別
invalid_bank_account_holder_name	不正な口座名義
invalid_bank_account_number	不正な口座番号
invalid_param_length	パラメーターの長さが不正
missing_param	必要なパラメーターがセットされていない
invalid_param_key	指定できない不正なパラメーターがある
invalid_product_type	不正な商材種類
invalid_charge_type	不正な課金種類
invalid_key_type	不正なキータイプ
invalid_access_mode	不正なアクセスモード
invalid_timing	不正な更新タイミング

Error Code	Meaning
200	リクエスト成功
400	不正なパラメーターなどのリクエストエラー
401	APIキーの認証エラー
404	存在しないAPIリソース
500	PAY.JPや決済ネットワークでの障害

Charge for Platform Merchant (プラットフォームマーチャントの支払い)

POST https://api.pay.jp/v1/charges

curl https://api.pay.jp/v1/charges \
-u sk_test_c62fade9d045b54cd76d7036: \
-d card=tok_76e202b409f3da51a0706605ac81 \
-d amount=3500 \
-d currency=jpy \
-d platform_fee=100

レスポンス

{
  "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": 1583375140,
    "customer": null,
    "cvc_check": "passed",
    "exp_month": 2,
    "exp_year": 2024,
    "fingerprint": "e1d8225886e3a7211127df751c86787f",
    "id": "car_6845da1a8651f889bc432362dfcb",
    "last4": "4242",
    "livemode": false,
    "metadata": {},
    "name": null,
    "object": "card"
  },
  "created": 1433127983,
  "currency": "jpy",
  "customer": null,
  "description": null,
  "expired_at": null,
  "failure_code": null,
  "failure_message": null,
  "id": "ch_fa990a4c10672a93053a774730b0a",
  "livemode": false,
  "metadata": null,
  "object": "charge",
  "paid": true,
  "platform_fee": 100,
  "refund_reason": null,
  "refunded": false,
  "subscription": null
}

エラーレスポンス

{
  "error": {
    "code": "invalid_number",
    "message": "Your card number is invalid.",
    "param": "card[number]",
    "status": 400,
    "type": "card_error"
  }
}

PAY.JP API の Charge でプラットフォームマーチャントの支払いを操作します。但し下記の点が通常の PAY.JP API と異なります。

Platform Merchant によるcharge 作成時にプラットフォーマー向けの入金金額となる platform_fee をセット可能
platform_fee が Charge API のレスポンスに含まれる
charge 作成時に platform_fee を指定しなかった場合、レスポンスは platform_fee: null となり入金計算では0円扱い

なお tenant の指定などは本APIではできません。

Charge API の詳細については API リファレンスを参考にしてください。

Charge | PAY.JP API リファレンス

Platform Merchant（プラットフォームマーチャント）

accountオブジェクト(Platform API)

accountオブジェクト

{
  "keys": {
    "live_public_key": "pk_live_38c8c2b52815a74853f08746",
    "live_secret_key": "sk_live_0066e2c22d7e090dea3044a0c4975c08350b90b756fd16e63869fe67",
    "test_public_key": "pk_test_7752a2f93308665098bfe0a3",
    "test_secret_key": "sk_test_c28c9c343c03e9f483aa7848"
  },
  "created": 1521804248,
  "display_name": "PAY商店",
  "id": "acct_fc88af3e62e095ef754d31bd559",
  "merchant": {
    "applicaiton": null,
    "bank_enabled": false,
    "brands_accepted": [],
    "country": null,
    "created": 1521804248,
    "currencies_supported": [
      "jpy"
    ],
    "default_currency": "jpy",
    "details_submitted": false,
    "livemode_activated_at": null,
    "livemode_enabled": false,
    "object": "merchant"
  },
  "object": "account"
}

プロパティ

object String

“account"の固定文字列

id String

acct_で始まる一意なオブジェクトを示す文字列

display_name String

マーチャントの表示名称

created Integer

このアカウント作成時のUTCタイムスタンプ

merchant Object

アカウントに紐付くmerchantオブジェクト

keys Object

テストモードおよび本番モードにおける公開鍵および秘密鍵の値。

live_public_key: 本番モードの公開鍵
live_secret_key: 本番モードの秘密鍵
test_public_key: テストモードの公開鍵
test_secret_key: テストモードの秘密鍵

merchantオブジェクト(Platform API)

merchantオブジェクト

{
  "applicaiton": null,
  "bank_enabled": false,
  "brands_accepted": [],
  "country": null,
  "created": 1521804248,
  "currencies_supported": [
    "jpy"
  ],
  "default_currency": "jpy",
  "details_submitted": false,
  "livemode_activated_at": null,
  "livemode_enabled": false,
  "object": "merchant"
}

プロパティ

object String

"merchant"の固定文字列

application Object

申請情報

未申請時はnull

申請時のオブジェクトが持つキーについては、マーチャントの基本情報登録およびマーチャントの追加情報登録の引数を参照(dryrunを除く)

bank_enabled Boolean

入金先銀行口座情報が設定済みかどうか

brands_accepted Array

本番環境で利用可能なカードブランドのリスト

currencies_supported Array

対応通貨のリスト

default_currency String

3文字のISOコード(現状 "jpy” のみサポート)

details_submitted Boolean

本番環境申請情報が提出済みかどうか

country String

所在国

livemode_enabled Boolean

本番環境が有効かどうか

livemode_activated_at Integer

本番環境が許可された日時のUTCタイムスタンプ

created Integer

登録日時

このAPIは旧プラットフォームからの移行者のみ利用可能で、現在新規利用はできません。

マーチャント作成

POST https://api.pay.jp/v1/platform/merchants

curl https://api.pay.jp/v1/platform/merchants \
-u sk_live_pf_xxx: \
-d display_name=PAY商店 \

レスポンス

{
  "keys": {
    "live_public_key": "pk_live_38c8c2b52815a74853f08746",
    "live_secret_key": "sk_live_0066e2c22d7e090dea3044a0c4975c08350b90b756fd16e63869fe67",
    "test_public_key": "pk_test_7752a2f93308665098bfe0a3",
    "test_secret_key": "sk_test_c28c9c343c03e9f483aa7848"
  },
  "created": 1521804248,
  "display_name": "PAY商店",
  "id": "acct_fc88af3e62e095ef754d31bd559",
  "merchant": {
    "applicaiton": null,
    "bank_enabled": false,
    "brands_accepted": [],
    "country": null,
    "created": 1521804248,
    "currencies_supported": [
      "jpy"
    ],
    "default_currency": "jpy",
    "details_submitted": false,
    "livemode_activated_at": null,
    "livemode_enabled": false,
    "object": "merchant"
  },
  "object": "account"
}

エラーレスポンス

{
  "error": {
    "code": "invalid_string_length",
    "message": "Strings must be within 255 characters.",
    "param": "display_name",
    "status": 400,
    "type": "client_error"
  }
}

マーチャントを作成します。

引数

display_name String

マーチャントの表示名称

レスポンス

作成されたaccountオブジェクト(Platform API)

マーチャント情報を取得

GET https://api.pay.jp/v1/platform/merchants/:id

curl https://api.pay.jp/v1/platform/merchants/acct_fc88af3e62e095ef754d31bd559 \
-u sk_live_pf_xxx:

{
  "keys": {
    "live_public_key": "pk_live_38c8c2b52815a74853f08746",
    "live_secret_key": "sk_live_0066e2c22d7e090dea3044a0c4975c08350b90b756fd16e63869fe67",
    "test_public_key": "pk_test_7752a2f93308665098bfe0a3",
    "test_secret_key": "sk_test_c28c9c343c03e9f483aa7848"
  },
  "created": 1521804248,
  "display_name": "PAY商店",
  "id": "acct_fc88af3e62e095ef754d31bd559",
  "merchant": {
    "applicaiton": null,
    "bank_enabled": false,
    "brands_accepted": [],
    "country": null,
    "created": 1521804248,
    "currencies_supported": [
      "jpy"
    ],
    "default_currency": "jpy",
    "details_submitted": false,
    "livemode_activated_at": null,
    "livemode_enabled": false,
    "object": "merchant"
  },
  "object": "account"
}

エラーレスポンス

{
  "error": {
    "message": "No such account: dummy",
    "param": "id",
    "status": 404,
    "type": "client_error"
  }
}

マーチャント情報を取得します。

引数

なし

レスポンス

指定したidのaccountオブジェクト(Platform API)

マーチャントリストを取得

GET https://api.pay.jp/v1/platform/merchants

curl https://api.pay.jp/v1/platform/merchants -u sk_live_pf_xxx:

{
  "count": 1,
  "data": [
    {
      "keys": {
        "live_public_key": "pk_live_38c8c2b52815a74853f08746",
        "live_secret_key": "sk_live_0066e2c22d7e090dea3044a0c4975c08350b90b756fd16e63869fe67",
        "test_public_key": "pk_test_7752a2f93308665098bfe0a3",
        "test_secret_key": "sk_test_c28c9c343c03e9f483aa7848"
      },
      "created": 1521804248,
      "id": "acct_fc88af3e62e095ef754d31bd559",
      "merchant": {
        "application": null,
        "bank_enabled": false,
        "brands_accepted": [],
        "country": null,
        "created": 1521804248,
        "currencies_supported": [
          "jpy"
        ],
        "default_currency": "jpy",
        "details_submitted": false,
        "livemode_activated_at": null,
        "livemode_enabled": false,
        "object": "merchant",
      },
      "object": "account"
    }
  ],
  "has_more": false,
  "object": "list",
  "url": "/v1/platform/merchants"
}

エラーレスポンス

{
  "error": {
    "message": "Invalid query string.",
    "param": "dummy",
    "status": 400,
    "type": "client_error"
  }
}

マーチャントリストを取得します。

引数

limit Integer

取得するデータ数の最大値(1~100まで)。指定がない場合は 10 となる。

offset Integer

基準点からのデータ取得を行う開始位置。指定がない場合は 0 となる。

since Integer

タイムスタンプ

指定したタイムスタンプ以降に作成されたデータのみ取得

until Integer

タイムスタンプ

指定したタイムスタンプ以前に作成されたデータのみ取得

レスポンス

accountオブジェクト(Platform API)のlistオブジェクト

マーチャントのAPIキーの更新

POST https://api.pay.jp/v1/platform/merchants/:id/keys

curl https://api.pay.jp/v1/platform/merchants/acct_fc88af3e62e095ef754d31bd559/keys \
-d keytype=public \
-d accessmode=testmode \
-d timing=now \
-u sk_live_pf_xxx:

レスポンス

{
  "keys": {
    "live_public_key": "pk_live_38c8c2b52815a74853f08746",
    "live_secret_key": "sk_live_0066e2c22d7e090dea3044a0c4975c08350b90b756fd16e63869fe67",
    "test_public_key": "pk_test_66dfdcb95c6f0f8553fb2945",
    "test_secret_key": "sk_test_c28c9c343c03e9f483aa7848"
  },
  "created": 1521804248,
  "display_name": "PAY商店",
  "id": "acct_fc88af3e62e095ef754d31bd559",
  "merchant": {
    "application": null,
    "bank_enabled": false,
    "brands_accepted": [],
    "country": null,
    "created": 1521804248,
    "currencies_supported": [
      "jpy"
    ],
    "default_currency": "jpy",
    "details_submitted": false,
    "livemode_activated_at": null,
    "livemode_enabled": false,
    "object": "merchant"
  },
  "object": "account"
}

エラーレスポンス

{
  "error": {
    "code": "missing_param",
    "message": "Missing required param to platform_merchant_apikey",
    "param": "timing",
    "status": 400,
    "type": "client_error"
  }
}

マーチャントのAPIキーを更新します。

引数

keytype String 必須

更新したいAPIキーのタイプ。publicまたはsecretを指定可能。

accessmode String 必須

更新したいAPIキーの動作モード。livemodeまたはtestmodeを指定可能。

timing String 必須

更新タイミング。nowを指定時は即時、24hoursを指定時は24時間後。

レスポンス

更新後のAPIキーをもつaccountオブジェクト(Platform API)

マーチャントの基本情報登録

POST https://api.pay.jp/v1/platform/merchants/:id/applications/basic

curl https://api.pay.jp/v1/platform/merchants/acct_3fcd0fc1f931d4cc63b0e26c872/applications/basic \
-F "product_name=商品名"  \
-F "product_reading_name=プロダクト"  \
-F "product_english_name=product"  \
-F "url=http://example.com"  \
-F "service_start_at=2017-02"  \
-F "product_detail=グッズ販売"  \
-F "product_price_min=100"  \
-F "product_price_max=1000"  \
-F "business_type=company"  \
-F "business_name=PAYJP"  \
-F "business_reading_name=ペイジェーピー"  \
-F "date_of_establishment=2016-01-01"  \
-F "business_capital=1" \
-F "president_lastname=山田"  \
-F "president_firstname=太郎"  \
-F "president_reading_lastname=ヤマダ"  \
-F "president_reading_firstname=タロウ"  \
-F "president_birth_at=1980-02-10"  \
-F "president_gender=men"  \
-F "address_zip=150-0043"  \
-F "address_state=東京都"  \
-F "address_city=渋谷区"  \
-F "address_line1=道玄坂2-11-1"  \
-F "address_line2=Ｇスクエア4F"  \
-F "address_reading_state=トウキョウト"  \
-F "address_reading_city=シブヤク"  \
-F "address_reading_line1=ドウゲンザカニチョウメ１１−１"  \
-F "address_reading_line2=ジースクエア4カイ"  \
-F "phone=03-6416-5450"  \
-F "cell_phone=080-1111-2222"  \
-F "has_scl_url=false"  \
-F "scl_business_name=PAY"  \
-F "scl_contact_person_name=山田太郎"  \
-F "scl_address=東京都渋谷区道玄坂2-11-1Gスクエア4F" \
-F "scl_email=example@pay.jp"  \
-F "scl_phone=0312341234"  \
-F "scl_payment_method=クレジットカード"  \
-F "scl_time_of_payment=商品購入時に決済"  \
-F "scl_time_of_delivery=購入手続き完了後2営業日以内"  \
-F "scl_other_fee=なし" \
-F "scl_return_and_exchange=購入後7日以内であれば全額返金" \
-F "bank_person_name=ヤマダ タロウ"  \
-F "bank_code=0001"  \
-F "bank_branch_code=001"  \
-F "bank_type=普通"  \
-F "bank_account_number=0001000"  \
-F "corporate_number=1234123412341" \
-F "dryrun=false" \
-u sk_live_pf_xxx:

レスポンス

{
  "created": 1520825264,
  "id": "acct_1f29d796876a94017ccc471d7ad",
  "merchant": {
    "application": {
      "address_city": "渋谷区",
      "address_line1": "道玄坂２丁目１１−１",
      "address_line2": "Ｇスクエア4F",
      "address_reading_city": "シブヤク",
      "address_reading_line1": "ドウゲンザカニチョウメ１１−１",
      "address_reading_line2": "ジースクエア4カイ",
      "address_reading_state": "トウキョウト",
      "address_state": "東京都",
      "address_zip": "150-0043",
      "bank_account_number": "0001000",
      "bank_branch_code": "000",
      "bank_code": "0000",
      "bank_person_name": "ヤマダ タロウ",
      "bank_type": "普通",
      "date_of_establishment": "2016-01-01",
      "business_capital": 1,
      "business_detail": null,
      "business_name": "PAYJP",
      "business_reading_name": "ペイジェーピー",
      "business_sales_lastyear": 1,
      "business_type": "company",
      "cell_phone": "080-1111-2222",
      "charge_type": null,
      "contact_person": null,
      "contact_phone": null,
      "delivery_detail": null,
      "delivery_fee": null,
      "has_shop": false,
      "has_scl_url": false,
      "license_cert_files": [],
      "object": "application",
      "opening_business_cert_files": [],
      "phone": "03-6416-5450",
      "president_birth_at": "1980-02-10",
      "president_firstname": "太郎",
      "president_gender": "men",
      "president_lastname": "山田",
      "president_reading_firstname": "タロウ",
      "president_reading_lastname": "ヤマダ",
      "privacy_policy_url": null,
      "product_detail": "詳細",
      "product_detail_document_files": [],
      "product_english_name": "product",
      "product_name": "商品名",
      "product_price_max": 1000,
      "product_price_min": 100,
      "product_reading_name": "プロダクト",
      "product_type": null,
      "scl_address": "ほげ",
      "scl_business_name": "",
      "scl_contact_person_name": "ほげ",
      "scl_email": "hoge@fuga.com",
      "scl_other_fee": null,
      "scl_phone": "09000000000",
      "scl_return_and_exchange": null,
      "scl_time_of_delivery": "月初",
      "scl_time_of_payment": "月末",
      "scl_url": "",
      "service_start_at": "2017-02",
      "shop_address_city": null,
      "shop_address_line1": null,
      "shop_address_line2": null,
      "shop_address_reading_city": null,
      "shop_address_reading_line1": null,
      "shop_address_reading_line2": null,
      "shop_address_reading_state": null,
      "shop_address_state": null,
      "shop_address_zip": null,
      "shop_phone": null,
      "site_published": true,
      "ssl_enabled": true,
      "url": "http://example.com",
      "using_service": ""
    },
    "bank_enabled": false,
    "brands_accepted": [
      "Visa",
      "MasterCard",
      "PAY ID"
    ],
    "country": null,
    "created": 1520825264,
    "currencies_supported": [
      "jpy"
    ],
    "default_currency": "jpy",
    "details_submitted": true,
    "livemode_activated_at": 1520926519,
    "livemode_enabled": true,
    "object": "merchant"
  },
  "object": "account"
}

エラーレスポンス

{
  "error": {
    "code": "invalid_id",
    "message": "No such account: dummy",
    "param": "id",
    "status": 404,
    "type": "client_error"
  }
}

{
  "errors": {
    "product_name": [
      {
        "code": "missing_param",
        "message": "Missing required param to platform_merchant_application"
      }
    ]
  }
}

マーチャントの基本情報を登録します。

基本情報の登録後、Visa/MasterCardの審査プロセスを開始します。

引数

product_name String 必須

サービス名

product_reading_name String 必須

サービス名(カナ)

product_english_name String 必須

サービス名(英字)

url String 必須

サイトURL

service_start_at String 必須

サービス開始日

using_service String

今お使いのサービス

product_detail String 必須

商材・サービスの詳細説明

product_detail_document File

商材・サービスの概要資料ファイル( jpg , jpeg , png , pdf )

delete_product_detail_document Integer

削除する商材・サービスの概要資料ファイルのID

product_price_min Integer 必須

商材・サービスの最低価格

product_price_max Integer 必須

商材・サービスの最高価格

business_type String 必須

事業形態(法人の場合 company, 個人事業主の場合 sole_prop )

business_name String

会社名

business_type=‘company'の場合必須

business_reading_name String

会社名(カナ)

business_type='company'の場合必須

date_of_establishment String

設立年月日 (例 2016-01-01)

business_type='company'の場合必須

business_capital Integer

資本金(万単位)

business_type='company'の場合必須

president_lastname String 必須

代表者姓

president_firstname String 必須

代表者名

president_reading_lastname String 必須

代表者姓(カナ)

president_reading_firstname String 必須

代表者名(カナ)

president_birth_at String 必須

代表者生年月日(例 1980-12-31)

president_gender String 必須

代表者性別

address_zip String 必須

郵便番号

address_state String 必須

都道府県

address_city String 必須

市区郡

address_line1 String 必須

町名・番地

address_line2 String

建物名・部屋番号

address_reading_state String 必須

都道府県(カナ)

address_reading_city String 必須

市区郡(カナ)

address_reading_line1 String 必須

町名・番地(カナ)

address_reading_line2 String

建物名・部屋番号(カナ)

phone String 必須

電話番号

cell_phone String

携帯電話番号

has_scl_url Boolean 必須

特商法URLの有無を示すフラグ

scl_business_name String

特商法販売事業者名

has_scl_url=falseの場合必須

scl_contact_person_name String

特商法運営責任者名

has_scl_url=falseの場合必須

scl_email String

特商法問い合わせ窓口(メールアドレス) has_scl_url=falseの場合必須

scl_phone String

特商法問い合わせ窓口(電話番号)

has_scl_url=falseの場合必須

scl_address String

特商法本社所在地

has_scl_url=falseの場合必須

scl_other_fee String

特商法商品代金以外の必要料金

scl_payment_method String

特商法お支払い方法

has_scl_url=falseの場合必須

scl_time_of_payment String

特商法代金の支払い時期

has_scl_url=falseの場合必須

scl_time_of_delivery String

特商法商品の引渡し時期

has_scl_url=falseの場合必須

scl_return_and_exchange String

特商法返品・交換不良品について

has_scl_url=falseの場合必須

scl_url String

特商法 URL

has_scl_url=trueの場合必須

bank_code String 必須

4桁の銀行コード

bank_branch_code String 必須

3桁の支店コード

bank_type String 必須

預金種別

bank_account_number String 必須

口座番号

bank_person_name String 必須

口座名義

corporate_number String

13桁の法人番号 (わからない場合 https://www.houjin-bangou.nta.go.jp/ から検索)

business_type='company'の場合必須

license_cert File

免許書類ファイル( jpg , jpeg , png , pdf )

delete_license_cert Integer

削除する免許書類ファイルのID

dryrun Boolean

動作確認フラグ (trueの場合バリデーションのみを実施)

レスポンス

申請情報が更新されたaccountオブジェクト(Platform API)

(一部存在しないkeyがあります)

マーチャントの追加情報登録

POST https://api.pay.jp/v1/platform/merchants/:id/applications/additional

curl https://api.pay.jp/v1/platform/merchants/acct_3fcd0fc1f931d4cc63b0e26c872/applications/additional \
-F "product_type=goods"  \
-F "charge_type=charge"  \
-F "site_published=true"  \
-F "contact_person_lastname=山田"  \
-F "contact_person_firstname=太郎" \
-F "contact_phone=0312341234"  \
-F "business_sales_lastyear=1"  \
-F "business_detail=グッズ販売事業"  \
-F "has_shop=true"  \
-F "shop_phone=0300000000"  \
-F "shop_address_zip=150-0043"  \
-F "shop_address_state=東京"  \
-F "shop_address_reading_state=トウキョウ"  \
-F "shop_address_city=渋谷区"  \
-F "shop_address_reading_city=シブヤク"  \
-F "shop_address_line1=道玄坂2-11-1"  \
-F "shop_address_reading_line1=ドウゲンザカニチョウメ１１−１"  \
-F "shop_address_line2=Ｇスクエア4F"  \
-F "shop_address_reading_line2=ジースクエア4カイ"  \
-F "privacy_policy_url=https://pay.co.jp/privacy/"  \
-F "ssl_enabled=true"  \
-F "has_other_fee=true"  \
-F "delivery_fee=500"  \
-F "delivery_detail=配送の料金"  \
-F "other_fee=200"  \
-F "other_fee_detail=振込手数料など"  \
-F "dryrun=false" \
-u sk_live_pf_xxx:

レスポンス

{
  "created": 1525685035,
  "id": "acct_3fcd0fc1f931d4cc63b0e26c872",
  "merchant": {
    "application": {
      "address_city": "渋谷区",
      "address_line1": "道玄坂2-11-1",
      "address_line2": "Ｇスクエア4F",
      "address_reading_city": "シブヤク",
      "address_reading_line1": "ドウゲンザカニチョウメ１１−１",
      "address_reading_line2": "ジースクエア4カイ",
      "address_reading_state": "トウキョウト",
      "address_state": "東京都",
      "address_zip": "150-0043",
      "bank_account_number": "0001000",
      "bank_branch_code": "001",
      "bank_code": "0001",
      "bank_person_name": "ヤマダ　タロウ",
      "bank_type": "普通",
      "business_capital": 10000,
      "business_detail": "グッズ販売事業",
      "business_name": "PAYJP",
      "business_reading_name": "ペイジェーピー",
      "business_sales_lastyear": 10000,
      "business_type": "company",
      "cell_phone": "080-1111-2222",
      "charge_type": [
        "charge"
      ],
      "contact_person": "山田 太郎",
      "contact_phone": "0312341234",
      "corporate_number": "1234123412341",
      "date_of_establishment": "2016-01-01",
      "delivery_detail": "配送の料金",
      "delivery_fee": 500,
      "has_shop": true,
      "license_cert_files": [],
      "object": "application",
      "opening_business_cert_files": [],
      "other_fee": 200,
      "other_fee_detail": "振込手数料など",
      "phone": "03-6416-5450",
      "president_birth_at": "1980-02-10",
      "president_firstname": "太郎",
      "president_gender": "men",
      "president_lastname": "山田",
      "president_reading_firstname": "タロウ",
      "president_reading_lastname": "ヤマダ",
      "privacy_policy_url": "https://pay.co.jp/privacy/",
      "product_detail": "グッズ販売",
      "product_detail_document": [],
      "product_english_name": "product",
      "product_name": "商品名",
      "product_price_max": 1000,
      "product_price_min": 100,
      "product_reading_name": "プロダクト",
      "product_type": [
        "goods"
      ],
      "scl_address": "東京都渋谷区道玄坂2-11-1Gスクエア4F",
      "scl_business_name": "PAY",
      "scl_contact_person_name": "山田太郎",
      "scl_email": "example@pay.jp",
      "scl_other_fee": "なし",
      "scl_payment_method": "クレジットカード",
      "scl_phone": "0312341234",
      "scl_return_and_exchange": "購入後7日以内であれば全額返金",
      "scl_time_of_delivery": "購入手続き完了後2営業日以内",
      "scl_time_of_payment": "商品購入時に決済",
      "scl_url": null,
      "service_start_at": "2017-02",
      "shop_address_city": "渋谷区",
      "shop_address_line1": "道玄坂2-11-1",
      "shop_address_line2": "Ｇスクエア4F",
      "shop_address_reading_city": "シブヤク",
      "shop_address_reading_line1": "ドウゲンザカニチョウメ１１−１",
      "shop_address_reading_line2": "ジースクエア4カイ",
      "shop_address_reading_state": "トウキョウ",
      "shop_address_state": "東京",
      "shop_address_zip": "150-0043",
      "shop_phone": "0300000000",
      "site_published": true,
      "ssl_enabled": true,
      "terms_of_service": null,
      "url": "http://example.com",
      "using_service": null
    },
    "bank_enabled": false,
    "brands_accepted": [
      "Visa",
      "MasterCard",
      "PAY ID"
    ],
    "country": null,
    "created": 1525685035,
    "currencies_supported": [
      "jpy"
    ],
    "default_currency": "jpy",
    "details_submitted": true,
    "livemode_activated_at": 1525685046,
    "livemode_enabled": true,
    "object": "merchant"
  },
  "object": "account"
}

エラーレスポンス

{
  "error": {
    "code": "invalid_id",
    "message": "No such account: dummy",
    "param": "id",
    "status": 404,
    "type": "client_error"
  }
}

{
  "errors": {
    "product_type": [
      {
        "code": "invalid_product_type",
        "message": "Invalid product type provided"
      }
    ]
  }
}

マーチャントの追加情報を登録します。追加情報の登録後、JCB/American Express/Diners Club/Discoverの審査プロセスを開始します。追加情報は、基本情報の登録後に登録可能となります。

引数

product_type Array 必須

商材の種類( goods , services , contents )

charge_type Array 必須

利用する課金( charge , subscription )

sole_prop Boolean 必須

個人事業主か否か

date_of_establishment String

事業情報設立年月日

sole_prop=trueの場合>必須

opening_business_cert File

事業情報開業届( jpg , jpeg , png , pdf )

sole_prop=trueの場合>必須

site_published Boolean 必須

商品ページ・課金ページの公開状況

business_sales_lastyear Integer 必須

事業情報前年度年間売上(万単位)

business_detail String 必須

事業情報事業内容

has_shop Boolean 必須

実店舗の有無

shop_address_zip String

実店舗郵便番号 (デフォルトでは基本情報の address_zip が入る)

has_shop=trueの場合必須

shop_address_state String

実店舗都道府県 (デフォルトでは基本情報の address_state が入る)

has_shop=trueの場合>必須

shop_address_city String

実店舗市区郡 (デフォルトでは基本情報の address_city が入る)

has_shop=trueの場合>必須

shop_address_line1 String

実店舗町名・番地 (デフォルトでは基本情報の address_line1 が入る)

has_shop=trueの場合>必須

shop_address_line2 String

実店舗建物名・部屋番号 (デフォルトでは基本情報の address_line2 が入る)

has_shop=trueの場合>必須

shop_address_reading_state String

実店舗都道府県(カナ) (デフォルトでは基本情報の address_reading_state が入る)

has_shop=trueの場合>必須

shop_address_reading_city String

実店舗市区郡(カナ) (デフォルトでは基本情報の address_reading_city が入る)

has_shop=trueの場合>必須

shop_address_reading_line1 String

実店舗町名・番地(カナ) (デフォルトでは基本情報の address_reading_line1 が入る)

has_shop=trueの場合>必須

shop_address_reading_line2 String

実店舗建物名・部屋番号(カナ) (デフォルトでは基本情報の address_reading_line2 が入る)

has_shop=trueの場合>必須

shop_phone String

has_shop=trueの場合>必須

実店舗電話番号 (デフォルトでは基本情報の phone が入る)

privacy_policy_url String 必須

プライバシーポリシー

ssl_enabled Boolean 必須

決済画面におけるSSL利用

has_other_fee Boolean 必須

配送料・その他料金の有無

delivery_fee Integer

配送料(円)

has_other_fee=trueの場合>必須

delivery_detail String

配送料詳細

has_other_fee=trueの場合>必須

other_fee Integer

その他料金(円)

has_other_fee=trueの場合>必須

other_fee_detail String

その他料金詳細

has_other_fee=trueの場合>必須

contact_person_lastname String

ご担当者様名(姓)

sole_prop=falseの場合必須

contact_person_firstname String

ご担当者様名(名)

sole_prop=falseの場合必須

contact_phone String

ご担当者様電話番号

sole_prop=falseの場合必須

terms_of_service String

利用規約

site_published=falseの場合必須

dryrun Boolean

動作確認フラグ (trueの場合バリデーションのみを実施)

レスポンス

申請情報を更新したaccountオブジェクト(Platform API)

マーチャントの削除

DELETE https://api.pay.jp/v1/platform/merchants/:id

curl https://api.pay.jp/v1/platform/merchants/acct_1f29d796876a94017ccc471d7ad \
-u sk_live_pf_xxx: \
-XDELETE

レスポンス

{
  "deleted": true,
  "id": "acct_1f29d796876a94017ccc471d7ad"
}

エラーレスポンス

{
  "error": {
    "code": "invalid_id",
    "message": "No such account: dummy",
    "param": "id",
    "status": 404,
    "type": "client_error"
  }
}

マーチャントを削除します。

引数

なし

レスポンス

deleted Boolean

trueが入ります

id String

削除したaccountオブジェクト(Platform API)のid

Platform Transfer (プラットフォーム入金)

platform_transferオブジェクト

platform_transferオブジェクト

{
  "carried_balance": 0,
  "created": 1512967752,
  "currency": "jpy",
  "fee_amount": 10,
  "id": "pf_tr_23748b8c95c79edff22a8b7b795xx",
  "object": "platform_transfer",
  "scheduled_date": null,
  "status": "pending",
  "summary": {
    "charge_amount": 100,
    "charge_count": 1,
    "refund_amount": null,
    "refund_count": null
  },
  "term_end": null,
  "term_start": null,
  "transfers": {
    "count": 1,
    "data": [
      {
        "amount": 100,
        "carried_balance": 0,
        "created": 1512967752,
        "currency": "jpy",
        "description": null,
        "id": "tr_23748b8c95c79edff22a8b7b795xx",
        "livemode": true,
        "merchant": "acct_fc88af3e62e095ef754d31bd559",
        "object": "transfer",
        "scheduled_date": null,
        "status": "pending",
        "summary": {
          "charge_count": 1,
          "charge_fee": 100,
          "charge_gross": 100,
          "net": 100,
          "refund_amount": null,
          "refund_count": null
        },
        "term_end": null,
        "term_start": 1512967752,
        "transfer_amount": null,
        "transfer_date": null
      }
    ],
    "has_more": false,
    "object": "list",
    "url": "/v1/transfers"
  }
}

プロパティ

object String

オブジェクト名 値は"platform_transfer"

id String

pf_tr_で始まる一意なオブジェクトを示す文字列

created Integer

この入金作成時のUTCタイムスタンプ

carried_balance Integer

繰越金額

fee_amount Integer

プラットフォーマーへの入金予定額

currency String

3文字のISOコード(現状 “jpy” のみサポート)

status String

この入金の処理状態を表す値。値の詳細はtransferオブジェクトの status を参照下さい。

transfers Object

この入金に含まれるプラットフォームマーチャントのtransferオブジェクトのlistオブジェクト

scheduled_date Date

入金予定日

summary Object

この入金に関する集計情報

キー	値の型	値の説明
`charge_amount`	Integer	支払い総額
`charge_count`	Integer	支払い総数
`refund_amount`	Integer	返金総額
`refund_count`	Integer	返金総数

term_start Integer

集計期間開始時のUTCタイムスタンプ

term_end Integer

集計期間終了時のUTCタイムスタンプ

このAPIは旧プラットフォームからの移行者のみ利用可能で、現在新規利用はできません。

プラットフォーマーの入金情報を取得

GET https://api.pay.jp/v1/platform/transfers/:id

curl https://api.pay.jp/v1/platform/transfers/pf_tr_23748b8c95c79edff22a8b7b795xx \
-u sk_live_pf_xxx:

レスポンス

{
  "carried_balance": 0,
  "created": 1512967752,
  "currency": "jpy",
  "fee_amount": 10,
  "id": "pf_tr_23748b8c95c79edff22a8b7b795xx",
  "object": "platform_transfer",
  "scheduled_date": null,
  "status": "pending",
  "summary": {
    "charge_amount": 100,
    "charge_count": 1,
    "refund_amount": null,
    "refund_count": null
  },
  "term_end": null,
  "term_start": null,
  "transfers": {
    "count": 1,
    "data": [
      {
        "amount": 100,
        "carried_balance": 0,
        "created": 1512967752,
        "currency": "jpy",
        "description": null,
        "id": "tr_23748b8c95c79edff22a8b7b795xx",
        "livemode": true,
        "merchant": "acct_fc88af3e62e095ef754d31bd559",
        "object": "transfer",
        "scheduled_date": null,
        "status": "pending",
        "summary": {
          "charge_count": 1,
          "charge_fee": 100,
          "charge_gross": 100,
          "net": 100,
          "refund_amount": null,
          "refund_count": null
        },
        "term_end": null,
        "term_start": 1512967752,
        "transfer_amount": null,
        "transfer_date": null
      }
    ],
    "has_more": false,
    "object": "list",
    "url": "/v1/transfers"
  }
}

エラーレスポンス

{
  "error": {
    "message": "There is no platform transfer with ID: dummy",
    "param": "id",
    "status": 404,
    "type": "client_error"
  }
}

プラットフォーマーの特定の入金情報を取得します。

引数

なし

レスポンス

指定したidのplatform_transferオブジェクト

プラットフォーマーの入金リストを取得

GET https://api.pay.jp/v1/platform/transfers

curl https://api.pay.jp/v1/platform/transfers?limit=3 \
-u sk_live_pf_xxx:

レスポンス

{
  "count": 1,
  "data": [
    {
      "carried_balance": 0,
      "created": 1512967752,
      "currency": "jpy",
      "fee_amount": 10,
      "id": "pf_tr_23748b8c95c79edff22a8b7b795xx",
      "object": "platform_transfer",
      "scheduled_date": null,
      "status": "pending",
      "summary": {
        "charge_amount": 100,
        "charge_count": 1,
        "refund_amount": null,
        "refund_count": null
      },
      "term_end": null,
      "term_start": null,
      "transfers": {
        "count": 1,
        "data": [
          {
            "amount": 100,
            "carried_balance": 0,
            "created": 1512967752,
            "currency": "jpy",
            "description": null,
            "id": "tr_23748b8c95c79edff22a8b7b795xx",
            "livemode": true,
            "merchant": "acct_fc88af3e62e095ef754d31bd559",
            "object": "transfer",
            "scheduled_date": null,
            "status": "pending",
            "summary": {
              "charge_count": 1,
              "charge_fee": 100,
              "charge_gross": 100,
              "net": 100,
              "refund_amount": null,
              "refund_count": null
            },
            "term_end": null,
            "term_start": 1512967752,
            "transfer_amount": null,
            "transfer_date": null
          }
        ],
        "has_more": false,
        "object": "list",
        "url": "/v1/transfers"
      }
    }
  ],
  "has_more": false,
  "object": "list",
  "url": "/v1/platform/transfers"
}

エラーレスポンス

{
  "error": {
    "message": "Invalid query string.",
    "param": "dummy",
    "status": 400,
    "type": "client_error"
  }
}

プラットフォーマーの入金リストを取得します。

引数

limit Integer

取得するデータ数の最大値(1~100まで)。指定がない場合は 10 となる。

offset Integer

基準点からのデータ取得を行う開始位置。指定がない場合は 0 となる。

status String

ステータス

pending, paid, carried_over, failed, stop, recombination

since Integer

タイムスタンプ

指定したタイムスタンプ以降に作成されたデータのみ取得

until Integer

タイムスタンプ

指定したタイムスタンプ以前に作成されたデータのみ取得

レスポンス

platform_transferオブジェクトのlistオブジェクト

マーチャントの入金情報を取得

GET https://api.pay.jp/v1/platform/transfers/:id/transfers/:transfer_id

curl https://api.pay.jp/v1/platform/transfers/pf_tr_23748b8c95c79edff22a8b7b795xx/transfers/tr_8f0c0fe2c9f8a47f9d18f03959ba1 \
-u sk_live_pf_xxx:

SDKは準備中です

SDKは準備中です

SDKは準備中です

SDKは準備中です

SDKは準備中です

レスポンス

{
  "amount": 1000,
  "carried_balance": null,
  "charges": {
    "count": 1,
    "data": [
      {
        "amount": 1000,
        "amount_refunded": 0,
        "captured": true,
        "captured_at": 1441706750,
        "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": 1441706750,
          "customer": null,
          "cvc_check": "unchecked",
          "exp_month": 5,
          "exp_year": 2018,
          "fingerprint": "e1d8225886e3a7211127df751c86787f",
          "id": "car_93e59e9a9714134ef639865e2b9e",
          "last4": "4242",
          "name": null,
          "object": "card"
        },
        "created": 1441706750,
        "currency": "jpy",
        "customer": "cus_b92b879e60f62b532d6756ae12af",
        "description": null,
        "expired_at": null,
        "failure_code": null,
        "failure_message": null,
        "id": "ch_60baaf2dc8f3e35684ebe2031a6e0",
        "object": "charge",
        "paid": true,
        "refund_reason": null,
        "refunded": false,
        "subscription": null
      }
    ],
    "has_more": false,
    "object": "list",
    "url": "/v1/transfers/tr_8f0c0fe2c9f8a47f9d18f03959ba1/charges"
  },
  "created": 1438354800,
  "currency": "jpy",
  "description": null,
  "id": "tr_8f0c0fe2c9f8a47f9d18f03959ba1",
  "livemode": false,
  "merchant": "acct_fc88af3e62e095ef754d31bd559",
  "object": "transfer",
  "scheduled_date": "2015-09-16",
  "status": "pending",
  "summary": {
    "charge_count": 1,
    "charge_fee": 0,
    "charge_gross": 1000,
    "net": 1000,
    "refund_amount": 0,
    "refund_count": 0
  },
  "term_end": 1439650800,
  "term_start": 1438354800,
  "transfer_amount": null,
  "transfer_date": null
}

エラーレスポンス

{
  "error": {
    "message": "There is no transfer with ID: dummy",
    "param": "id",
    "status": 404,
    "type": "client_error"
  }
}

プラットフォーマー配下のマーチャントの特定の入金情報を取得します。

引数

なし

レスポンス

指定したidのプラットフォームマーチャントのtransferオブジェクトに下記のプロパティを加えたもの

merchant String

マーチャントID

マーチャントの入金リストを取得

GET https://api.pay.jp/v1/platform/transfers/:id/transfers

curl https://api.pay.jp/v1/platform/transfers/pf_tr_23748b8c95c79edff22a8b7b795xx/transfers?limit=3 \
-u sk_live_pf_xxx:

SDKは準備中です

SDKは準備中です

SDKは準備中です

SDKは準備中です

SDKは準備中です

レスポンス

{
  "count": 1,
  "data": [
    {
      "amount": 1000,
      "carried_balance": null,
      "charges": {
        "count": 1,
        "data": [
          {
            "amount": 1000,
            "amount_refunded": 0,
            "captured": true,
            "captured_at": 1441706750,
            "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": 1441706750,
              "customer": null,
              "cvc_check": "unchecked",
              "exp_month": 5,
              "exp_year": 2018,
              "fingerprint": "e1d8225886e3a7211127df751c86787f",
              "id": "car_93e59e9a9714134ef639865e2b9e",
              "last4": "4242",
              "name": null,
              "object": "card"
            },
            "created": 1441706750,
            "currency": "jpy",
            "customer": "cus_b92b879e60f62b532d6756ae12af",
            "description": null,
            "expired_at": null,
            "failure_code": null,
            "failure_message": null,
            "id": "ch_60baaf2dc8f3e35684ebe2031a6e0",
            "object": "charge",
            "paid": true,
            "refund_reason": null,
            "refunded": false,
            "subscription": null
          }
        ],
        "has_more": false,
        "object": "list",
        "url": "/v1/transfers/tr_8f0c0fe2c9f8a47f9d18f03959ba1/charges"
      },
      "created": 1438354800,
      "currency": "jpy",
      "description": null,
      "id": "tr_8f0c0fe2c9f8a47f9d18f03959ba1",
      "livemode": false,
      "merchant": "acct_fc88af3e62e095ef754d31bd559",
      "object": "transfer",
      "scheduled_date": "2015-09-16",
      "status": "pending",
      "summary": {
        "charge_count": 1,
        "charge_fee": 0,
        "charge_gross": 1000,
        "net": 1000,
        "refund_amount": 0,
        "refund_count": 0
      },
      "term_end": 1439650800,
      "term_start": 1438354800,
      "transfer_amount": null,
      "transfer_date": null
    }
  ],
  "has_more": false,
  "object": "list",
  "url": "/v1/transfers"
}

エラーレスポンス

{
  "error": {
    "message": "Invalid query string.",
    "param": "dummy",
    "status": 400,
    "type": "client_error"
  }
}

プラットフォーマー配下のマーチャントの入金リストを取得します。

引数

limit Integer

取得するデータ数の最大値(1~100まで)。指定がない場合は 10 となる。

offset Integer

基準点からのデータ取得を行う開始位置。指定がない場合は 0 となる。

status String

ステータス

pending, paid, carried_over, failed, stop, recombination

since Integer

タイムスタンプ

指定したタイムスタンプ以降に作成されたデータのみ取得

until Integer

タイムスタンプ

指定したタイムスタンプ以前に作成されたデータのみ取得

レスポンス

merchantプロパティを加えたtransferオブジェクトのlistオブジェクト