{
"openapi": "3.0.2",
"info": {
"title": "M's PayBridge バイヤープラットフォーム API",
"description": "M's PayBridge バイヤープラットフォーム用のAPIリファレンスの雛形です。\n必要なエンドポイント、サーバー定義、コンポーネントを追加して利用してください。\n",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.fincode.jp",
"description": "本番環境"
},
{
"url": "https://api.test.fincode.jp",
"description": "テスト環境"
}
],
"tags": [
{
"name": "Webhook設定",
"description": "Webhook設定を管理するAPIです。\\\nM's PayBridge上で指定したイベントが発生した場合、指定したエンドポイントでリアルタイムで通知を受け取れます。\\\n[Webhook通知仕様はこちら](#tag/Webhook_)\\\n\\\n※1 テナントバイヤーのイベントを受けとるためにはバイヤーテナントごとにWebhook設定を登録する必要があります。\n\n| 機能 | イベント名 | イベントパラメータ |\n|----------------------------|--------------------------|-----------------------------------------|\n| 請求書カード払い | 登録 | business_payments.regist |\n| 請求書カード払い | 実行 | business_payments.exec |\n| 請求書カード払い | 更新 | business_payments.update |\n| テナントバイヤー審査状況 | 更新 | buyer.contracts.status_code.updated |\n"
},
{
"name": "Webhook_通知仕様",
"description": "イベントが発生したときに、M's PayBridgeから加盟店様が設定したエンドポイントURLへWebhookのリクエストを送信するときの仕様です。\\\n[イベント一覧はこちら](#tag/Webhook)\\\n※通知対象のパラメータは、機能追加等に伴い追加される可能性があります。\\\n※予告なくパラメータ名の変更、削除が行われることはありません。\\\n\\\nWebhookを利用する場合は、正常受信または受信失敗のレスポンスをWebhookのリクエストに対して返却する必要があります。\\\nWebhookのリクエストがエラーで失敗した場合は、リトライ仕様に従って再送します。\n"
}
],
"externalDocs": {
"description": "M's PayBridge バイヤープラットフォーム JSの仕様はこちらの JSリファレンス から確認できます。",
"url": "/js-buyerplatform"
},
"paths": {
"/v1/business_payments": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBusinessPaymentList",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い 一覧取得",
"description": "リクエスト情報に設定された条件に当てはまる請求書カード払い情報を一覧取得するAPI。\n検索項目は、「取引ID（完全一致）」「取引先名（LIKE検索）」「支払金額（範囲）」「ステータス（列挙値）」「支払期日（範囲）」「振込実行日（範囲）」「更新日時（範囲）」\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの請求書カード払い情報一覧を取得します。\n"
},
{
"in": "query",
"name": "クエリ",
"description": "検索条件クエリパラメータ\n",
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination.QueryParams"
},
{
"$ref": "#/components/schemas/BusinessPayment.ListRetrieving.QueryParams"
}
]
}
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.ListRetrieving.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n'https://api.test.fincode.jp/v1/business_payments'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import fetch from \"node-fetch\";\n\nconst BASE_URL = \"https://api.test.fincode.jp\";\nconst API_KEY = \"\";\n\n(async () => {\n const endpoint = `${BASE_URL}/v1/business_payments`;\n\n const response = await fetch(endpoint, {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n });\n const businessPayments = await response.json();\n console.log(businessPayments); // 取得した請求書カード払いデータを出力\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\t// APIキーの指定\n\tapiKey := \"\"\n\n\t// リクエストの作成\n\treq, err := http.NewRequest(\n\t\t\"GET\",\n\t\t\"https://api.test.fincode.jp/v1/business_payments\",\n\t\tnil,\n\t)\n\tif err != nil {\n\t\tlog.Fatalf(\"リクエストの作成エラー: %v\", err)\n\t}\n\n\treq.Header.Set(\"Authorization\", \"Bearer \"+apiKey)\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n\t// リクエストの送信\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tlog.Fatalf(\"リクエスト送信エラー: %v\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tfmt.Println(resp.Status)\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/business_payments\"; // GETリクエストのエンドポイント\n\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Tenant-Buyer-Id: b_***********\"\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, 2);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n // エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n // APIからのデータを処理\n echo $response;\n}\n\ncurl_close($session);\n?>\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\nbase_url = \"https://api.test.fincode.jp\"\nendpoint = \"/v1/business_payments\" # GETリクエストのエンドポイント\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Tenant-Buyer-Id': 'b_***********'\n}\n\ntry:\n response = requests.get(f\"{base_url}{endpoint}\", headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = \"/v1/business_payments\" # GETリクエストのエンドポイント\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request[\"Tenant-Buyer-Id\"] = \"b_***********\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n # レスポンスの表示\n puts JSON.pretty_generate(JSON.parse(response.body))\n else\n puts 'ERROR'\n # エラーの表示\n puts response.body\n end\nend\n\nmain\n"
}
]
},
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "createBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い登録",
"description": "請求書カード払い情報を登録します。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの請求書カード払い情報を登録します。\n"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Creating.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Creating.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X POST \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n -d '{\n \"receipt_id\": \"rc_-RcdyjisQl-Uk5D7Q12f0A\"\n}' \\\n'https://api.test.fincode.jp/v1/business_payments'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\n\n(async () => {\n const response = await fetch(\"https://api.test.fincode.jp/v1/business_payments\", {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"application/json\",\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n body: JSON.stringify({\n \"receipt_id\": \"rc_-RcdyjisQl-Uk5D7Q12f0A\"\n }),\n });\n\n const data = await response.json();\n console.log(data);\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"bytes\"\n \"fmt\"\n \"io\"\n \"net/http\"\n)\n\nfunc main() {\n body := []byte(`{\"receipt_id\": \"rc_-RcdyjisQl-Uk5D7Q12f0A\"}`)\n\n req, err := http.NewRequest(http.MethodPost, \"https://api.test.fincode.jp/v1/business_payments\", bytes.NewBuffer(body))\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer \")\n req.Header.Set(\"Content-Type\", \"application/json\")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n resp, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": " 'rc_-RcdyjisQl-Uk5D7Q12f0A',\n]);\n\n$ch = curl_init('https://api.test.fincode.jp/v1/business_payments');\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n 'Authorization: Bearer ',\n 'Content-Type: application/json',\n \"Tenant-Buyer-Id: b_***********\"\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $payload);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/business_payments'\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n 'Tenant-Buyer-Id': 'b_***********'\n}\ndata = {\n \"receipt_id\": \"rc_-RcdyjisQl-Uk5D7Q12f0A\"\n}\n\nresponse = requests.post(url, headers=headers, json=data)\nprint(response.text)\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\nrequire \"json\"\n\nuri = URI.parse(\"https://api.test.fincode.jp/v1/business_payments\")\nrequest = Net::HTTP::Post.new(uri)\nrequest[\"Authorization\"] = \"Bearer \"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest[\"Tenant-Buyer-Id\"] = \"b_***********\"\nrequest.body = {\n receipt_id: \"rc_-RcdyjisQl-Uk5D7Q12f0A\"\n}.to_json\n\nresponse = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\nputs response.body\n"
}
]
}
},
"/v1/business_payments/{id}": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い情報取得",
"description": "エンドポイントに指定してある取引IDに応じたバイヤ請求書カード払い情報を取得する。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーに紐づく請求書カード払い情報を取得します。\n"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 25,
"maxLength": 25
},
"description": "取引ID"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Detail"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n'https://api.test.fincode.jp/v1/business_payments/{id}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n const accessId = \"\";\n\n try {\n // リクエストの送信\n const businessPayment = await fincode.businessPayments.retrieve(accessId);\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"fmt\"\n \"log\"\n \"net/http\"\n)\n\nfunc main() {\n apiKey := \"\"\n accessID := \"\"\n\n // リクエストの作成\n req, _ := http.NewRequest(\"GET\", fmt.Sprintf(\"https://api.test.fincode.jp/v1/business_payments/%s\", accessID), nil)\n req.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n // リクエストの送信\n client := &http.Client{}\n res, err := client.Do(req)\n if err != nil {\n log.Fatal(err)\n }\n defer res.Body.Close()\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$accessId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/business_payments/{$accessId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\"\n \"Tenant-Buyer-Id: b_***********\"\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\naccess_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/business_payments/{access_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n 'Tenant-Buyer-Id': 'b_***********'\n}\n\n# HTTP GETリクエストの送信\ntry:\n response = requests.get(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n access_id = ''\n endpoint = \"/v1/business_payments/#{access_id}\"\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n request[\"Tenant-Buyer-Id\"] = \"b_***********\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
},
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "updateBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い更新",
"description": "指定したIDの請求書カード払い情報を更新します。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーに紐づく請求書カード払い情報を更新します。\n"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 25,
"maxLength": 25
},
"description": "取引ID"
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Updating.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Updating.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X POST \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: multipart/form-data\" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n -F 'data=@;type=application/json' \\\n -F 'invoice_file=@' \\\n'https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst BUSINESS_PAYMENT_ID = \"bp_VbZbE8t6RMGIsIfOP3U7ww\";\n\nconst form = new FormData();\n\nform.append(\"invoice_file\", \"\");\nform.append(\"data\", `{\n billing_amount: 10000,\n card_token: null,\n due_date: \"2025/05/11\",\n invoice_file_name_display: \"請求書.pdf\",\n remitter_name: \"カタカナ テストタロウ XYZ\",\n payee: {\n company_name: \"株式会社アイネット\",\n corporate: \"0\",\n representative_name: \"株式会社アイネット\",\n invoice_registration_number: \"T7020001030145\",\n addr_post_code: \"220-0012\",\n addr_state: \"横浜市\",\n addr_city: \"西区\",\n addr_line_1: \"みなとみらい5-1-2\",\n addr_line_2: \"横浜シンフォステージ ウエストタワー13階\",\n email: \"test@test.com\",\n phone_no: \"045-682-0845\",\n },\n payee_bank: {\n bank_code: \"0011\",\n bank_name: \"三井住友\",\n branch_code: \"012\",\n branch_name: \"横浜\",\n account_kind: 1,\n account_number: \"4108217\",\n account_name: \"カテスト タロウ\",\n },\n}`);\n\n(async () => {\n const response = await fetch(`https://api.test.fincode.jp/v1/business_payments/${BUSINESS_PAYMENT_ID}`, {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"multipart/form-data\",\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n body: form,\n });\n\n const data = await response.json();\n console.log(data);\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"bytes\"\n \"fmt\"\n \"io\"\n \"net/http\"\n)\n\nfunc main() {\n body := []byte(`{\"invoice_file\":\"string \",\"data\":\"{\n BillingAmount: 10000,\n CardToken: nil,\n BusinessPaymentsCardID: \"1234\",\n CardRegisterFlag: nil,\n DueDate: \"2025/05/11\",\n InvoiceFileNameDisplay: \"請求書.pdf\",\n RemitterName: \"カタカナ テストタロウ XYZ\",\n Payee: Payee{\n CompanyName: \"株式会社アイネット\",\n Corporate: \"0\",\n RepresentativeName: \"株式会社アイネット\",\n InvoiceRegistrationNumber: \"T7020001030145\",\n AddrPostCode: \"220-0012\",\n AddrState: \"横浜市\",\n AddrCity: \"西区\",\n AddrLine1: \"みなとみらい5-1-2\",\n AddrLine2: \"横浜シンフォステージ ウエストタワー13階\",\n Email: \"test@test.com\",\n PhoneNo: \"045-682-0845\",\n },\n PayeeBank: PayeeBank{\n BankCode: \"0011\",\n BankName: \"三井住友\",\n BranchCode: \"012\",\n BranchName: \"横浜\",\n AccountKind: 1,\n AccountNumber: \"4108217\",\n AccountName: \"カテスト タロウ\",\n },\n }\"}`)\n\n req, err := http.NewRequest(http.MethodPost, \"https://api.test.fincode.jp/v1/business_payments/bp_abc123\", bytes.NewBuffer(body))\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer \")\n req.Header.Set(\"Content-Type\", \"multipart/form-data\")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n resp, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": " 10000,\n 'card_token' => null,\n 'due_date' => '2025/05/11',\n 'invoice_file_name_display' => '請求書.pdf',\n 'remitter_name' => 'カタカナ テストタロウ XYZ',\n 'payee' => [\n 'company_name' => '株式会社アイネット',\n 'corporate' => '0',\n 'representative_name' => '株式会社アイネット',\n 'invoice_registration_number' => 'T7020001030145',\n 'addr_post_code' => '220-0012',\n 'addr_state' => '横浜市',\n 'addr_city' => '西区',\n 'addr_line_1' => 'みなとみらい5-1-2',\n 'addr_line_2' => '横浜シンフォステージ ウエストタワー13階',\n 'email' => 'test@test.com',\n 'phone_no' => '045-682-0845',\n ],\n 'payee_bank' => [\n 'bank_code' => '0011',\n 'bank_name' => '三井住友',\n 'branch_code' => '012',\n 'branch_name' => '横浜',\n 'account_kind' => 1,\n 'account_number' => '4108217',\n 'account_name' => 'カテスト タロウ',\n ],\n]);\n\n$ch = curl_init('https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww');\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n 'Authorization: Bearer ',\n 'Content-Type: multipart/form-data',\n 'Tenant-Buyer-Id: b_***********'\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $payload);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww'\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'multipart/form-data'\n 'Tenant-Buyer-Id': 'b_***********'\n}\ndata = {\n 'billing_amount': 10000,\n 'card_token': None,\n 'due_date': '2025/05/11',\n 'invoice_file_name_display': '請求書.pdf',\n 'remitter_name': 'カタカナ テストタロウ XYZ',\n 'payee': {\n 'company_name': '株式会社アイネット',\n 'corporate': '0',\n 'representative_name': '株式会社アイネット',\n 'invoice_registration_number': 'T7020001030145',\n 'addr_post_code': '220-0012',\n 'addr_state': '横浜市',\n 'addr_city': '西区',\n 'addr_line_1': 'みなとみらい5-1-2',\n 'addr_line_2': '横浜シンフォステージ ウエストタワー13階',\n 'email': 'test@test.com',\n 'phone_no': '045-682-0845'\n },\n 'payee_bank': {\n 'bank_code': '0011',\n 'bank_name': '三井住友',\n 'branch_code': '012',\n 'branch_name': '横浜',\n 'account_kind': 1,\n 'account_number': '4108217',\n 'account_name': 'カテスト タロウ'\n }\n}\n\nresponse = requests.post(url, headers=headers, json=data)\nprint(response.text)\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\nrequire \"json\"\n\nuri = URI.parse(\"https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww\")\nrequest = Net::HTTP::Post.new(uri)\nrequest[\"Authorization\"] = \"Bearer \"\nrequest[\"Content-Type\"] = \"multipart/form-data\"\nrequest[\"Tenant-Buyer-Id\"] = \"b_***********\"\nrequest.body = {\n billing_amount: 10000,\n card_token: nil,\n due_date: \"2025/05/11\",\n invoice_file_name_display: \"請求書.pdf\",\n remitter_name: \"カタカナ テストタロウ XYZ\",\n payee: {\n company_name: \"株式会社アイネット\",\n corporate: \"0\",\n representative_name: \"株式会社アイネット\",\n invoice_registration_number: \"T7020001030145\",\n addr_post_code: \"220-0012\",\n addr_state: \"横浜市\",\n addr_city: \"西区\",\n addr_line_1: \"みなとみらい5-1-2\",\n addr_line_2: \"横浜シンフォステージ ウエストタワー13階\",\n email: \"test@test.com\",\n phone_no: \"045-682-0845\"\n },\n payee_bank: {\n bank_code: \"0011\",\n bank_name: \"三井住友\",\n branch_code: \"012\",\n branch_name: \"横浜\",\n account_kind: 1,\n account_number: \"4108217\",\n account_name: \"カテスト タロウ\"\n }\n}.to_json\n\nresponse = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\nputs response.body\n"
}
]
},
"put": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "submitBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い提出",
"description": "請求書カード払い情報を提出する。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーに紐づく請求書カード払い情報を提出します。\n"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "取引ID"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Submitting.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Submitting.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X PUT \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n -d '{\n \"billing_amount\": 10000,\n \"card_token\": null,\n \"due_date\": \"2025/05/11\",\n \"invoice_file_name_display\": \"請求書.pdf\",\n \"remitter_name\": \"カタカナ テストタロウ ＸＹＺ\",\n \"payee\": {\n \"company_name\": \"株式会社アイネット\",\n \"corporate\": \"0\",\n \"representative_name\": \"株式会社アイネット\",\n \"invoice_registration_number\": \"T7020001030145\",\n \"addr_post_code\": \"220-0012\",\n \"addr_state\": \"横浜市\",\n \"addr_city\": \"西区\",\n \"addr_line_1\": \"みなとみらい5-1-2\",\n \"addr_line_2\": \"横浜シンフォステージ ウエストタワー13階\",\n \"email\": \"test@test.com\",\n \"phone_no\": \"045-682-0845\"\n },\n \"payee_bank\": {\n \"bank_code\": \"0011\",\n \"bank_name\": \"三井住友\",\n \"branch_code\": \"012\",\n \"branch_name\": \"横浜\",\n \"account_kind\": 1,\n \"account_number\": \"4108217\",\n \"account_name\": \"カテスト タロウ\"\n }\n}' \\\n'https://api.test.fincode.jp/v1/business_payments/{id}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import fetch from \"node-fetch\";\n\nconst BASE_URL = \"https://api.test.fincode.jp\";\nconst API_KEY = \"\";\n\n(async () => {\n const businessPaymentId = \"\"; // ここにBusiness Payment IDを設定\n\n const endpoint = `${BASE_URL}/v1/business_payments/${businessPaymentId}`;\n\n const response = await fetch(endpoint, {\n method: \"PUT\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"application/json\",\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n body: JSON.stringify({\n billing_amount: 10000,\n card_token: null,\n due_date: \"2025/05/11\",\n invoice_file_name_display: \"請求書.pdf\",\n remitter_name: \"カタカナ テストタロウ XYZ\",\n payee: {\n company_name: \"株式会社アイネット\",\n corporate: \"0\",\n representative_name: \"株式会社アイネット\",\n invoice_registration_number: \"T7020001030145\",\n addr_post_code: \"220-0012\",\n addr_state: \"横浜市\",\n addr_city: \"西区\",\n addr_line_1: \"みなとみらい5-1-2\",\n addr_line_2: \"横浜シンフォステージ ウエストタワー13階\",\n email: \"test@test.com\",\n phone_no: \"045-682-0845\",\n },\n payee_bank: {\n bank_code: \"0011\",\n bank_name: \"三井住友\",\n branch_code: \"012\",\n branch_name: \"横浜\",\n account_kind: 1,\n account_number: \"4108217\",\n account_name: \"カテスト タロウ\",\n },\n }),\n });\n\n if (response.ok) {\n const businessPaymentData = await response.json();\n console.log(\"Business Payment Submitted:\", businessPaymentData);\n } else {\n console.error(\"Error submitting business payment:\", await response.text());\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"bytes\"\n \"encoding/json\"\n \"fmt\"\n \"log\"\n \"net/http\"\n)\n\nfunc main() {\n // APIキーと請求書カード払いIDを指定\n apiKey := \"\"\n businessPaymentID := \"\"\n\n body := SubmitBusinessPaymentRequest{\n BillingAmount: 10000,\n CardToken: nil,\n BusinessPaymentsCardID: \"1234\",\n CardRegisterFlag: nil,\n DueDate: \"2025/05/11\",\n InvoiceFileNameDisplay: \"請求書.pdf\",\n RemitterName: \"カタカナ テストタロウ XYZ\",\n Payee: Payee{\n CompanyName: \"株式会社アイネット\",\n Corporate: \"0\",\n RepresentativeName: \"株式会社アイネット\",\n InvoiceRegistrationNumber: \"T7020001030145\",\n AddrPostCode: \"220-0012\",\n AddrState: \"横浜市\",\n AddrCity: \"西区\",\n AddrLine1: \"みなとみらい5-1-2\",\n AddrLine2: \"横浜シンフォステージ ウエストタワー13階\",\n Email: \"test@test.com\",\n PhoneNo: \"045-682-0845\",\n },\n PayeeBank: PayeeBank{\n BankCode: \"0011\",\n BankName: \"三井住友\",\n BranchCode: \"012\",\n BranchName: \"横浜\",\n AccountKind: 1,\n AccountNumber: \"4108217\",\n AccountName: \"カテスト タロウ\",\n },\n }\n\n marshalledBody, err := json.Marshal(body)\n if err != nil {\n log.Fatalf(\"エンコードエラー: %v\", err)\n }\n\n url := fmt.Sprintf(\"https://api.test.fincode.jp/v1/business_payments/%s\", businessPaymentID)\n\n req, err := http.NewRequest(http.MethodPut, url, bytes.NewBuffer(marshalledBody))\n if err != nil {\n log.Fatalf(\"リクエストの作成エラー: %v\", err)\n }\n\n req.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n req.Header.Set(\"Content-Type\", \"application/json\")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n client := &http.Client{}\n resp, err := client.Do(req)\n if err != nil {\n log.Fatalf(\"リクエストエラー: %v\", err)\n }\n defer resp.Body.Close()\n\n fmt.Println(\"Status:\", resp.Status)\n}\n\ntype SubmitBusinessPaymentRequest struct {\n BillingAmount int `json:\"billing_amount\"`\n CardToken *string `json:\"card_token\"`\n DueDate string `json:\"due_date\"`\n InvoiceFileNameDisplay string `json:\"invoice_file_name_display\"`\n RemitterName string `json:\"remitter_name\"`\n Payee Payee `json:\"payee\"`\n PayeeBank PayeeBank `json:\"payee_bank\"`\n}\n\ntype Payee struct {\n CompanyName string `json:\"company_name\"`\n Corporate string `json:\"corporate\"`\n RepresentativeName string `json:\"representative_name\"`\n InvoiceRegistrationNumber string `json:\"invoice_registration_number\"`\n AddrPostCode string `json:\"addr_post_code\"`\n AddrState string `json:\"addr_state\"`\n AddrCity string `json:\"addr_city\"`\n AddrLine1 string `json:\"addr_line_1\"`\n AddrLine2 string `json:\"addr_line_2\"`\n Email string `json:\"email\"`\n PhoneNo string `json:\"phone_no\"`\n}\n\ntype PayeeBank struct {\n BankCode string `json:\"bank_code\"`\n BankName string `json:\"bank_name\"`\n BranchCode string `json:\"branch_code\"`\n BranchName string `json:\"branch_name\"`\n AccountKind int `json:\"account_kind\"`\n AccountNumber string `json:\"account_number\"`\n AccountName string `json:\"account_name\"`\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n$businessPaymentId = ''; // ここにBusiness Payment IDを設定\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/business_payments/{$businessPaymentId}\";\n\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\"\n \"Tenant-Buyer-Id: b_***********\"\n];\n\n$data = json_encode([\n 'billing_amount' => 10000,\n 'card_token' => null,\n 'due_date' => '2025/05/11',\n 'invoice_file_name_display' => '請求書.pdf',\n 'remitter_name' => 'カタカナ テストタロウ XYZ',\n 'payee' => [\n 'company_name' => '株式会社アイネット',\n 'corporate' => '0',\n 'representative_name' => '株式会社アイネット',\n 'invoice_registration_number' => 'T7020001030145',\n 'addr_post_code' => '220-0012',\n 'addr_state' => '横浜市',\n 'addr_city' => '西区',\n 'addr_line_1' => 'みなとみらい5-1-2',\n 'addr_line_2' => '横浜シンフォステージ ウエストタワー13階',\n 'email' => 'test@test.com',\n 'phone_no' => '045-682-0845',\n ],\n 'payee_bank' => [\n 'bank_code' => '0011',\n 'bank_name' => '三井住友',\n 'branch_code' => '012',\n 'branch_name' => '横浜',\n 'account_kind' => 1,\n 'account_number' => '4108217',\n 'account_name' => 'カテスト タロウ',\n ],\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_CUSTOMREQUEST, 'PUT');\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n echo \"cURL Error: \" . curl_error($session);\n} else {\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\nbusiness_payment_id = '' # ここにBusiness Payment IDを設定\n\nurl = f'https://api.test.fincode.jp/v1/business_payments/{business_payment_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n 'Tenant-Buyer-Id': 'b_***********'\n}\ndata = {\n 'billing_amount': 10000,\n 'card_token': None,\n 'due_date': '2025/05/11',\n 'invoice_file_name_display': '請求書.pdf',\n 'remitter_name': 'カタカナ テストタロウ XYZ',\n 'payee': {\n 'company_name': '株式会社アイネット',\n 'corporate': '0',\n 'representative_name': '株式会社アイネット',\n 'invoice_registration_number': 'T7020001030145',\n 'addr_post_code': '220-0012',\n 'addr_state': '横浜市',\n 'addr_city': '西区',\n 'addr_line_1': 'みなとみらい5-1-2',\n 'addr_line_2': '横浜シンフォステージ ウエストタワー13階',\n 'email': 'test@test.com',\n 'phone_no': '045-682-0845'\n },\n 'payee_bank': {\n 'bank_code': '0011',\n 'bank_name': '三井住友',\n 'branch_code': '012',\n 'branch_name': '横浜',\n 'account_kind': 1,\n 'account_number': '4108217',\n 'account_name': 'カテスト タロウ'\n }\n}\n\n# HTTP PUTリクエストの送信\ntry:\n response = requests.put(url, headers=headers, json=data)\n\n # レスポンスの処理\n if response.status_code == 200:\n print(f\"Success: {response.json()}\")\n else:\n print(f\"Error: {response.text}\")\nexcept requests.RequestException as e:\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\nrequire \"json\"\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n business_payment_id = '' # ここにBusiness Payment IDを設定\n endpoint = \"/v1/business_payments/#{business_payment_id}\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n billing_amount: 10000,\n card_token: nil,\n due_date: \"2025/05/11\",\n invoice_file_name_display: \"請求書.pdf\",\n remitter_name: \"カタカナ テストタロウ XYZ\",\n payee: {\n company_name: \"株式会社アイネット\",\n corporate: \"0\",\n representative_name: \"株式会社アイネット\",\n invoice_registration_number: \"T7020001030145\",\n addr_post_code: \"220-0012\",\n addr_state: \"横浜市\",\n addr_city: \"西区\",\n addr_line_1: \"みなとみらい5-1-2\",\n addr_line_2: \"横浜シンフォステージ ウエストタワー13階\",\n email: \"test@test.com\",\n phone_no: \"045-682-0845\"\n },\n payee_bank: {\n bank_code: \"0011\",\n bank_name: \"三井住友\",\n branch_code: \"012\",\n branch_name: \"横浜\",\n account_kind: 1,\n account_number: \"4108217\",\n account_name: \"カテスト タロウ\"\n }\n }\n\n request = Net::HTTP::Put.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n request[\"Tenant-Buyer-Id\"] = \"b_***********\"\n request.body = data.to_json\n\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/v1/business_payments/{id}/delete": {
"put": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "deleteBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い情報削除",
"description": "指定したIDの請求書カード払い情報を削除します。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーに紐づく請求書カード払い情報を削除します。\n"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 25,
"maxLength": 25
},
"description": "取引ID"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Deleting.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
},
"404": {
"description": "該当データなし"
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X PUT \\\n -H \"Authorization:Bearer \" \\\n -H \"Tenant-Buyer-Id:b_***********\" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n'https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww/delete'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst BUSINESS_PAYMENT_ID = \"bp_VbZbE8t6RMGIsIfOP3U7ww\";\n\n(async () => {\n const response = await fetch(`https://api.test.fincode.jp/v1/business_payments/${BUSINESS_PAYMENT_ID}/delete`, {\n method: \"PUT\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n });\n\n const data = await response.json();\n console.log(data);\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n)\n\nfunc main() {\n req, err := http.NewRequest(http.MethodPut, \"https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww/delete\", nil)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer \")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n resp, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n body, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(body))\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "',\n 'Tenant-Buyer-Id: b_***********',\n]);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/business_payments/bp_abc123/delete'\nheaders = {\n 'Authorization': f'Bearer {api_key}'\n 'Tenant-Buyer-Id': 'b_***********'\n}\n\nresponse = requests.put(url, headers=headers)\nprint(response.text)\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\n\nuri = URI.parse(\"https://api.test.fincode.jp/v1/business_payments/bp_VbZbE8t6RMGIsIfOP3U7ww/delete\")\nrequest = Net::HTTP::Put.new(uri)\nrequest[\"Authorization\"] = \"Bearer \"\nrequest[\"Tenant-Buyer-Id\"] = \"b_***********\"\n\nresponse = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\nputs response.body\n"
}
]
}
},
"/v1/business_payments/request": {
"put": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "requestBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い依頼",
"description": "請求書カード払い依頼を行います。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの請求書カード払い情報依頼を行います。\n"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Requesting.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Requesting.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X PUT \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n -d '{\n \"access_id\": \"bp_abcdefghijklmnopqrstuv\",\n}' \\\n'https://api.test.fincode.jp/v1/business_payments/request'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\n\n(async () => {\n const response = await fetch(\n \"https://api.test.fincode.jp/v1/business_payments/request\",\n {\n method: \"PUT\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"application/json\",\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n body: JSON.stringify({\n access_id: \"bp_abcdefghijklmnopqrstuv\",\n }),\n },\n );\n\n const data = await response.json();\n console.log(data);\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"bytes\"\n \"fmt\"\n \"io\"\n \"net/http\"\n)\n\nfunc main() {\n body := []byte(`{\"access_id\":\"bp_abcdefghijklmnopqrstuv\"}`)\n\n req, err := http.NewRequest(http.MethodPut, \"https://api.test.fincode.jp/v1/business_payments/request\", bytes.NewBuffer(body))\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer \")\n req.Header.Set(\"Content-Type\", \"application/json\")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n resp, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": " 'bp_abcdefghijklmnopqrstuv',\n]);\n\n$ch = curl_init('https://api.test.fincode.jp/v1/business_payments/request');\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n 'Authorization: Bearer ',\n 'Content-Type: application/json',\n 'Tenant-Buyer-Id: b_***********'\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $payload);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/business_payments/request'\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Tenant-Buyer-Id': 'b_***********'\n 'Content-Type': 'application/json'\n}\ndata = {\n 'access_id': 'bp_abcdefghijklmnopqrstuv'\n}\n\nresponse = requests.put(url, headers=headers, json=data)\nprint(response.text)\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\nrequire \"json\"\n\nuri = URI.parse(\"https://api.test.fincode.jp/v1/business_payments/request\")\nrequest = Net::HTTP::Put.new(uri)\nrequest[\"Authorization\"] = \"Bearer \"\nrequest[\"Tenant-Buyer-Id\"] = \"b_***********\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = {\n access_id: \"bp_abcdefghijklmnopqrstuv\"\n}.to_json\n\nresponse = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\nputs response.body\n"
}
]
}
},
"/v1/business_payments/auth": {
"put": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "authorizeBusinessPayment",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払いオーソリ依頼",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\n"
}
],
"description": "請求書カード払いオーソリ依頼を行います。\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Authorizing.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Authorizing.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X PUT \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n -d '{\n \"p\": \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh\"\n}' \\\n'https://api.test.fincode.jp/v1/business_payments/auth'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\n\n(async () => {\n const response = await fetch(\n \"https://api.test.fincode.jp/v1/business_payments/auth\",\n {\n method: \"PUT\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"application/json\",\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n body: JSON.stringify({\n p: \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh\",\n }),\n },\n );\n\n const data = await response.json();\n console.log(data);\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"bytes\"\n \"fmt\"\n \"io\"\n \"net/http\"\n)\n\nfunc main() {\n body := []byte(`{\"p\": \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh\"}`)\n\n req, err := http.NewRequest(http.MethodPut, \"https://api.test.fincode.jp/v1/business_payments/auth\", bytes.NewBuffer(body))\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer \")\n req.Header.Set(\"Content-Type\", \"application/json\")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n resp, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": " 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh',\n]);\n\n$ch = curl_init('https://api.test.fincode.jp/v1/business_payments/auth');\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n 'Authorization: Bearer ',\n 'Content-Type: application/json',\n 'Tenant-Buyer-Id: b_***********'\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $payload);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/business_payments/auth'\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n 'Tenant-Buyer-Id': 'b_***********'\n}\ndata = {\n 'p': 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh'\n}\n\nresponse = requests.put(url, headers=headers, json=data)\nprint(response.text)\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\nrequire \"json\"\n\nuri = URI.parse(\"https://api.test.fincode.jp/v1/business_payments/auth\")\nrequest = Net::HTTP::Put.new(uri)\nrequest[\"Authorization\"] = \"Bearer \"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest[\"Tenant-Buyer-Id\"] = \"b_***********\"\nrequest.body = {\n p: \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh\"\n}.to_json\n\nresponse = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\nputs response.body\n"
}
]
}
},
"/v1/business_payments/business": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBusinessPaymentBusiness",
"tags": [
"請求書カード払い"
],
"summary": "請求書カード払い事業者情報取得",
"description": "請求書カード払い事業者情報を取得します。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの請求書カード払い事業者情報を取得します。\n"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayment.Business"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n -H \"Tenant-Buyer-Id: b_***********\" \\\n'https://api.test.fincode.jp/v1/business_payments/business'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\n\n(async () => {\n const response = await fetch(\"https://api.test.fincode.jp/v1/business_payments/business\", {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Tenant-Buyer-Id\": \"b_***********\",\n },\n });\n\n const data = await response.json();\n console.log(data);\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n)\n\nfunc main() {\n req, err := http.NewRequest(http.MethodGet, \"https://api.test.fincode.jp/v1/business_payments/business\", nil)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer \")\n req.Header.Set(\"Tenant-Buyer-Id\", \"b_***********\")\n\n resp, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n body, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(body))\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "',\n 'Tenant-Buyer-Id: b_***********'\n]);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\ncurl_close($ch);\n\necho $response;\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "from urllib.request import Request, urlopen\n\nrequest = Request(\n \"https://api.test.fincode.jp/v1/business_payments/business\",\n headers={\n \"Authorization\": \"Bearer \",\n 'Tenant-Buyer-Id': 'b_***********'\n },\n method=\"GET\",\n)\n\nwith urlopen(request) as response:\n print(response.read().decode(\"utf-8\"))\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require \"net/http\"\nrequire \"uri\"\n\nuri = URI.parse(\"https://api.test.fincode.jp/v1/business_payments/business\")\nrequest = Net::HTTP::Get.new(uri)\nrequest[\"Authorization\"] = \"Bearer \"\nrequest[\"Tenant-Buyer-Id\"] = \"b_***********\"\n\nresponse = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|\n http.request(request)\nend\n\nputs response.body\n"
}
]
}
},
"/v1/buyer_platform/tenants": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"tags": [
"テナントバイヤー"
],
"operationId": "retrieveTenantBuyerList",
"summary": "テナントバイヤー 一覧取得",
"description": "テナントバイヤーを一覧で取得します。\\\nクエリパラメータを指定して取得する条件を絞り込めます。\n",
"parameters": [
{
"name": "クエリ",
"in": "query",
"description": "テナントバイヤー情報の一覧取得において検索条件となるクエリパラメータ\n",
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination.QueryParams"
},
{
"$ref": "#/components/schemas/TenantBuyer.ListRetrieving.QueryParams"
}
]
}
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantBuyer.ListRetrieving.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/buyer_platform/tenants'\n\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\n\n(async () => {\n const response = await fetch(\"https://api.test.fincode.jp/v1/buyer_platform/tenants?limit=10\", {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n },\n });\n\n const data = await response.json();\n console.log(data);\n})();\n\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tapiKey := \"\"\n\n\treq, _ := http.NewRequest(\"GET\", \"https://api.test.fincode.jp/v1/buyer_platform/tenants\", nil)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\n\tparams := req.URL.Query()\n\tparams.Add(\"limit\", \"10\")\n\treq.URL.RawQuery = params.Encode()\n\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n}\n\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer_platform/tenants\";\n$queryParams = [\n \"limit\" => 10,\n];\n\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint . '?' . http_build_query($queryParams));\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n echo \"cURL Error: \" . curl_error($session);\n} else {\n var_dump($response);\n}\n\ncurl_close($session);\n\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/buyer_platform/tenants'\nquery_params = {\n 'limit': '10',\n}\n\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\ntry:\n response = requests.get(url, headers=headers, params=query_params)\n\n if response.status_code == 200:\n print(f\"Success: {response.json()}\")\n else:\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n print(f\"Request error: {e}\")\n\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = '/v1/buyer_platform/tenants'\n query_params = { limit: 10 }\n\n uri = URI.parse(BASE_URL + endpoint)\n uri.query = URI.encode_www_form(query_params)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n puts response.body\nend\n\nmain\n\n"
}
]
}
},
"/v1/buyer_platform/tenants/{id}": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"tags": [
"テナントバイヤー"
],
"operationId": "retrieveTenantBuyer",
"summary": "テナントバイヤー 取得",
"description": "`id`で指定したテナントバイヤー情報を取得します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "バイヤーID\n",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
}
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantBuyer.Retrieving.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/buyer_platform/tenants/{id}'\n\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst TENANT_BUYER_ID = \"\";\n\n(async () => {\n const response = await fetch(`https://api.test.fincode.jp/v1/buyer_platform/tenants/${TENANT_BUYER_ID}`, {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n },\n });\n\n const data = await response.json();\n console.log(data);\n})();\n\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tapiKey := \"\"\n\ttenantBuyerID := \"\"\n\n\treq, _ := http.NewRequest(\n\t\t\"GET\",\n\t\tfmt.Sprintf(\"https://api.test.fincode.jp/v1/buyer_platform/tenants/%s\", tenantBuyerID),\n\t\tnil,\n\t)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n}\n\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n$tenantBuyerId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer_platform/tenants/{$tenantBuyerId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n echo \"cURL Error: \" . curl_error($session);\n} else {\n var_dump($response);\n}\n\ncurl_close($session);\n\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\ntenant_buyer_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/buyer_platform/tenants/{tenant_buyer_id}'\n\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\ntry:\n response = requests.get(url, headers=headers)\n\n if response.status_code == 200:\n print(f\"Success: {response.json()}\")\n else:\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n print(f\"Request error: {e}\")\n\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n tenant_buyer_id = ''\n endpoint = \"/v1/buyer_platform/tenants/#{tenant_buyer_id}\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n puts response.body\nend\n\nmain\n\n"
}
]
}
},
"/v1/buyer_platform/tenant_entries": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "createTenantBuyerWithNewUser",
"tags": [
"テナントバイヤー申請管理"
],
"summary": "テナントバイヤー 作成（新規ユーザー登録）",
"description": "新規ユーザーを作成し、作成されたユーザーをオーナーとして新規テナントバイヤーを作成するAPIです。\\\nこのAPIでのテナントバイヤー作成に成功すると、登録されたメールアドレス宛にメールアドレス認証メールが送信されます。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/POST.BuyerPlatformTenantEntries.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/POST.BuyerPlatformTenantEntries.Response.business_operator"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X POST \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"\",\n \"password\": \"\",\n \"name\": \"\",\n \"tenant_url_id\": \"\"\n}' \\\n'https://api.test.fincode.jp/v1/buyer_platform/tenant_entries'\n\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\n\n(async () => {\n const response = await fetch(\"https://api.test.fincode.jp/v1/buyer_platform/tenant_entries\", {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"application/json\",\n },\n body: JSON.stringify({\n email: \"new-user@example.com\",\n password: \"new-user-password\",\n name: \"New User\",\n tenant_url_id: \"\",\n }),\n });\n\n const data = await response.json();\n console.log(data);\n})();\n\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tapiKey := \"\"\n\n\tbody := CreatingTenantBuyerWithNewUserRequest{\n\t\tEmail: \"new-user@example.com\",\n\t\tPassword: \"new-user-password\",\n\t\tName: \"New User\",\n\t\tTenantURLID: \"\",\n\t}\n\n\tmarshalledBody, _ := json.Marshal(body)\n\n\treq, _ := http.NewRequest(\"POST\", \"https://api.test.fincode.jp/v1/buyer_platform/tenant_entries\", bytes.NewBuffer(marshalledBody))\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n}\n\ntype CreatingTenantBuyerWithNewUserRequest struct {\n\tEmail string `json:\"email\"`\n\tPassword string `json:\"password\"`\n\tName string `json:\"name\"`\n\tTenantURLID string `json:\"tenant_url_id\"`\n}\n\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer_platform/tenant_entries\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\"\n];\n\n$data = json_encode([\n \"email\" => \"new-user@example.com\",\n \"password\" => \"new-user-password\",\n \"name\" => \"New User\",\n \"tenant_url_id\" => \"\",\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_POST, true);\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n echo \"cURL Error: \" . curl_error($session);\n} else {\n var_dump($response);\n}\n\ncurl_close($session);\n\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = 'https://api.test.fincode.jp/v1/buyer_platform/tenant_entries'\n\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n}\n\ndata = {\n 'email': 'new-user@example.com',\n 'password': 'new-user-password',\n 'name': 'New User',\n 'tenant_url_id': ''\n}\n\ntry:\n response = requests.post(url, headers=headers, json=data)\n\n if response.status_code == 200:\n print(f\"Success: {response.json()}\")\n else:\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n print(f\"Request error: {e}\")\n\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = '/v1/buyer_platform/tenant_entries'\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n email: 'new-user@example.com',\n password: 'new-user-password',\n name: 'New User',\n tenant_url_id: ''\n }\n\n request = Net::HTTP::Post.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n request.body = data.to_json\n\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n puts response.body\nend\n\nmain\n\n"
}
]
}
},
"/v1/buyer_platform/join_tenants": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "createTenantBuyerWithExistingUser",
"tags": [
"テナントバイヤー申請管理"
],
"summary": "テナントバイヤー 作成（既存ユーザー参加）",
"description": "指定したバイヤープラットフォームのユーザーを新規テナントバイヤーのオーナーとして新規テナントバイヤーを作成するAPIです。\\\n\\\n`password`パラメータに関して、ユーザーのパスワードがM's PayBridge管理画面アプリケーション上で更新されることを想定して実装・運用することが推奨されます。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/POST.BuyerPlatformJoinTenants.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/POST.BuyerPlatformJoinTenants.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X POST \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"email\": \"platform-user@example.com\",\n \"password\": \"platform-user-password\",\n \"tenant_buyer_url_id\": \"\"\n}' \\\n'https://api.test.fincode.jp/v1/buyer_platform/join_tenants'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n try {\n // リクエストの送信\n const tenantShop = await fincode.tenants.createWithExistingUser({\n email: \"existing-user@example.com\",\n password: \"existing-user-password\",\n tenant_buyer_url_id: \"\",\n });\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\tbody := CreatingTenantWithNewUserRequest{\n\t\tEmail: \"new-user@example.com\",\n\t\tPassword: \"new-user-password\",\n\t\tName: \"New User\",\n\t}\n\n\tmarshalledBody, _ := json.Marshal(body)\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"POST\", \"https://api.test.fincode.jp/v1/buyer_platform/join_tenants\", bytes.NewBuffer(marshalledBody))\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n}\n\ntype CreatingTenantWithNewUserRequest struct {\n\tEmail string `json:\"email\"`\n\tPassword string `json:\"password\"`\n\tName string `json:\"name\"`\n\tTenantBuyerUrlId string `json:\"tenant_buyer_url_id\"`\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer_platform/join_tenants\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\"\n];\n\n$data = json_encode([\n \"email\" => \"platform-user@example.com\",\n \"password\" => \"platform-user-password\",\n \"tenant_buyer_url_id\" => \"\"\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_POST, true);\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = f'https://api.test.fincode.jp/v1/buyer_platform/join_tenants'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n}\n\ndata = {\n \"email\": \"platform-user@example.com\",\n \"password\": \"platform-user-password\",\n \"tenant_buyer_url_id\": \"\"\n}\n\n# HTTP POSTリクエストの送信\ntry:\n response = requests.post(url, headers=headers, json=data)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = \"/v1/buyer_platform/join_tenants\"\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n email: \"platform-user@example.com\",\n password: \"platform-user-password\",\n tenant_buyer_url_id: \"\"\n }\n\n # リクエストの作成\n request = Net::HTTP::Post.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n\n request.body = data.to_json\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/v1/buyer/contracts/{id}": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBuyerContract",
"tags": [
"テナントバイヤー申請管理"
],
"summary": "テナントバイヤー契約情報 取得",
"description": "`id`で指定したテナントバイヤーの契約情報を取得します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "指定したテナントバイヤーの契約情報を取得します。`Tenant-Buyer-Id`ヘッダーも併せて指定してください。\n",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"required": true
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ プラットフォームのメインショップのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの契約情報を取得します。\n"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerContracts.Retrieving.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n -H \"Tenant-Buyer-Id: \" \\\n'https://api.test.fincode.jp/v1/buyer/contracts/{Tenant Buyer ID}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst TENANT_BUYER_ID = \"\";\nconst BUYER_ID = \"\";\n\n(async () => {\n try {\n const response = await fetch(\n `https://api.test.fincode.jp/v1/buyer/contracts/${BUYER_ID}`,\n {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Tenant-Buyer-Id\": TENANT_BUYER_ID,\n },\n }\n );\n\n const data = await response.json();\n console.log(data);\n } catch (e) {\n console.error(e);\n }\n})();"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\tbuyerId := \"\"\n\ttenantBuyerID := \"\"\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"GET\", fmt.Sprintf(\"https://api.test.fincode.jp/v1/buyer/contracts/%s\", buyerId), nil)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Tenant-Buyer-Id\", tenantBuyerID)\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$buyerId = '';\n$tenantBuyerId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer/contracts/{$buyerId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Tenant-Buyer-Id: \" . $tenantBuyerId,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nbuyer_id = ''\ntenant_buyer_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/buyer/contracts/{buyer_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Tenant-Buyer-Id': tenant_buyer_id,\n}\n\ntry:\n response = requests.get(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n buyer_id = ''\n tenant_buyer_id = ''\n endpoint = \"/v1/buyer/contracts/#{buyer_id}\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Tenant-Buyer-Id'] = tenant_buyer_id\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/v1/buyer/contracts/examinations": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "requestBuyerProductionEnvironment",
"tags": [
"テナントバイヤー申請管理"
],
"summary": "テナントバイヤー 本番環境申請",
"description": "`id`で指定したテナントバイヤーの本番環境の利用申請を行います。このAPIを呼び出すまでにテナントバイヤー本番環境申請情報 更新APIで申請情報を用意しておく必要があります。\n",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ プラットフォームのメインショップのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーのものとして申請情報を登録します。\n"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/POST.BuyerContractsExaminations.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/POST.BuyerContractsExaminations.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X POST \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Tenant-Buyer-Id: \" \\\n -d '{\n \"buyer_id\": \"\",\n \"force_credit_check_skip\": false\n}' \\\n'https://api.test.fincode.jp/v1/buyer/contracts/examinations'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst TENANT_BUYER_ID = \"\";\nconst BUYER_ID = \"\";\n\n(async () => {\n try {\n const response = await fetch(\n \"https://api.test.fincode.jp/v1/buyer/contracts/examinations\",\n {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Tenant-Buyer-Id\": TENANT_BUYER_ID,\n \"Content-Type\": \"application/json\",\n },\n body: JSON.stringify({\n buyer_id: BUYER_ID,\n force_credit_check_skip: false,\n }),\n }\n );\n\n const data = await response.json();\n console.log(data);\n } catch (e) {\n console.error(e);\n }\n})();"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\ttenantBuyerID := \"\"\n\n\tbody := RequestExaminationRequestBody{\n\t\tBuyerID: \"\",\n\t\tEnableImmediateUse: false,\n\t}\n\n\tmarshalledBody, _ := json.Marshal(body)\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"POST\", \"https://api.test.fincode.jp/v1/buyer/contracts/examinations\", bytes.NewBuffer(marshalledBody))\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\treq.Header.Set(\"Tenant-Buyer-Id\", tenantBuyerID)\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n\ntype RequestExaminationRequestBody struct {\n\tBuyerID string `json:\"buyer_id\"`\n\tEnableImmediateUse bool `json:\"enable_immediate_use\"`\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$tenantBuyerId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer/contracts/examinations\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\",\n \"Tenant-Buyer-Id: \" . $tenantBuyerId,\n];\n\n$data = json_encode([\n \"buyer_id\" => \"b_***********\",\n \"force_credit_check_skip\" => \"false\",\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_POST, true);\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\ntenant_buyer_id = ''\nurl = f'https://api.test.fincode.jp/v1/buyer/contracts/examinations'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json',\n 'Tenant-Buyer-Id': tenant_buyer_id,\n}\n\ndata = {\n \"buyer_id\": \"\",\n \"force_credit_check_skip\": \"false\",\n}\n\n# HTTP POSTリクエストの送信\ntry:\n response = requests.post(url, headers=headers, json=data)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n tenant_buyer_id = ''\n\n endpoint = \"/v1/buyer/contracts/examinations\"\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n buyer_id: '',\n force_credit_check_skip: false,\n }\n\n # リクエストの作成\n request = Net::HTTP::Post.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n request['Tenant-Buyer-Id'] = tenant_buyer_id\n\n request.body = data.to_json\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/v1/buyer/contracts/examinations/{id}": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBuyerExaminationInfo",
"tags": [
"テナントバイヤー申請管理"
],
"summary": "テナントバイヤー本番環境申請情報 取得",
"description": "`id`で指定したテナントバイヤーの本番環境申請情報を取得します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "指定したテナントバイヤーの本番環境申請情報を取得します。`Tenant-Buyer-Id`ヘッダーも併せて指定してください。\n",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"required": true
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ プラットフォームのメインショップのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの本番環境申請情報を取得します。\n"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerExaminationInfo.Retrieving.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n -H \"Tenant-Buyer-Id: \" \\\n'https://api.test.fincode.jp/v1/buyer/contracts/examinations/{Tenant Buyer ID}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst TENANT_BUYER_ID = \"\";\nconst BUYER_ID = \"\";\n\n(async () => {\n try {\n const response = await fetch(\n `https://api.test.fincode.jp/v1/buyer/contracts/examinations/${BUYER_ID}`,\n {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Tenant-Buyer-Id\": TENANT_BUYER_ID,\n },\n }\n );\n\n const data = await response.json();\n console.log(data);\n } catch (e) {\n console.error(e);\n }\n})();"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n buyerId := \"\"\n\ttenantBuyerID := \"\"\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"GET\", fmt.Sprintf(\"https://api.test.fincode.jp/v1/buyer/contracts/examinations/%s\", buyerId), nil)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Tenant-Buyer-Id\", tenantBuyerID)\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$buyerId = '';\n$tenantBuyerId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer/contracts/examinations/{$buyerId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Tenant-Buyer-Id: \" . $tenantBuyerId,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nbuyer_id = ''\ntenant_buyer_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/buyer/contracts/examinations/{buyer_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Tenant-Buyer-Id': tenant_buyer_id,\n}\n\ntry:\n response = requests.get(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n buyer_id = ''\n tenant_buyer_id = ''\n endpoint = \"/v1/buyer/contracts/examinations/#{buyer_id}\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Tenant-Buyer-Id'] = tenant_buyer_id\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
},
"put": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "updateBuyerExaminationInfo",
"tags": [
"テナントバイヤー申請管理"
],
"summary": "テナントバイヤー本番環境申請情報 更新",
"description": "`id`で指定したテナントバイヤーの本番環境申請情報を更新します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "指定したテナントバイヤーの本番環境申請情報を更新します。`Tenant-Buyer-Id`ヘッダーも併せて指定してください。\n",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"required": true
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ プラットフォームのメインショップのみ指定可\\\nテナントバイヤーID。\\\n指定したテナントバイヤーの本番環境申請情報を更新します。\n"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerExaminationInfo.Updating.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerExaminationInfo.Updating.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X PUT \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Tenant-Buyer-Id: \" \\\n -d '{\n \"corporate_number\": \"1234567890123\",\n \"contract_info\": {\n \"representative_last_name\": \"山田\",\n \"representative_last_name_kana\": \"ヤマダ\",\n \"representative_first_name\": \"太郎\",\n \"representative_first_name_kana\": \"タロウ\",\n \"representative_birthday\": \"1998/11/01\",\n \"representative_tel\": \"0312345678\",\n \"representative_postal_code\": \"123-4567\",\n \"representative_prefecture\": \"東京都\",\n \"representative_prefecture_kana\": \"トウキョウト\",\n \"representative_address_municipality\": \"渋谷区\",\n \"representative_address_municipality_kana\": \"シブヤク\",\n \"representative_address_section\": \"道玄坂\",\n \"representative_address_section_kana\": \"ドウゲンザカ\",\n \"representative_address_chrome\": \"1-2-3\",\n \"representative_address_chrome_kana\": \"イチニサン\",\n \"representative_address_building_name\": \"テストビル\",\n \"representative_address_building_name_kana\": \"テストビル\",\n \"staff1_last_name\": \"鈴木\",\n \"staff1_last_name_kana\": \"スズキ\",\n \"staff1_first_name\": \"次郎\",\n \"staff1_first_name_kana\": \"ジロウ\",\n \"staff1_company_name\": \"株式会社テスト\",\n \"staff1_belongs\": \"EC運営部\",\n \"staff1_tel\": \"08012345678\",\n \"staff1_mail\": \"staff-1@example.com\",\n \"content_description\": \"○○の販売\",\n \"corporate\": true,\n \"expect_usage_amount\": 1000000,\n \"corporate_info\": {\n \"company_tel\": \"0312345678\",\n \"corporate_name\": \"株式会社テスト\",\n \"corporate_name_kana\": \"カブシキガイシャテスト\",\n \"hp\": \"https://example.com\",\n \"company_postal_code\": \"123-4567\",\n \"company_prefecture\": \"東京都\",\n \"company_prefecture_kana\": \"トウキョウト\",\n \"company_address_municipality\": \"渋谷区\",\n \"company_address_municipality_kana\": \"シブヤク\",\n \"company_address_section\": \"道玄坂\",\n \"company_address_section_kana\": \"ドウゲンザカ\",\n \"company_address_chrome\": \"1-2-3\",\n \"company_address_chrome_kana\": \"イチニサン\",\n \"company_address_building_name\": \"テストビル\",\n \"company_address_building_name_kana\": \"テストビル\"\n }\n },\n \"business_operator_bank_account_info\": {\n \"bank_code\": \"0001\",\n \"branch_code\": \"001\",\n \"account_kind\": 1,\n \"account_number\": \"1234567\",\n \"account_name\": \"ヤマダタロウ\"\n }\n}' \\\n'https://api.test.fincode.jp/v1/buyer/contracts/examinations/{Tenant Buyer ID}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "const API_KEY = \"\";\nconst TENANT_BUYER_ID = \"\";\nconst BUYER_ID = \"\";\n\n(async () => {\n try {\n const response = await fetch(\n `https://api.test.fincode.jp/v1/buyer/contracts/examinations/${BUYER_ID}`,\n {\n method: \"PUT\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n \"Content-Type\": \"application/json\",\n \"Tenant-Buyer-Id\": TENANT_BUYER_ID,\n },\n body: JSON.stringify({\n corporate_number: \"1234567890123\",\n contract_info: {\n corporate: true,\n corporate_info: {\n corporate_name: \"株式会社テスト\",\n corporate_name_kana: \"カブシキガイシャテスト\",\n hp: \"https://example.com\",\n company_prefecture: \"東京都\",\n company_prefecture_kana: \"トウキョウト\",\n company_address_municipality: \"渋谷区\",\n company_address_municipality_kana: \"シブヤク\",\n company_address_section: \"道玄坂\",\n company_address_section_kana: \"ドウゲンザカ\",\n company_address_chrome: \"1-2-3\",\n company_address_chrome_kana: \"イチニサン\",\n company_tel: \"0312345678\",\n company_postal_code: \"123-4567\",\n },\n representative_first_name: \"山田\",\n representative_first_name_kana: \"ヤマダ\",\n representative_last_name: \"太郎\",\n representative_last_name_kana: \"タロウ\",\n representative_postal_code: \"123-4567\",\n representative_prefecture: \"東京都\",\n representative_prefecture_kana: \"トウキョウト\",\n representative_address_municipality: \"渋谷区\",\n representative_address_municipality_kana: \"シブヤク\",\n representative_address_section: \"道玄坂\",\n representative_address_section_kana: \"ドウゲンザカ\",\n representative_address_chrome: \"1-2-3\",\n representative_address_chrome_kana: \"イチニサン\",\n representative_tel: \"0312345678\",\n representative_birthday: \"1998/11/01\",\n staff1_first_name: \"鈴木\",\n staff1_first_name_kana: \"スズキ\",\n staff1_last_name: \"次郎\",\n staff1_last_name_kana: \"ジロウ\",\n staff1_company_name: \"株式会社テスト\",\n staff1_belongs: \"EC運営部\",\n staff1_tel: \"08012345678\",\n staff1_mail: \"staff-1@example.com\",\n },\n business_operator_bank_account_info: {\n bank_code: \"0001\",\n branch_code: \"001\",\n account_kind: 1,\n account_number: \"1234567\",\n account_name: \"ヤマダタロウ\",\n },\n }),\n }\n );\n\n const data = await response.json();\n console.log(data);\n } catch (e) {\n console.error(e);\n }\n})();"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n buyerId := \"\"\n\ttenantBuyerID := \"\"\n\n\tbody := UpdatingExaminationInfoRequest{\n\t\tCorporateNumber: \"1234567890123\",\n\t\tContractInfo: ContractInfo{\n\t\t\tRepresentativeLastName: \"山田\",\n\t\t\tRepresentativeLastNameKana: \"ヤマダ\",\n\t\t\tRepresentativeFirstName: \"太郎\",\n\t\t\tRepresentativeFirstNameKana: \"タロウ\",\n\t\t\tRepresentativePostalCode: \"123-4567\",\n\t\t\tRepresentativePrefecture: \"東京都\",\n\t\t\tRepresentativePrefectureKana: \"トウキョウト\",\n\t\t\tRepresentativeAddressMunicipality: \"渋谷区\",\n\t\t\tRepresentativeAddressMunicipalityKana: \"シブヤク\",\n\t\t\tRepresentativeAddressSection: \"道玄坂\",\n\t\t\tRepresentativeAddressSectionKana: \"ドウゲンザカ\",\n\t\t\tRepresentativeAddressChrome: \"1-2-3\",\n\t\t\tRepresentativeAddressChromeKana: \"イチニサン\",\n\t\t\tRepresentativeTel: \"0312345678\",\n\t\t\tRepresentativeBirthday: \"1998/11/01\",\n\t\t\tStaff1LastName: \"鈴木\",\n\t\t\tStaff1LastNameKana: \"スズキ\",\n\t\t\tStaff1FirstName: \"次郎\",\n\t\t\tStaff1FirstNameKana: \"ジロウ\",\n\t\t\tStaff1CompanyName: \"株式会社テスト\",\n\t\t\tStaff1Belongs: \"EC運営部\",\n\t\t\tStaff1Tel: \"08012345678\",\n\t\t\tStaff1Mail: \"staff-1@example.com\",\n\t\t\tCorporate: true,\n\t\t\tExpectUsageAmount: \"1000000\",\n\t\t\tCorporateInfo: CorporateInfo{\n\t\t\t\tCorporateName: \"株式会社テスト\",\n\t\t\t\tCorporateNameKana: \"カブシキガイシャテスト\",\n\t\t\t\tHp: \"https://www.test.co.jp\",\n\t\t\t\tCompanyPostalCode: \"123-4567\",\n\t\t\t\tCompanyPrefecture: \"東京都\",\n\t\t\t\tCompanyPrefectureKana: \"トウキョウト\",\n\t\t\t\tCompanyAddressMunicipality: \"渋谷区\",\n\t\t\t\tCompanyAddressMunicipalityKana: \"シブヤク\",\n\t\t\t\tCompanyAddressSection: \"道玄坂\",\n\t\t\t\tCompanyAddressSectionKana: \"ドウゲンザカ\",\n\t\t\t\tCompanyAddressChrome: \"1-2-3\",\n\t\t\t\tCompanyAddressChromeKana: \"イチニサン\",\n\t\t\t\tCompanyTel: \"0312345678\",\n\t\t\t},\n\t\t},\n\t\tBusinessOperatorBankAccountInfo: BusinessOperatorBankAccountInfo{\n\t\t\tBankCode: \"0001\",\n\t\t\tBranchCode: \"001\",\n\t\t\tAccountKind: \"1\",\n\t\t\tAccountNumber: \"1234567\",\n\t\t\tAccountName: \"ヤマダタロウ\",\n\t\t},\n\t}\n\n\tmarshalledBody, _ := json.Marshal(body)\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"PUT\", fmt.Sprintf(\"https://api.test.fincode.jp/v1/buyer/contracts/examinations/%s\", buyerId), bytes.NewBuffer(marshalledBody))\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\treq.Header.Set(\"Tenant-Buyer-Id\", tenantBuyerID)\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n\ntype UpdatingExaminationInfoRequest struct {\n\tCorporateNumber string `json:\"corporate_number\"`\n\tContractInfo ContractInfo `json:\"contract_info\"`\n\tBusinessOperatorBankAccountInfo BusinessOperatorBankAccountInfo `json:\"business_operator_bank_account_info\"`\n}\n\ntype BusinessOperatorBankAccountInfo struct {\n\tBankCode string `json:\"bank_code\"`\n\tBranchCode string `json:\"branch_code\"`\n\tAccountKind string `json:\"account_kind\"`\n\tAccountNumber string `json:\"account_number\"`\n\tAccountName string `json:\"account_name\"`\n}\ntype ContractInfo struct {\n\tRepresentativeLastName string `json:\"representative_last_name\"`\n\tRepresentativeLastNameKana string `json:\"representative_last_name_kana\"`\n\tRepresentativeFirstName string `json:\"representative_first_name\"`\n\tRepresentativeFirstNameKana string `json:\"representative_first_name_kana\"`\n\tRepresentativePostalCode string `json:\"representative_postal_code\"`\n\tRepresentativePrefecture string `json:\"representative_prefecture\"`\n\tRepresentativePrefectureKana string `json:\"representative_prefecture_kana\"`\n\tRepresentativeAddressMunicipality string `json:\"representative_address_municipality\"`\n\tRepresentativeAddressMunicipalityKana string `json:\"representative_address_municipality_kana\"`\n\tRepresentativeAddressSection string `json:\"representative_address_section\"`\n\tRepresentativeAddressSectionKana string `json:\"representative_address_section_kana\"`\n\tRepresentativeAddressChrome string `json:\"representative_address_chrome\"`\n\tRepresentativeAddressChromeKana string `json:\"representative_address_chrome_kana\"`\n\tRepresentativeAddressBuildingName *string `json:\"representative_address_building_name,omitempty\"`\n\tRepresentativeAddressBuildingNameKana *string `json:\"representative_address_building_name_kana,omitempty\"`\n\tRepresentativeTel string `json:\"representative_tel\"`\n\tRepresentativeBirthday string `json:\"representative_birthday\"`\n\tStaff1LastName string `json:\"staff1_last_name\"`\n\tStaff1LastNameKana string `json:\"staff1_last_name_kana\"`\n\tStaff1FirstName string `json:\"staff1_first_name\"`\n\tStaff1FirstNameKana string `json:\"staff1_first_name_kana\"`\n\tStaff1CompanyName string `json:\"staff1_company_name\"`\n\tStaff1Belongs string `json:\"staff1_belongs\"`\n\tStaff1Tel string `json:\"staff1_tel\"`\n\tStaff1Mail string `json:\"staff1_mail\"`\n\tCorporate bool `json:\"corporate\"`\n\tExpectUsageAmount int `json:\"expect_usage_amount\"`\n\tCorporateInfo CorporateInfo `json:\"corporate_info\"`\n}\ntype CorporateInfo struct {\n\tCorporateNumber string `json:\"corporate_number\"`\n\tCorporateName string `json:\"corporate_name\"`\n\tCorporateNameKana string `json:\"corporate_name_kana\"`\n\tCompanyPostalCode string `json:\"company_postal_code\"`\n\tCompanyPrefecture string `json:\"company_prefecture\"`\n\tCompanyPrefectureKana string `json:\"company_prefecture_kana\"`\n\tCompanyAddressMunicipality string `json:\"company_address_municipality\"`\n\tCompanyAddressMunicipalityKana string `json:\"company_address_municipality_kana\"`\n\tCompanyAddressSection string `json:\"company_address_section\"`\n\tCompanyAddressSectionKana string `json:\"company_address_section_kana\"`\n\tCompanyAddressChrome string `json:\"company_address_chrome\"`\n\tCompanyAddressChromeKana string `json:\"company_address_chrome_kana\"`\n\tCompanyAddressBuildingName *string `json:\"company_address_building_name,omitempty\"`\n\tCompanyAddressBuildingNameKana *string `json:\"company_address_building_name_kana,omitempty\"`\n\tCompanyTel string `json:\"company_tel\"`\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$buyerId = '';\n$tenantBuyerId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer/contracts/examinations/{$buyerId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\",\n \"Tenant-Buyer-Id: \" . $tenantBuyerId,\n];\n\n$data = json_encode([\n \"corporate_number\" => \"1234567890123\",\n \"contract_info\" => [\n \"representative_last_name\" => \"山田\",\n \"representative_last_name_kana\" => \"ヤマダ\",\n \"representative_first_name\" => \"太郎\",\n \"representative_first_name_kana\" => \"タロウ\",\n \"representative_postal_code\" => \"123-4567\",\n \"representative_prefecture\" => \"東京都\",\n \"representative_prefecture_kana\" => \"トウキョウト\",\n \"representative_address_municipality\" => \"渋谷区\",\n \"representative_address_municipality_kana\" => \"シブヤク\",\n \"representative_address_section\" => \"道玄坂\",\n \"representative_address_section_kana\" => \"ドウゲンザカ\",\n \"representative_address_chrome\" => \"1-2-3\",\n \"representative_address_chrome_kana\" => \"イチニサン\",\n \"representative_tel\" => \"0312345678\",\n \"representative_birthday\" => \"1998/11/01\",\n \"staff1_last_name\" => \"鈴木\",\n \"staff1_last_name_kana\" => \"スズキ\",\n \"staff1_first_name\" => \"次郎\",\n \"staff1_first_name_kana\" => \"ジロウ\",\n \"staff1_company_name\" => \"株式会社テスト\",\n \"staff1_belongs\" => \"EC運営部\",\n \"staff1_tel\" => \"08012345678\",\n \"staff1_mail\" => \"staff-1@example.com\",\n \"corporate\" => true,\n \"expect_usage_amount\" => \"1000000\",\n \"corporate_info\" => [\n \"corporate_name\" => \"株式会社テスト\",\n \"corporate_name_kana\" => \"カブシキガイシャテスト\",\n \"hp\" => \"https://www.test.com\",\n \"company_postal_code\" => \"123-4567\",\n \"company_prefecture\" => \"東京都\",\n \"company_prefecture_kana\" => \"トウキョウト\",\n \"company_address_municipality\" => \"渋谷区\",\n \"company_address_municipality_kana\" => \"シブヤク\",\n \"company_address_section\" => \"道玄坂\",\n \"company_address_section_kana\" => \"ドウゲンザカ\",\n \"company_address_chrome\" => \"1-2-3\",\n \"company_address_chrome_kana\" => \"イチニサン\",\n \"company_tel\" => \"0312345678\"\n ]\n ],\n \"business_operator_bank_account_info\" => [\n \"bank_code\" => \"0001\",\n \"branch_code\" => \"001\",\n \"account_kind\" => \"1\",\n \"account_number\" => \"1234567\",\n \"account_name\" => \"ヤマダタロウ\"\n ]\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_CUSTOMREQUEST, 'PUT');\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nbuyer_id = ''\ntenant_buyer_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/buyer/contracts/examinations/{buyer_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json',\n 'Tenant-Buyer-Id': tenant_buyer_id,\n}\n\ndata = {\n \"corporate_number\": \"1234567890123\",\n \"contract_info\": {\n \"representative_last_name\": \"山田\",\n \"representative_last_name_kana\": \"ヤマダ\",\n \"representative_first_name\": \"太郎\",\n \"representative_first_name_kana\": \"タロウ\",\n \"representative_postal_code\": \"123-4567\",\n \"representative_prefecture\": \"東京都\",\n \"representative_prefecture_kana\": \"トウキョウト\",\n \"representative_address_municipality\": \"渋谷区\",\n \"representative_address_municipality_kana\": \"シブヤク\",\n \"representative_address_section\": \"道玄坂\",\n \"representative_address_section_kana\": \"ドウゲンザカ\",\n \"representative_address_chrome\": \"1-2-3\",\n \"representative_address_chrome_kana\": \"イチニサン\",\n \"representative_tel\": \"0312345678\",\n \"representative_birthday\": \"1998/11/01\",\n \"staff1_last_name\": \"鈴木\",\n \"staff1_last_name_kana\": \"スズキ\",\n \"staff1_first_name\": \"次郎\",\n \"staff1_first_name_kana\": \"ジロウ\",\n \"staff1_company_name\": \"株式会社テスト\",\n \"staff1_belongs\": \"EC運営部\",\n \"staff1_tel\": \"08012345678\",\n \"staff1_mail\": \"staff-1@example.com\",\n \"corporate\": True,\n \"corporate_info\": {\n \"corporate_number\": \"1234567890123\",\n \"corporate_name\": \"株式会社テスト\",\n \"corporate_name_kana\": \"カブシキガイシャテスト\",\n \"company_postal_code\": \"123-4567\",\n \"company_prefecture\": \"東京都\",\n \"company_prefecture_kana\": \"トウキョウト\",\n \"company_address_municipality\": \"渋谷区\",\n \"company_address_municipality_kana\": \"シブヤク\",\n \"company_address_section\": \"道玄坂\",\n \"company_address_section_kana\": \"ドウゲンザカ\",\n \"company_address_chrome\": \"1-2-3\",\n \"company_address_chrome_kana\": \"イチニサン\",\n \"company_tel\": \"0312345678\"\n }\n },\n \"business_operator_bank_account_info\": {\n \"bank_code\": \"0001\",\n \"branch_code\": \"001\",\n \"account_kind\": 1,\n \"account_number\": \"1234567\",\n \"account_name\": \"ヤマダタロウ\"\n }\n}\n\n# HTTP POSTリクエストの送信\ntry:\n response = requests.put(url, headers=headers, json=data)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n buyer_id = ''\n tenant_buyer_id = ''\n endpoint = \"/v1/buyer/contracts/examinations/#{buyer_id}\"\n \n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n corporate_number: '1234567890123',\n contract_info: {\n representative_last_name: '山田',\n representative_last_name_kana: 'ヤマダ',\n representative_first_name: '太郎',\n representative_first_name_kana: 'タロウ',\n representative_postal_code: '123-4567',\n representative_prefecture: '東京都',\n representative_prefecture_kana: 'トウキョウト',\n representative_address_municipality: '渋谷区',\n representative_address_municipality_kana: 'シブヤク',\n representative_address_section: '道玄坂',\n representative_address_section_kana: 'ドウゲンザカ',\n representative_address_chrome: '1-2-3',\n representative_address_chrome_kana: 'イチニサン',\n representative_tel: '0312345678',\n representative_birthday: '1998/11/01',\n staff1_last_name: '鈴木',\n staff1_last_name_kana: 'スズキ',\n staff1_first_name: '次郎',\n staff1_first_name_kana: 'ジロウ',\n staff1_company_name: '株式会社テスト',\n staff1_belongs: 'EC運営部',\n staff1_tel: '08012345678',\n staff1_mail: 'staff-1@example.com',\n corporate: true,\n expect_usage_amount: '1000000',\n corporate_info: {\n corporate_name: '株式会社テスト',\n corporate_name_kana: 'カブシキガイシャテスト',\n hp: 'https://www.test.com',\n company_postal_code: '123-4567',\n company_prefecture: '東京都',\n company_prefecture_kana: 'トウキョウト',\n company_address_municipality: '渋谷区',\n company_address_municipality_kana: 'シブヤク',\n company_address_section: '道玄坂',\n company_address_section_kana: 'ドウゲンザカ',\n company_address_chrome: '1-2-3',\n company_address_chrome_kana: 'イチニサン',\n company_address_building_name: 'テストビル',\n company_address_building_name_kana: 'テストビル',\n company_tel: '0312345678'\n }\n },\n business_operator_bank_account_info: {\n bank_code: '0001',\n branch_code: '001',\n account_kind: '1',\n account_number: '1234567',\n account_name: 'ヤマダタロウ'\n }\n }\n\n # リクエストの作成\n request = Net::HTTP::Put.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n request['Tenant-Buyer-Id'] = tenant_buyer_id\n\n request.body = data.to_json\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/v1/buyer_platform_accounts": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBuyerPlatformAccountList",
"tags": [
"バイヤープラットフォーム報酬"
],
"summary": "バイヤープラットフォーム報酬 一覧取得",
"description": "バイヤープラットフォーム報酬（プラットフォームキックバック）の一覧を取得するAPI。\n",
"parameters": [
{
"in": "query",
"name": "クエリ",
"description": "検索条件クエリパラメータ\n",
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Pagination.QueryParams"
}
]
}
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerPlatformAccount.ListRetrieving.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/buyer_platform_accounts'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import fetch from \"node-fetch\";\n\nconst BASE_URL = \"https://api.test.fincode.jp\";\nconst API_KEY = \"\";\n\n(async () => {\n const endpoint = `${BASE_URL}/v1/buyer_platform_accounts`;\n\n const response = await fetch(endpoint, {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n },\n });\n const buyerPlatformAccounts = await response.json();\n console.log(buyerPlatformAccounts); // 取得したバイヤープラットフォーム報酬データを出力\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\t// APIキーの指定\n\tapiKey := \"\"\n\n\t// リクエストの作成\n\treq, err := http.NewRequest(\n\t\t\"GET\",\n\t\t\"https://api.test.fincode.jp/v1/buyer_platform_accounts\",\n\t\tnil,\n\t)\n\tif err != nil {\n\t\tlog.Fatalf(\"リクエストの作成エラー: %v\", err)\n\t}\n\n\treq.Header.Set(\"Authorization\", \"Bearer \"+apiKey)\n\n\t// リクエストの送信\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tlog.Fatalf(\"リクエスト送信エラー: %v\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tfmt.Println(resp.Status)\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer_platform_accounts\"; // GETリクエストのエンドポイント\n\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, 2);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n // エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n // APIからのデータを処理\n echo $response;\n}\n\ncurl_close($session);\n?>\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\nbase_url = \"https://api.test.fincode.jp\"\nendpoint = \"/v1/buyer_platform_accounts\" # GETリクエストのエンドポイント\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\ntry:\n response = requests.get(f\"{base_url}{endpoint}\", headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = \"/v1/buyer_platform_accounts\" # GETリクエストのエンドポイント\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n # レスポンスの表示\n puts JSON.pretty_generate(JSON.parse(response.body))\n else\n puts 'ERROR'\n # エラーの表示\n puts response.body\n end\nend\n\nmain\n"
}
]
}
},
"/v1/buyer_platform_accounts/{id}": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveBuyerPlatformAccount",
"tags": [
"バイヤープラットフォーム報酬"
],
"summary": "バイヤープラットフォーム報酬 取得",
"description": "エンドポイントに指定したIDのバイヤープラットフォーム報酬情報を取得するAPI。\n",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "プラットフォーム報酬ID"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuyerPlatformAccount.Detail"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/buyer_platform_accounts/{id}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import fetch from \"node-fetch\";\n\nconst BASE_URL = \"https://api.test.fincode.jp\";\nconst API_KEY = \"\";\n\n(async () => {\n const id = \"<プラットフォーム報酬ID>\";\n const endpoint = `${BASE_URL}/v1/buyer_platform_accounts/${id}`;\n\n const response = await fetch(endpoint, {\n method: \"GET\",\n headers: {\n Authorization: `Bearer ${API_KEY}`,\n },\n });\n const buyerPlatformAccount = await response.json();\n console.log(buyerPlatformAccount); // 取得したバイヤープラットフォーム報酬データを出力\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\t// APIキーの指定\n\tapiKey := \"\"\n\n\t// プラットフォーム報酬IDの指定\n\tid := \"<プラットフォーム報酬ID>\"\n\n\t// リクエストの作成\n\treq, err := http.NewRequest(\n\t\t\"GET\",\n\t\t\"https://api.test.fincode.jp/v1/buyer_platform_accounts/\"+id,\n\t\tnil,\n\t)\n\tif err != nil {\n\t\tlog.Fatalf(\"リクエストの作成エラー: %v\", err)\n\t}\n\n\treq.Header.Set(\"Authorization\", \"Bearer \"+apiKey)\n\n\t// リクエストの送信\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tlog.Fatalf(\"リクエスト送信エラー: %v\", err)\n\t}\n\tdefer resp.Body.Close()\n\n\tfmt.Println(resp.Status)\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n$id = '<プラットフォーム報酬ID>';\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/buyer_platform_accounts/\" . $id; // GETリクエストのエンドポイント\n\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, 2);\n\n$response = curl_exec($session);\n\nif ($response === false) {\n // エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n // APIからのデータを処理\n echo $response;\n}\n\ncurl_close($session);\n?>\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\nid = '<プラットフォーム報酬ID>'\n\nurl = f'https://api.test.fincode.jp/v1/buyer_platform_accounts/{id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\n# HTTP GETリクエストの送信\ntry:\n response = requests.get(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n id = \"<プラットフォーム報酬ID>\"\n endpoint = \"/v1/buyer_platform_accounts/#{id}\" # GETリクエストのエンドポイント\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n # レスポンスの表示\n puts JSON.pretty_generate(JSON.parse(response.body))\n else\n puts 'ERROR'\n # エラーの表示\n puts response.body\n end\nend\n\nmain\n"
}
]
}
},
"/v1/webhook_settings": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "createWebhookSetting",
"tags": [
"Webhook設定"
],
"summary": "Webhook設定 登録",
"parameters": [
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\n"
}
],
"description": "Webhook設定を登録します。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform.Creating.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform"
}
]
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X POST \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"event\": \"payments.card.secure\",\n \"url\": \"https://your-service.example.com/webhook-receiver\",\n}' \\\n'https://api.test.fincode.jp/v1/webhook_settings'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n try {\n // リクエストの送信\n const webhookSetting = await fincode.webhookSettings.create({\n url: \"https://your-service.example.com/webhook-receiver\",\n event: \"payments.card.secure\",\n signature: \"WEBHOOK_FROM_MPB\",\n });\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\tbody := CreatingWebhookSettingRequest{\n\t\tURL: stringPointer(\"https://your-service.example.com/webhook-receiver\"),\n\t\tEvent: stringPointer(\"payments.card.secure\"),\n\t\tSignature: stringPointer(\"WEBHOOK_FROM_MPB\"),\n\t}\n\n\tmarshalledBody, _ := json.Marshal(body)\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"POST\", \"https://api.test.fincode.jp/v1/webhook_settings\", bytes.NewBuffer(marshalledBody))\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n\ntype CreatingWebhookSettingRequest struct {\n\tID *string `json:\"id\"`\n\tURL *string `json:\"url\"`\n\tEvent *string `json:\"event\"`\n\tSignature *string `json:\"signature\"`\n}\n\nfunc stringPointer(s string) *string {\n\treturn &s\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/webhook_settings\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n \"Content-Type: application/json\"\n];\n\n$data = json_encode([\n \"url\" => \"https://your-service.example.com/webhook-receiver\",\n \"event\" => \"payments.card.secure\",\n \"signature\" => \"WEBHOOK_FROM_MPB\"\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_POST, true);\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = f'https://api.test.fincode.jp/v1/webhook_settings'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n}\n\ndata = {\n \"event\": \"payments.card.secure\",\n \"url\": \"https://your-service.example.com/webhook-receiver\",\n \"signature\": \"WEBHOOK_FROM_MPB\"\n}\n\n# HTTP POSTリクエストの送信\ntry:\n response = requests.post(url, headers=headers, json=data)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = \"/v1/webhook_settings\"\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n event: \"payments.card.secure\",\n url: \"https://your-service.example.com/webhook-receiver\",\n signature: \"WEBHOOK_FROM_MPB\"\n }\n\n # リクエストの作成\n request = Net::HTTP::Post.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n\n request.body = data.to_json\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
},
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveWebhookSettingList",
"tags": [
"Webhook設定"
],
"summary": "Webhook設定 一覧取得",
"description": "Webhook設定を一覧で取得します。\n",
"parameters": [
{
"in": "header"
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\nこのテナントバイヤーに紐づくWebhook設定から一覧で取得します。\n"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform.list"
}
]
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/webhook_settings'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n try {\n // リクエストの送信\n const webhookSettings = await fincode.webhookSettings.retrieveList();\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\"GET\", \"https://api.test.fincode.jp/v1/webhook_settings\", nil)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\n\tparams := req.URL.Query()\n\tparams.Add(\"limit\", \"10\")\n\treq.URL.RawQuery = params.Encode()\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/webhook_settings\";\n\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nurl = f'https://api.test.fincode.jp/v1/webhook_settings'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\ntry:\n response = requests.get(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n endpoint = \"/v1/webhook_settings\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/v1/webhook_settings/{id}": {
"get": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "retrieveWebhookSetting",
"tags": [
"Webhook設定"
],
"summary": "Webhook設定 取得",
"description": "IDで指定したWebhook設定を取得します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Webhook設定のID",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingId_schema"
}
]
},
"required": true
},
{
"name": "Tenant-Shop-Id"
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\n"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform"
}
]
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X GET \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/webhook_settings/{id}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n const webhookSettingId = \"\";\n\n try {\n // リクエストの送信\n const webhookSetting = await fincode.webhookSettings.retrieve(\n webhookSettingId\n );\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\twebhookSettingID := \"\"\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\n\t\t\"GET\",\n\t\tfmt.Sprintf(\"https://api.test.fincode.jp/v1/webhook_settings/%s\", webhookSettingID),\n\t\tnil,\n\t)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$webhookSettingId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/webhook_settings/{$webhookSettingId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_HTTPGET, true);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nwebhook_setting_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/webhook_settings/{webhook_setting_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\ntry:\n response = requests.get(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n webhook_setting_id = ''\n endpoint = \"/v1/webhook_settings/#{webhook_setting_id}\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Get.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
},
"put": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "updateWebhookSetting",
"tags": [
"Webhook設定"
],
"summary": "Webhook設定 更新",
"description": "IDで指定したWebhook設定を更新します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Webhook設定のID",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingId_schema"
}
]
},
"required": true
},
{
"in": "header"
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\nこのテナントバイヤーに紐づくWebhook設定のうち、指定したIDのWebhook設定を更新します。\n"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform.Updating.Request"
}
}
}
},
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform"
}
]
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X PUT \\\n -H \"Authorization:Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"signature\": \"WEBHOOK_FROM_MPB\"\n}' \\\n'https://api.test.fincode.jp/v1/webhook_settings/{id}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n const webhookSettingId = \"\";\n\n try {\n // リクエストの送信\n const webhookSetting = await fincode.webhookSettings.update(\n webhookSettingId,\n {\n url: \"https://your-service.example.com/v2/webhook-receiver\",\n }\n );\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"bytes\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\twebhookSettingID := \"\"\n\n\tbody := UpdatingWebhookSettingRequest{\n\t\tURL: stringPointer(\"https://your-service.example.com/v2/webhook-receiver\"),\n\t}\n\n\tmarshalledBody, _ := json.Marshal(body)\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\n\t\t\"PUT\",\n\t\tfmt.Sprintf(\"https://api.test.fincode.jp/v1/webhook_settings/%s\", webhookSettingID),\n\t\tbytes.NewBuffer(marshalledBody),\n\t)\n\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n\n}\n\ntype UpdatingWebhookSettingRequest struct {\n\tURL *string `json:\"url\"`\n\tEvent *string `json:\"event\"`\n\tSignature *string `json:\"signature\"`\n}\n\nfunc stringPointer(s string) *string {\n\treturn &s\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$webhookSettingId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/webhook_settings/{$webhookSettingId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$data = json_encode([\n \"url\" => \"https://your-service.example.com/v2/webhook-receiver\",\n]);\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_CUSTOMREQUEST, 'PUT');\ncurl_setopt($session, CURLOPT_POSTFIELDS, $data);\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nwebhook_setting_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/webhook_settings/{webhook_setting_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n 'Content-Type': 'application/json'\n}\n\ndata = {\n \"signature\": \"WEBHOOK_FROM_MPB\"\n}\n\n# HTTP POSTリクエストの送信\ntry:\n response = requests.put(url, headers=headers, json=data)\n\n # レスポンスの処理\n if response.status_code == 200:\n # 成功した場合の処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\nrequire 'json'\n\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n webhook_setting_id = ''\n endpoint = \"/v1/webhook_settings/#{webhook_setting_id}\"\n \n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n data = {\n signature: \"WEBHOOK_FROM_MPB\"\n }\n\n # リクエストの作成\n request = Net::HTTP::Put.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n request['Content-Type'] = 'application/json'\n\n request.body = data.to_json\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
},
"delete": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "deleteWebhookSetting",
"tags": [
"Webhook設定"
],
"summary": "Webhook設定 削除",
"description": "IDで指定したWebhook設定を削除します。\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Webhook設定のID",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSettingId_schema"
}
]
},
"required": true
},
{
"name": "Tenant-Shop-Id"
},
{
"in": "header",
"name": "Tenant-Buyer-Id",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/schema"
}
]
},
"description": "※ バイヤープラットフォームのみ指定可\\\nテナントバイヤーID。\\\nこのテナントバイヤーに紐づくWebhook設定のうち、指定したIDのWebhook設定を削除します。\n"
}
],
"responses": {
"200": {
"description": "リクエストに成功",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookSetting.Deleting.Response"
}
}
}
},
"400": {
"description": "不正なリクエスト",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FincodeAPIError.Response"
}
}
}
}
},
"x-code-samples": [
{
"lang": "curl",
"label": "cURL",
"source": "curl \\\n -X DELETE \\\n -H \"Authorization:Bearer \" \\\n'https://api.test.fincode.jp/v1/webhook_settings/{id}'\n"
},
{
"lang": "node",
"label": "Node.js",
"source": "import { createFincode } from \"@fincode/node\";\n\nconst API_KEY = \"\";\n\n(async () => {\n const fincode = createFincode({ apiKey: API_KEY, isLiveMode: false });\n\n const webhookSettingId = \"\";\n\n try {\n // リクエストの送信\n const result = await fincode.webhookSettings.delete(webhookSettingId);\n } catch (e) {\n // エラーの処理\n }\n})();\n"
},
{
"lang": "go",
"label": "Go",
"source": "package main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"net/http\"\n)\n\nfunc main() {\n\n\tapiKey := \"\"\n\n\twebhookSettingID := \"\"\n\n\t// リクエストの作成\n\treq, _ := http.NewRequest(\n\t\t\"DELETE\",\n\t\tfmt.Sprintf(\"https://api.test.fincode.jp/v1/webhook_settings/%s\", webhookSettingID),\n\t\tnil,\n\t)\n\treq.Header.Set(\"Authorization\", fmt.Sprintf(\"Bearer %s\", apiKey))\n\n\t// リクエストの送信\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tdefer res.Body.Close()\n}\n"
},
{
"lang": "php",
"label": "PHP",
"source": "';\n\n$webhookSettingId = '';\n\n$baseUrl = \"https://api.test.fincode.jp\";\n$endpoint = \"/v1/webhook_settings/{$webhookSettingId}\";\n$headers = [\n \"Authorization: Bearer \" . $apiKey,\n];\n\n$session = curl_init();\ncurl_setopt($session, CURLOPT_URL, $baseUrl . $endpoint);\ncurl_setopt($session, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($session, CURLOPT_CUSTOMREQUEST, 'DELETE');\ncurl_setopt($session, CURLOPT_RETURNTRANSFER, true);\n// curl_setopt($session, CURLOPT_SSL_VERIFYPEER, );\n// curl_setopt($session, CURLOPT_SSL_VERIFYHOST, );\n\n$response = curl_exec($session);\n\nif ($response === false) {\n # エラー処理\n echo \"cURL Error: \" . curl_error($session);\n} else {\n # APIからのデータを処理\n var_dump($response);\n}\n\ncurl_close($session);\n"
},
{
"lang": "python",
"label": "Python 3",
"source": "import requests\n\napi_key = ''\n\nwebhook_setting_id = ''\n\nurl = f'https://api.test.fincode.jp/v1/webhook_settings/{webhook_setting_id}'\n\n# ヘッダーを設定\nheaders = {\n 'Authorization': f'Bearer {api_key}',\n}\n\ntry:\n response = requests.delete(url, headers=headers)\n\n # レスポンスの処理\n if response.status_code == 200:\n # APIからのデータを処理\n print(f\"Success: {response.json()}\")\n else:\n # エラーの処理\n print(f\"Error: {response.json()}\")\nexcept requests.RequestException as e:\n # 通信エラーの処理\n print(f\"Request error: {e}\")\n"
},
{
"lang": "ruby",
"label": "Ruby",
"source": "require 'net/http'\nrequire 'uri'\n\nAPI_KEY = ''\nBASE_URL = 'https://api.test.fincode.jp'\n\ndef main\n webhook_setting_id = ''\n endpoint = \"/v1/webhook_settings/#{webhook_setting_id}\"\n\n uri = URI.parse(BASE_URL + endpoint)\n\n http = Net::HTTP.new(uri.host, uri.port)\n http.use_ssl = true\n\n # リクエストの作成\n request = Net::HTTP::Delete.new(uri.request_uri)\n request['Authorization'] = \"Bearer #{API_KEY}\"\n\n # リクエストの送信\n response = http.request(request)\n\n case response\n when Net::HTTPSuccess\n puts 'SUCCESS'\n else\n puts 'ERROR'\n end\n\n # レスポンスの表示\n puts response.body\nend\n\nmain\n"
}
]
}
},
"/your-endpoint-on-business-payments-regist": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "receiveWebhookOfBusinessPaymentsRegister",
"tags": [
"Webhook_通知仕様"
],
"summary": "請求書カード払い登録",
"description": "請求書カード払い登録イベント（`business_payments.regist`）で通知されるリクエストのボディの仕様です。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookEvent.BusinessPaymentsRegister"
}
}
}
},
"responses": {
"200": {
"description": "M's PayBridgeに正常にWebhookを受信した旨をレスポンスしてください。\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
},
"text/plain": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookResponse-plain"
}
]
},
"examples": {
"html": {
"value": 0
}
}
}
}
},
"400": {
"description": "4xx系、5xx系または上記以外のレスポンスを返却した場合、M's PayBridgeはエラーと判断しWebhook通知のリトライを行います。\n"
}
}
}
},
"/your-endpoint-on-business-payments-exec": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "receiveWebhookOfBusinessPaymentsExec",
"tags": [
"Webhook_通知仕様"
],
"summary": "請求書カード払い実行",
"description": "請求書カード払い実行イベント（`business_payments.exec`）（請求書カード払いオーソリ依頼API完了時）で通知されるリクエストのボディの仕様です。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookEvent.BusinessPaymentsExec"
}
}
}
},
"responses": {
"200": {
"description": "M's PayBridgeに正常にWebhookを受信した旨をレスポンスしてください。\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
},
"text/plain": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookResponse-plain"
}
]
},
"examples": {
"html": {
"value": 0
}
}
}
}
},
"400": {
"description": "4xx系、5xx系または上記以外のレスポンスを返却した場合、M's PayBridgeはエラーと判断しWebhook通知のリトライを行います。\n"
}
}
}
},
"/your-endpoint-on-business-payments-update": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "receiveWebhookOfBusinessPaymentsUpdate",
"tags": [
"Webhook_通知仕様"
],
"summary": "請求書カード払い更新",
"description": "請求書カード払い更新イベント（結果通知受信API取引ステータス更新時、「支払い中」以外）（`business_payments.update`）で通知されるリクエストのボディの仕様です。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookEvent.BusinessPaymentsUpdate"
}
}
}
},
"responses": {
"200": {
"description": "M's PayBridgeに正常にWebhookを受信した旨をレスポンスしてください。\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
},
"text/plain": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookResponse-plain"
}
]
},
"examples": {
"html": {
"value": 0
}
}
}
}
},
"400": {
"description": "4xx系、5xx系または上記以外のレスポンスを返却した場合、M's PayBridgeはエラーと判断しWebhook通知のリトライを行います。\n"
}
}
}
},
"/your-endpoint-on-buyer-contract": {
"post": {
"security": [
{
"Secret-Bearer-Auth": []
},
{
"Secret-Basic-Auth": []
}
],
"operationId": "receiveWebhookOfBuyerContract",
"tags": [
"Webhook_通知仕様"
],
"summary": "テナントバイヤー審査状況 更新",
"description": "テナントバイヤー審査状況 更新イベント（`buyer.contracts.status_code.updated`）で通知されるリクエストのボディの仕様です。\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookEvent.BuyerContract"
}
}
}
},
"responses": {
"200": {
"description": "M's PayBridgeに正常にWebhookを受信した旨をレスポンスしてください。\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
},
"text/plain": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookResponse-plain"
}
]
},
"examples": {
"html": {
"value": 0
}
}
}
}
},
"400": {
"description": "4xx系、5xx系または上記以外のレスポンスを返却した場合、M's PayBridgeはエラーと判断しWebhook通知のリトライを行います。\n"
}
}
}
}
},
"components": {
"securitySchemes": {
"Secret-Bearer-Auth": {
"type": "http",
"scheme": "bearer",
"description": "このAPIはシークレットキーによる認証を必要とします。\\\nBearer認証を用いる場合、リクエストヘッダー `Authorization`に下記の形式でシークレットキーを指定します。\n```\n Authorization: Bearer␣{APIキー}\n```\nシークレットキーはM's PayBridgeの管理画面から取得できます。\n"
},
"Secret-Basic-Auth": {
"type": "http",
"scheme": "basic",
"description": "このAPIはシークレットキーによる認証を必要とします。\\\nBasic認証を用いる場合、リクエストヘッダー `Authorization`に下記の形式でシークレットキーを指定します。\n``` JavaScript\n Authorization: Basic␣{Base64でエンコードしたAPIキー}\n```\nシークレットキーはM's PayBridgeの管理画面から取得できます。\n"
},
"Public-Bearer-Auth": {
"type": "http",
"scheme": "bearer",
"description": "このAPIはパブリックキーによる認証で利用できます。\\\nBearer認証を用いる場合、リクエストヘッダー `Authorization`に下記の形式でパブリックキーを指定します。\n```\n Authorization: Bearer␣{APIキー}\n```\nパブリックキーはM's PayBridgeの管理画面から取得できます。\n"
},
"Public-Basic-Auth": {
"type": "http",
"scheme": "basic",
"description": "このAPIはパブリックキーによる認証を必要とします。\\\nBasic認証を用いる場合、リクエストヘッダー `Authorization`に下記の形式でパブリックキーを指定します。\n``` JavaScript\n Authorization: Basic␣{Base64でエンコードしたAPIキー}\n```\nパブリックキーはM's PayBridgeの管理画面から取得できます。\n"
},
"Both-Bearer-Auth": {
"type": "http",
"scheme": "bearer",
"description": "このAPIはシークレットキーまたはパブリックキーによる認証を必要とします。\\\nBearer認証を用いる場合、リクエストヘッダー `Authorization`に下記の形式でシークレットキーまたはパブリックキーを指定します。\n```\n Authorization: Bearer␣{APIキー}\n```\nシークレットキーまたはパブリックキーはM's PayBridgeの管理画面から取得できます。\n"
},
"Both-Basic-Auth": {
"type": "http",
"scheme": "basic",
"description": "このAPIはシークレットキーまたはパブリックキーによる認証を必要とします。\\\nBasic認証を用いる場合、リクエストヘッダー `Authorization`に下記の形式でシークレットキーまたはパブリックキーを指定します。\n``` JavaScript\n Authorization: Basic␣{Base64でエンコードしたAPIキー}\n```\nシークレットキーまたはパブリックキーはM's PayBridgeの管理画面から取得できます。\n"
}
},
"schemas": {
"schema": {
"type": "string",
"example": "b_***********"
},
"Pagination.QueryParams": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minLength": 1,
"nullable": true,
"description": "ページ番号"
},
"limit": {
"type": "integer",
"nullable": true,
"minLength": 10,
"maxLength": 100,
"description": "1回で取得するデータの最大件数"
},
"count_only": {
"type": "boolean",
"nullable": true,
"description": "総件数のみ取得するか。\\\n`true`を指定した場合、検索結果の総件数（`total_count`）のみ取得します。\n"
}
},
"x-common-properties": {
"sort": {
"type": "string",
"example": "updated␣desc,created␣asc"
}
}
},
"BusinessPayment.ListRetrieving.QueryParams": {
"type": "object",
"properties": {
"access_id": {
"type": "string",
"nullable": true,
"description": "取引ID \n \n指定した場合、取引IDに完全一致する請求書カード払いデータのみを取得します。\n"
},
"company_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 255,
"description": "取引先名 \n \n指定した場合、取引先名に部分一致する請求書カード払いデータのみを取得します。\n"
},
"payment_amount_min": {
"type": "number",
"nullable": true,
"description": "支払金額範囲（下限） \n \n指定した場合、支払金額が指定金額以上の請求書カード払いデータのみを取得します。\n"
},
"payment_amount_max": {
"type": "number",
"nullable": true,
"description": "支払金額範囲（上限） \n \n指定した場合、支払金額が指定金額以下の請求書カード払いデータのみを取得します。\n"
},
"status": {
"type": "string",
"nullable": true,
"description": "ステータス \n \nカンマ(,)区切りで複数指定も可能です。 \n \n- `DRAFT`: 下書き\n- `REVIEWING`: 審査中\n- `REVIEW_NG`: 審査NG\n- `PAYING`: 支払い中\n- `FAILED`: 失敗\n- `PAID`: 支払い完了\n- `EXPIRED`: 期限切れ\n- `CANCELED`: キャンセル済\n"
},
"due_date_from": {
"type": "string",
"nullable": true,
"description": "支払期日範囲（開始） \n形式： `yyyy/MM/dd` \n \n指定した場合、支払期日が指定日以降である請求書カード払いデータのみを取得します。\n"
},
"due_date_to": {
"type": "string",
"nullable": true,
"description": "支払期日範囲（終了） \n形式： `yyyy/MM/dd` \n \n指定した場合、支払期日が指定日以前の請求書カード払いデータのみを取得します。\n"
},
"transfer_exec_date_from": {
"type": "string",
"nullable": true,
"description": "振込実行日範囲（開始） \n形式： `yyyy/MM/dd` \n \n指定した場合、振込実行日が指定日以降である請求書カード払いデータのみを取得します。\n"
},
"transfer_exec_date_to": {
"type": "string",
"nullable": true,
"description": "振込実行日範囲（終了） \n形式： `yyyy/MM/dd` \n \n指定した場合、振込実行日が指定日以前の請求書カード払いデータのみを取得します。\n"
},
"update_date_from": {
"type": "string",
"nullable": true,
"description": "更新日時範囲（開始） \n形式： `yyyy/MM/dd` \n \n指定した場合、更新日時が指定日以降である請求書カード払いデータのみを取得します。\n"
},
"update_date_to": {
"type": "string",
"nullable": true,
"description": "更新日時範囲（終了） \n形式： `yyyy/MM/dd` \n \n指定した場合、更新日時が指定日以前の請求書カード払いデータのみを取得します。\n"
}
}
},
"_ListResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"example": 100,
"description": "総件数"
},
"last_page": {
"type": "integer",
"example": 20,
"description": "最後のページのページ数"
},
"current_page": {
"type": "integer",
"example": 3,
"description": "現在のページのページ数"
},
"limit": {
"type": "integer",
"example": 5,
"description": "1ページの最大件数"
},
"link_next": {
"type": "string",
"example": "/v1/{resource}?limit=5&page=4",
"nullable": true,
"description": "次のページのコンテンツを取得するためのURL"
},
"link_previous": {
"type": "string",
"example": "/v1/{resource}?limit=5&page=2",
"nullable": true,
"description": "前のページのコンテンツを取得するためのURL"
}
}
},
"BusinessPayment.ListItem": {
"type": "object",
"description": "請求書カード払い 一覧項目",
"properties": {
"access_id": {
"type": "string",
"description": "取引ID",
"example": "bp_abcdefghijklmnopqrstuv"
},
"company_name": {
"type": "string",
"description": "取引先名",
"example": "株式会社アイネット"
},
"payment_amount": {
"type": "number",
"description": "支払金額",
"example": 10000
},
"status": {
"type": "string",
"description": "ステータス",
"example": "DRAFT"
},
"card_no_display": {
"type": "string",
"description": "表示用カード番号",
"example": "************8217"
},
"card_brand": {
"type": "string",
"description": "カードブランド",
"example": "jcb"
},
"due_date": {
"type": "string",
"description": "支払期日（yyyy/MM/dd）",
"example": "2025/05/11"
},
"transfer_exec_date": {
"type": "string",
"nullable": true,
"description": "振込実行日（yyyy/MM/dd）",
"example": null
},
"update_date": {
"type": "string",
"description": "更新日時（yyyy/MM/dd HH:mm）",
"example": "2025/05/23 09:43"
}
}
},
"BusinessPayment.list": {
"type": "object",
"properties": {
"list": {
"type": "array",
"description": "データリスト\n検索結果が0件の場合、空のリストを返却します。\n",
"items": {
"$ref": "#/components/schemas/BusinessPayment.ListItem"
}
}
}
},
"BusinessPayment.ListRetrieving.Response": {
"allOf": [
{
"$ref": "#/components/schemas/_ListResponse"
},
{
"$ref": "#/components/schemas/BusinessPayment.list"
}
]
},
"FincodeAPIError": {
"type": "object",
"description": "1つのエラーを表現するオブジェクト。\n",
"properties": {
"error_code": {
"type": "string",
"minLength": 11,
"maxLength": 11,
"example": "E**********",
"description": "エラー内容を判定する場合はこの`error_code`の使用が推奨されます。\\\n[各エラーコードの定義はこちらを参照](https://mpb-mizuhobank-docs.fincode.jp/develop_support/error)して確認できます。\n"
},
"error_message": {
"type": "string",
"description": "エラーの内容を表現するメッセージです。\\\nこのエラーメッセージは予告なく変更されるため、エラー内容を判定する場合はこの値ではなく`error_code`の使用が推奨されます。\n"
}
}
},
"FincodeAPIError.Response": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FincodeAPIError"
}
}
}
},
"BusinessPayment.Creating.Request": {
"type": "object",
"description": "請求書カード払い登録リクエスト",
"properties": {
"receipt_id": {
"example": "rc_-RcdyjisQl-Uk5D7Q12f0A",
"type": "string",
"minLength": 1,
"maxLength": 30,
"description": "支払ID。\\\n支払管理の支払情報を請求書カード払いする場合に指定します。\n"
}
}
},
"BusinessPayment.Creating.Response": {
"type": "object",
"description": "請求書カード払い登録レスポンス",
"properties": {
"access_id": {
"example": "bp_VbZbE8t6RMGIsIfOP3U7ww",
"type": "string",
"minLength": 25,
"maxLength": 25,
"description": "取引ID"
}
}
},
"BusinessPayment.Payee.Detail": {
"type": "object",
"description": "支払先情報\n",
"properties": {
"company_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "会社名",
"example": "株式会社アイネット"
},
"representative_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "代表者名",
"example": "株式会社アイネット"
},
"invoice_registration_number": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"description": "適格請求書発行事業者登録番号",
"example": "T7020001030145"
},
"addr_post_code": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "郵便番号",
"example": "220-0012"
},
"addr_state": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"description": "都道府県",
"example": "横浜市"
},
"addr_city": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "市区町村",
"example": "西区"
},
"addr_line_1": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "町名・番地",
"example": "みなとみらい５－１－２"
},
"addr_line_2": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "建物名等",
"example": "横浜シンフォステージ ウエストタワー１３階"
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "メールアドレス",
"example": "test@test.com"
},
"phone_no": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "電話番号",
"example": 456820845
}
}
},
"BankAccountKind": {
"type": "integer",
"enum": [
0,
1
],
"example": 1,
"description": "口座種別\n\n- `0`: 普通\n- `1`: 当座\n"
},
"BusinessPayment.PayeeBank.Detail": {
"type": "object",
"description": "振込先金融機関情報\n",
"properties": {
"bank_code": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"description": "金融機関コード",
"example": "0011"
},
"bank_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "金融機関名",
"example": "三井住友"
},
"branch_code": {
"type": "string",
"minLength": 1,
"maxLength": 3,
"description": "支店コード",
"example": "012"
},
"branch_name": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "支店名",
"example": "横浜"
},
"account_kind": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountKind"
}
]
},
"account_number": {
"type": "string",
"minLength": 1,
"maxLength": 32,
"description": "口座番号",
"example": "4108217"
},
"account_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "口座名義",
"example": "カテスト タロウ"
}
}
},
"BusinessPayment.Detail": {
"type": "object",
"description": "請求書カード払い情報取得レスポンス",
"properties": {
"access_id": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"description": "取引ID",
"example": "bp_abcdefghijklmnopqrstuv"
},
"buyer_shop_id": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"description": "バイヤーID",
"example": "s_12345678901"
},
"billing_amount": {
"type": "number",
"minLength": 1,
"maxLength": 10,
"description": "請求金額",
"example": 10000
},
"card_payment_fee": {
"type": "number",
"minLength": 1,
"maxLength": 10,
"description": "カード払い手数料",
"example": 300
},
"fee_rate": {
"type": "number",
"minLength": 1,
"maxLength": 10,
"description": "手数料率（3%の場合は0.03）",
"example": 0.03
},
"min_fee": {
"type": "number",
"minLength": 1,
"maxLength": 10,
"description": "最低手数料金額",
"example": 100
},
"total_amount": {
"type": "number",
"minLength": 1,
"maxLength": 10,
"description": "合計金額",
"example": 10300
},
"status": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"description": "ステータス",
"example": "DRAFT"
},
"process_date": {
"type": "string",
"minLength": 1,
"maxLength": 23,
"description": "処理日時（yyyy/MM/dd HH:mm:ss.SSS）",
"example": "2025/05/23 09:43:20"
},
"card_brand": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "カードブランド",
"example": "jcb"
},
"card_no_display": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "表示用カード番号",
"example": "************8217"
},
"due_date": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "支払期日（yyyy/MM/dd）",
"example": "2025/05/11"
},
"transfer_exec_date": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 10,
"description": "振込実行日（yyyy/MM/dd）",
"example": null
},
"invoice_file_name_display": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "表示用請求書ファイル名",
"example": "請求書.pdf"
},
"remitter_name": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "振込依頼人名",
"example": "カタカナ テストタロウ ＸＹＺ"
},
"invoice_file": {
"type": "string",
"description": "請求書ファイル（Base64でエンコード化）",
"example": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"customer_buyer_shop_id": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"description": "顧客バイヤーID",
"example": "b_25060517098"
},
"receipt_id": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"description": "支払ID",
"example": "rc_-RcdyjisQl-Uk5D7Q12f0A"
},
"bill_pay_types": {
"type": "array",
"description": "請求管理_決済種別",
"example": [
"0",
"7"
],
"items": {
"type": "string"
}
},
"examin_result_reason": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"description": "審査結果理由"
},
"auth_ret_url": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "オーソリコールバックURL（指定がない場合は `null`）",
"example": "https://example.com/business_payments/auth/"
},
"payee": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.Payee.Detail"
}
]
},
"payee_bank": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.PayeeBank.Detail"
}
]
},
"mulpay_api_key": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "マルペイキー",
"example": "xxxxxxxx="
},
"mulpay_public_key_path": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "マルペイ公開鍵のパス",
"example": "/file/public.key"
}
}
},
"CorporateType": {
"type": "string",
"enum": [
"0",
"1",
"2"
],
"example": "0",
"description": "事業形態\n\n- `0`: 法人\n- `1`: 個人事業主\n- `2`: その他\n"
},
"BusinessPayment.Payee.Submitting": {
"type": "object",
"description": "支払先情報\n",
"required": [
"company_name",
"corporate",
"representative_name",
"invoice_registration_number",
"addr_post_code",
"addr_state",
"addr_city",
"addr_line_1",
"phone_no"
],
"properties": {
"company_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "会社名",
"example": "株式会社アイネット"
},
"corporate": {
"allOf": [
{
"$ref": "#/components/schemas/CorporateType"
}
]
},
"representative_name": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "代表者名",
"example": "株式会社アイネット"
},
"invoice_registration_number": {
"type": "string",
"minLength": 14,
"maxLength": 14,
"description": "適格請求書発行事業者登録番号",
"example": "T7020001030145"
},
"addr_post_code": {
"type": "string",
"minLength": 1,
"maxLength": 8,
"description": "郵便番号\n\nハイフンなしで7桁まで\n",
"example": "220-0012"
},
"addr_state": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"description": "都道府県",
"example": "横浜市"
},
"addr_city": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "市区町村",
"example": "西区"
},
"addr_line_1": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "町名・番地",
"example": "みなとみらい５－１－２"
},
"addr_line_2": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "建物名等",
"example": "横浜シンフォステージ ウエストタワー１３階"
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "メールアドレス",
"example": "test@test.com"
},
"phone_no": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"description": "電話番号\n\nハイフンなしで20桁まで\n",
"example": 456820845
}
}
},
"BusinessPayment.PayeeBank.Submitting": {
"type": "object",
"description": "振込先金融機関情報",
"required": [
"bank_code",
"bank_name",
"branch_code",
"branch_name",
"account_kind",
"account_number",
"account_name"
],
"properties": {
"bank_code": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"description": "金融機関コード",
"example": "0011"
},
"bank_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "金融機関名",
"example": "三井住友"
},
"branch_code": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"description": "支店コード",
"example": "012"
},
"branch_name": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "支店名",
"example": "横浜"
},
"account_kind": {
"allOf": [
{
"$ref": "#/components/schemas/BankAccountKind"
}
]
},
"account_number": {
"type": "string",
"minLength": 1,
"maxLength": 7,
"description": "口座番号",
"example": "4108217"
},
"account_name": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "口座名義\n\n利用可能文字制限有り\n全角カタカナ、全角大文字アルファベット、全角数字、スペース、（）．，ー－／\n",
"example": "カテスト タロウ"
}
}
},
"BusinessPayment.Submitting.Request": {
"type": "object",
"description": "請求書カード払い提出リクエスト",
"required": [
"billing_amount",
"due_date",
"invoice_file_name_display",
"remitter_name",
"card_token"
],
"properties": {
"billing_amount": {
"type": "number",
"minLength": 1,
"maxLength": 8,
"description": "請求金額",
"example": 10000
},
"card_token": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "カードトークン（新規カードの場合設定）",
"example": null
},
"due_date": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "支払期日（yyyy/MM/dd）",
"example": "2025/05/11"
},
"invoice_file_name_display": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "表示用請求書ファイル名",
"example": "請求書.pdf"
},
"remitter_name": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "振込依頼人名（利用可能文字制限有り：全角カタカナ、全角大文字アルファベット、全角数字、スペース、（）．，ー－／）",
"example": "カタカナ テストタロウ ＸＹＺ"
},
"auth_ret_url": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "オーソリコールバックURL。\\\nカード認証の完了後に遷移させるURLを指定します。指定しない場合は fincode 既定のURLが使用されます。\\\n指定したURLの末尾に取引IDが付与されます（末尾が `/` でない場合は `/` を補って付与）。\\\nまた、遷移時にクエリパラメータ `p`（ブラウザ情報）が付与されます。遷移先で `p` を受け取り、請求書カード払いオーソリ依頼APIのリクエストに設定してください。\\\n（遷移先の例）`https://example.com/business_payments/auth/bp_abcdefghijklmnopqrstuv?p=abcdefghijklmnopqrstuvwxyz`\n",
"example": "https://example.com/business_payments/auth/"
},
"payee": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.Payee.Submitting"
}
]
},
"payee_bank": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.PayeeBank.Submitting"
}
]
}
}
},
"BusinessPayment.Submitting.Response": {
"type": "object",
"description": "請求書カード払い提出レスポンス",
"properties": {
"access_id": {
"type": "string",
"minLength": 25,
"maxLength": 25,
"description": "取引ID",
"sample": "bp_VbZbE8t6RMGIsIfOP3U7ww"
}
}
},
"BusinessPayment.Updating.Request.detail": {
"type": "object",
"description": "JSON形式データ\n\n`data` には以下のJSON文字列を設定します。\n\nJSON形式データの項目:\n \n",
"required": [
"billing_amount",
"due_date",
"invoice_file_name_display",
"remitter_name",
"card_token"
],
"properties": {
"billing_amount": {
"type": "number",
"minLength": 1,
"maxLength": 8,
"description": "請求金額",
"example": 10000
},
"card_token": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "カードトークン",
"example": null
},
"due_date": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "支払期日（yyyy/MM/dd）",
"example": "2025/05/11"
},
"invoice_file_name_display": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "表示用請求書ファイル名",
"example": "請求書.pdf"
},
"remitter_name": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "振込依頼人名（利用可能文字制限有り：全角カタカナ、全角大文字アルファベット、全角数字、スペース、（）．，ー－／）",
"example": "カタカナ テストタロウ ＸＹＺ"
},
"auth_ret_url": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "オーソリコールバックURL。\\\nカード認証の完了後に遷移させるURLを指定します。指定しない場合は fincode 既定のURLが使用されます。\\\n指定したURLの末尾に取引IDが付与されます（末尾が `/` でない場合は `/` を補って付与）。\\\nまた、遷移時にクエリパラメータ `p`（ブラウザ情報）が付与されます。遷移先で `p` を受け取り、請求書カード払いオーソリ依頼APIのリクエストに設定してください。\\\n（遷移先の例）`https://example.com/business_payments/auth/bp_abcdefghijklmnopqrstuv?p=abcdefghijklmnopqrstuvwxyz`\n",
"example": "https://example.com/business_payments/auth/"
},
"step": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"description": "入力ステップ。`1`〜`4` を指定します。\\\n指定したステップで入力する項目のみ必須チェックの対象になります（`3` を指定した場合のみ `due_date` が必須）。\\\n指定しない場合は全項目が必須チェックの対象になります。\\\n桁数・書式・値域のチェックは本項目の指定に依らず常に実施されます。\n",
"example": "3"
},
"payee": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.Payee.Submitting"
}
]
},
"payee_bank": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.PayeeBank.Submitting"
}
]
}
}
},
"BusinessPayment.Updating.Request": {
"type": "object",
"description": "請求書カード払い更新リクエスト",
"properties": {
"invoice_file": {
"type": "string",
"format": "binary",
"description": "アップロードファイル（未設定の場合はS3アップロード不要）"
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPayment.Updating.Request.detail"
}
]
}
},
"required": [
"data"
]
},
"BusinessPayment.Updating.Response": {
"type": "object",
"description": "請求書カード払い更新レスポンス",
"properties": {
"access_id": {
"example": "bp_VbZbE8t6RMGIsIfOP3U7ww",
"type": "string",
"minLength": 25,
"maxLength": 25,
"description": "取引ID"
}
}
},
"BusinessPayment.Deleting.Response": {
"type": "object",
"properties": {
"access_id": {
"example": "bp_VbZbE8t6RMGIsIfOP3U7ww",
"type": "string",
"minLength": 25,
"maxLength": 25,
"description": "取引ID"
},
"deleted": {
"example": "1",
"type": "string",
"minLength": 1,
"maxLength": 1,
"description": "論理削除フラグ\n\n- `1`: 削除\n"
}
}
},
"BusinessPayment.Requesting.Request": {
"type": "object",
"description": "請求書カード払い依頼リクエスト",
"required": [
"access_id"
],
"properties": {
"access_id": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"description": "取引ID",
"example": "bp_abcdefghijklmnopqrstuv"
}
}
},
"BusinessPayment.Requesting.Response": {
"type": "object",
"description": "請求書カード払い依頼レスポンス",
"properties": {
"redirect_url": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "認証開始URL",
"example": "http://xxx.xxx.xxx.xx/xxx"
}
}
},
"BusinessPayment.Authorizing.Request": {
"type": "object",
"description": "請求書カード払いオーソリ依頼リクエスト",
"required": [
"p"
],
"properties": {
"p": {
"type": "string",
"description": "ブラウザ情報
購入者がredirect_urlにアクセスし、 3Dセキュア認証成功をトリガーにオーソリコールバックURL宛に送信するデータのうち、 pの値を設定します。",
"example": "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh"
}
}
},
"BusinessPayment.Authorizing.Response": {
"type": "object",
"description": "請求書カード払いオーソリ依頼レスポンス",
"properties": {
"result": {
"type": "string",
"enum": [
"OK",
"NG"
],
"description": "オーソリ結果 OK: オーソリ成功 NG: オーソリ失敗"
}
}
},
"BusinessPayment.Business": {
"type": "object",
"description": "請求書カード払い事業者情報",
"properties": {
"result": {
"type": "string",
"description": "結果",
"enum": [
"OK",
"NG"
]
},
"commission_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from_amount": {
"type": "number",
"format": "double",
"description": "from金額",
"example": 1
},
"to_amount": {
"type": "number",
"format": "double",
"description": "to金額",
"example": 99999
},
"commission_rate": {
"type": "number",
"format": "double",
"description": "手数料率",
"example": 0.03
},
"min_commission_amount": {
"type": "number",
"format": "double",
"description": "最低手数料金額",
"example": 100
}
}
}
},
"mulpay_api_key": {
"type": "string",
"description": "マルペイキー",
"example": "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890abcdefh"
},
"mulpay_public_key_path": {
"type": "string",
"description": "マルペイ公開鍵のパス",
"example": "/path/to/mulpay_public_key.pem"
}
}
},
"ContractStatus": {
"type": "string",
"enum": [
"101",
"102",
"103",
"105",
"106",
"107"
],
"description": "契約ステータス\\\n\\\nM's PayBridgeとそのショップの運営事業者の契約のステータスを表します。\n\n- `101`: 未契約
まだM's PayBridgeの本番環境申請の提出が完了していない状態です。\n- `102`: 利用審査中
M's PayBridgeの本番環境申請の提出が完了し、利用審査中の状態です。\n- `103`: 利用審査中（VISA/Mastercard利用可）
即時利用によりVISA/Mastercardブランドの決済受付が可能な状態です。審査は継続して行われます。\n- `105`: 解約済\n- `106`: 契約不成立
審査の結果、M's PayBridgeの利用が不可となった状態です。\n- `107`: 稼働中
M's PayBridgeの本番環境申請が完了し、クレジットカード決済の受付が可能な状態です。\n"
},
"sort": {
"type": "string",
"example": "updated␣desc,created␣asc"
},
"TenantBuyer.ListRetrieving.QueryParams": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true,
"minLength": 13,
"maxLength": 13,
"example": "b_***********",
"default": null,
"description": "バイヤーID\n"
},
"buyer_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 20,
"example": "My Buyer",
"default": null,
"description": "バイヤー名称\n"
},
"buyer_mail_address": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 254,
"example": "tenant-buyer@example.com",
"default": null,
"description": "バイヤーメールアドレス\n"
},
"contract_status": {
"allOf": [
{
"$ref": "#/components/schemas/ContractStatus"
}
],
"nullable": true,
"description": "契約ステータス\\\n\\\nM's PayBridgeに登録されているバイヤーの契約ステータスで検索できます。\n"
},
"created_from": {
"type": "string",
"nullable": true,
"example": "2022/05/16",
"default": null,
"description": "作成日の範囲指定 開始日\\\nこの日付以降に作成されたショップを検索できます。\\\n形式：`yyyy/MM/dd`\n"
},
"created_to": {
"type": "string",
"nullable": true,
"example": "2022/05/16",
"default": null,
"description": "作成日の範囲指定 終了日\\\nこの日付以前に作成されたショップを検索できます。\\\n形式：`yyyy/MM/dd`\n"
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/sort"
}
],
"nullable": true,
"description": "ソートする項目と順序を指定します。\\\n例： `?sort=updated␣desc,created␣asc`\\\n\\\nソート可能な項目\n\n- `id`: バイヤーID\n- `buyer_name`: バイヤー名称\n- `corporate_name_or_representative_full_name`: 法人名/代表者名\n- `created`: 作成日時\n- `updated`: 更新日時\n"
}
}
},
"BuyerShopType": {
"type": "string",
"enum": [
null,
"platform",
"tenant"
],
"example": "platform",
"description": "バイヤータイプ。\n\n- `null`: スタンダードショップ\n- `platform`: バイヤープラットフォーム\n- `tenant`: テナントバイヤー\n"
},
"BuyerPlatformKickbackFeeRateSetting": {
"type": "object",
"properties": {
"platform_kickback_fee_rate": {
"type": "big decimal",
"format": "double",
"nullable": true,
"example": 1.5,
"description": "バイヤープラットフォーム還元率\n"
},
"platform_kickback_min_fee": {
"type": "big decimal",
"format": "double",
"nullable": true,
"example": 30,
"description": "バイヤープラットフォーム還元最低手数料\n"
},
"applied_since": {
"type": "timestamp",
"nullable": true,
"example": "2024-01-01T00:00:00Z",
"description": "適用期間（開始日）\n"
},
"applied_until": {
"type": "timestamp",
"nullable": true,
"example": "2024-12-31T23:59:59Z",
"description": "適用期間（終了日）\n"
},
"promotion_flag": {
"type": "boolean",
"nullable": true,
"example": true,
"description": "キャンペーンフラグ\n"
}
}
},
"created": {
"type": "string",
"example": "2022/05/16 23:59:59.999",
"description": "作成日\\\n形式：`yyyy/MM/dd HH:mm:ss.SSS`\n"
},
"updated": {
"type": "string",
"nullable": true,
"example": "2022/05/16 23:59:59.999",
"description": "更新日\\\n形式：`yyyy/MM/dd HH:mm:ss.SSS`\n"
},
"BuyerShop": {
"type": "object",
"properties": {
"buyer_id": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"example": "b_***********",
"description": "バイヤーID\n"
},
"buyer_name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"nullable": true,
"example": "Buyer Shop",
"description": "バイヤー名称\n"
},
"buyer_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "バイヤー",
"description": "バイヤー名カナ\n"
},
"send_mail_address": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"nullable": true,
"example": "notify@example.com",
"description": "通知先メールアドレス\n"
},
"buyer_mail_address": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"nullable": true,
"example": "buyer-shop@example.com",
"description": "バイヤーメールアドレス\n"
},
"buyer_type": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerShopType"
}
]
},
"buyer_platform_id": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"nullable": true,
"example": "bp_***********",
"description": "バイヤープラットフォームID\n"
},
"buyer_platform_name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"nullable": true,
"example": "Buyer Platform",
"description": "バイヤープラットフォーム名\n"
},
"buyer_platform_kickback_fee_rate_setting_list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BuyerPlatformKickbackFeeRateSetting"
},
"description": "バイヤープラットフォーム還元率設定情報リスト\n"
},
"api_key_display_flag": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"nullable": true,
"enum": [
"0",
"1"
],
"example": "1",
"description": "APIキー表示フラグ。\n\n- `0`: 表示しない\n- `1`: 表示する\n"
},
"created": {
"allOf": [
{
"$ref": "#/components/schemas/created"
}
]
},
"updated": {
"allOf": [
{
"$ref": "#/components/schemas/updated"
}
]
}
}
},
"BuyerShop.list": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerShop"
},
{
"type": "object",
"properties": {
"status_code": {
"allOf": [
{
"$ref": "#/components/schemas/ContractStatus"
}
]
},
"corporate_name_or_representative_full_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 416,
"description": "法人名/代表者名\n"
},
"staff1_last_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"description": "担当者1 名前 姓\n"
},
"staff1_first_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"description": "担当者1 名前 名\n"
},
"staff1_tel": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 15,
"description": "担当者1 電話番号\n"
},
"staff1_mail": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 254,
"format": "email",
"description": "担当者1 メールアドレス\n"
},
"contracted_at": {
"type": "string",
"nullable": true,
"example": "2021/01/01 10:00:00",
"description": "本番環境申請日\n\n形式：`yyyy/MM/dd HH:mm:ss`\n"
}
}
}
]
}
}
}
},
"TenantBuyer.ListRetrieving.Response": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerShop.list"
}
]
},
"TenantBuyer.Retrieving.Response": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerShop"
},
{
"type": "object",
"properties": {
"buyer_password": {
"type": "string",
"minLength": 1,
"maxLength": 13,
"nullable": true,
"example": "********",
"description": "バイヤーパスワード（マスク）\n"
},
"api_version": {
"type": "string",
"minLength": 1,
"maxLength": 8,
"nullable": true,
"example": "20211001",
"description": "APIバージョン\n"
},
"enable_contracts_api": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"nullable": true,
"enum": [
"0",
"1"
],
"example": "0",
"description": "契約審査系API実行許可フラグ\n\n- `0`: 許可しない\n- `1`: 許可する\n"
},
"business_operator_id": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"nullable": true,
"description": "事業者ID\n"
},
"partition_id": {
"type": "integer",
"minimum": 0,
"nullable": true,
"description": "パーティションID\n"
}
}
}
]
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"example": "new-mpb-user@example.com",
"description": "メールアドレス\\\n\\\nM's PayBridgeに新規作成するユーザーのメールアドレス。\\\nすでに登録されているメールアドレスを指定するとエラーとなります。（エラーコード：`E0087012014`）\\\n\\\n形式： RFC 5322\n"
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 100,
"example": "password1234",
"description": "パスワード\\\n\\\nM's PayBridgeに新規作成するユーザーのパスワード。\\\nパスワードは以下の条件を満たす必要があります。\n\n- 半角英数のみ\n- 12文字以上\n- 英数ともに使用\n- 大文字小文字ともに使用\n"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"example": "Epsilon Taro",
"description": "ユーザー名\\\n\\\nM's PayBridgeに新規作成するユーザーの名前\n"
},
"tenant_buyer_url_id": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"example": "tbu_ *********************",
"description": "テナントバイヤー登録URL ID\\\n\\\nテナントバイヤー登録URL ID。\\\n[管理画面 > プラットフォームの運用と管理 > 構成](https://mpb-mizuhobank-dashboard.test.fincode.jp/buyer_platform/constitution)の『テナントバイヤー登録用のURL』の`tenant_buyer_url_id`の値をこのパラメータに指定します。\n"
},
"POST.BuyerPlatformTenantEntries.Request": {
"type": "object",
"properties": {
"email": {
"allOf": [
{
"$ref": "#/components/schemas/email"
}
]
},
"password": {
"allOf": [
{
"$ref": "#/components/schemas/password"
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/name"
}
]
},
"tenant_buyer_url_id": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_buyer_url_id"
}
]
}
},
"required": [
"email",
"password",
"name",
"tenant_buyer_url_id"
]
},
"id": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"example": "s_***********",
"description": "ショップID\n"
},
"properties-id": {
"type": "integer",
"minLength": 1,
"maxLength": 11,
"example": 9,
"description": "ロールID\\\n\\\nユーザーの管理画面における権限を示すIDです。\n"
},
"User.business_operator": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 24,
"maxLength": 24,
"example": "u_**********************",
"description": "ユーザーID\n"
},
"default_shop_id": {
"allOf": [
{
"$ref": "#/components/schemas/id"
}
],
"description": "デフォルトショップID\\\n\\\nこのユーザーがログインした際、どのショップにログインするかを示すID\n"
},
"role_id": {
"allOf": [
{
"$ref": "#/components/schemas/properties-id"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"example": "Epsilon Taro",
"description": "ユーザー名\n"
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"example": "new-mpb-user@example.com",
"description": "メールアドレス\n"
},
"type": {
"type": "string",
"enum": [
"01"
],
"example": "01",
"description": "ユーザー種別\n\n- `01`: ショップユーザー\n"
},
"two_factor_auth_status": {
"type": "string",
"enum": [
"00",
"01"
],
"example": "00",
"description": "二要素認証ステータス\n\n- `00`: 未設定\\\n- `01`: 設定済み\n"
},
"mail_auth_status": {
"type": "string",
"enum": [
"00",
"01"
],
"example": "00",
"description": "メールアドレス認証ステータス\n\n- `00`: 未設定\\\n- `01`: 設定済み\n"
},
"password_lock_status": {
"type": "string",
"enum": [
"00",
"01"
],
"example": "00",
"description": "パスワードロックステータス\n\n- `00`: ロックされていない\\\n- `01`: ロック中\n"
},
"last_login_date": {
"type": "string",
"nullable": true,
"example": null,
"description": "最終ログイン日時\\\n\\\n形式：`yyyy/MM/dd HH:mm:ss.SSS`\n"
},
"login_failure_date": {
"type": "string",
"nullable": true,
"example": null,
"description": "ログイン失敗日時\\\n\\\n形式：`yyyy/MM/dd HH:mm:ss.SSS`\n"
},
"login_failure_times": {
"type": "integer",
"example": 0,
"description": "ログイン失敗回数\n"
},
"password_expire": {
"type": "string",
"nullable": true,
"example": "2022/05/16 12.34.56.789",
"description": "パスワード有効期限\\\n\\\n形式：`yyyy/MM/dd HH:mm:ss.SSS`\n"
},
"account_status": {
"type": "string",
"enum": [
"00",
"01"
],
"example": "00",
"description": "アカウントステータス\n\n- `00`: 有効\n- `01`: 無効\n"
},
"invite_status": {
"type": "string",
"enum": [
"01",
"02"
],
"example": "02",
"description": "招待ステータス\n\n- `01`: 招待中\n- `02`: 参加済み\n"
},
"business_operator_id": {
"type": "string",
"minLength": 26,
"maxLength": 26,
"example": "biz_Ab12Ab12Ab12Ab12Ab12Ab",
"description": "事業者ID\n"
},
"created": {
"allOf": [
{
"$ref": "#/components/schemas/created"
}
]
},
"updated": {
"allOf": [
{
"$ref": "#/components/schemas/updated"
}
]
}
}
},
"POST.BuyerPlatformTenantEntries.business_operator": {
"type": "object",
"properties": {
"user_data": {
"allOf": [
{
"$ref": "#/components/schemas/User.business_operator"
}
],
"description": "新規作成されたユーザー情報（このAPIによって新規作成されたテナントのショップIDを含む）\n"
},
"access_token": {
"type": "string",
"minLength": 112,
"maxLength": 112,
"example": "a_****_**************",
"description": "アクセストークン\n"
},
"authorities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"auth_id": {
"type": "integer",
"example": 18,
"description": "権限ID"
},
"endpoint": {
"type": "string",
"example": "/v1/payments",
"description": "エンドポイント"
},
"method": {
"type": "string",
"example": "GET",
"description": "HTTPメソッド"
}
}
},
"description": "ユーザーの権限情報\\\n\\\nこのユーザーが実行可能なエンドポイントとHTTPメソッドの情報\n"
}
},
"x-req-properties": {
"email": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"example": "new-mpb-user@example.com",
"description": "メールアドレス\\\n\\\nM's PayBridgeに新規作成するユーザーのメールアドレス。\\\nすでに登録されているメールアドレスを指定するとエラーとなります。（エラーコード：`E0087012014`）\\\n\\\n形式： RFC 5322\n"
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 100,
"example": "password1234",
"description": "パスワード\\\n\\\nM's PayBridgeに新規作成するユーザーのパスワード。\\\nパスワードは以下の条件を満たす必要があります。\n\n- 半角英数のみ\n- 12文字以上\n- 英数ともに使用\n- 大文字小文字ともに使用\n"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"example": "Epsilon Taro",
"description": "ユーザー名\\\n\\\nM's PayBridgeに新規作成するユーザーの名前\n"
},
"tenant_buyer_url_id": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"example": "tbu_ *********************",
"description": "テナントバイヤー登録URL ID\\\n\\\nテナントバイヤー登録URL ID。\\\n[管理画面 > プラットフォームの運用と管理 > 構成](https://mpb-mizuhobank-dashboard.test.fincode.jp/buyer_platform/constitution)の『テナントバイヤー登録用のURL』の`tenant_buyer_url_id`の値をこのパラメータに指定します。\n"
}
}
},
"POST.BuyerPlatformTenantEntries.Response.business_operator": {
"allOf": [
{
"$ref": "#/components/schemas/POST.BuyerPlatformTenantEntries.business_operator"
}
]
},
"x-req-properties-email": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"example": "new-mpb-user@example.com",
"description": "メールアドレス\\\n\\\nバイヤープラットフォームのユーザーのメールアドレス。\n"
},
"x-req-properties-password": {
"type": "string",
"minLength": 12,
"maxLength": 254,
"example": "password1234",
"description": "パスワード\\\n\\\nバイヤープラットフォームのユーザーのパスワード。\n"
},
"x-req-properties-tenant_buyer_url_id": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"example": "tbu_*********************",
"description": "テナントバイヤー登録URL ID\\\n\\\nテナントバイヤー登録URLのID。\\\n[管理画面 > バイヤープラットフォームの運用と管理 > 構成](https://mpb-mizuhobank-dashboard.test.fincode.jp/buyer_platform/constitution)の『テナントバイヤー登録用のURL』の`tenant_buyer_url_id`の値をこのパラメータに指定します。\n"
},
"POST.BuyerPlatformJoinTenants.Request": {
"type": "object",
"properties": {
"email": {
"allOf": [
{
"$ref": "#/components/schemas/x-req-properties-email"
}
]
},
"password": {
"allOf": [
{
"$ref": "#/components/schemas/x-req-properties-password"
}
]
},
"tenant_buyer_url_id": {
"allOf": [
{
"$ref": "#/components/schemas/x-req-properties-tenant_buyer_url_id"
}
]
}
},
"required": [
"email",
"password",
"tenant_buyer_url_id"
]
},
"TenantBuyer_properties-id": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"example": "b_***********",
"description": "テナントバイヤーID\n"
},
"buyer_name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"nullable": true,
"example": "Tenant Buyer",
"description": "テナントバイヤー名称\n"
},
"buyer_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "バイヤー",
"description": "テナントバイヤー名カナ\n"
},
"send_address": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"nullable": true,
"example": "notify@example.com",
"description": "通知先メールアドレス\n"
},
"buyer_mail_address": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"nullable": true,
"example": "buyer-shop@example.com",
"description": "テナントバイヤーメールアドレス\n"
},
"buyer_type": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerShopType"
}
]
},
"buyer_platform_id": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"nullable": true,
"example": "bp_***********",
"description": "バイヤープラットフォームID\n"
},
"buyer_platform_name": {
"type": "string",
"minLength": 1,
"maxLength": 384,
"nullable": true,
"example": "Buyer Platform",
"description": "バイヤープラットフォーム名\n"
},
"api_key_display_flag": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"nullable": true,
"enum": [
"0",
"1"
],
"example": "1",
"description": "APIキー表示フラグ。\n\n- `0`: 表示しない\n- `1`: 表示する\n"
},
"business_operator_id": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"nullable": true,
"description": "事業者ID\n"
},
"partition_id": {
"type": "integer",
"minimum": 0,
"nullable": true,
"description": "パーティションID\n"
},
"properties-created": {
"allOf": [
{
"$ref": "#/components/schemas/created"
}
]
},
"properties-updated": {
"allOf": [
{
"$ref": "#/components/schemas/updated"
}
]
},
"POST.BuyerPlatformJoinTenants": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/TenantBuyer_properties-id"
}
]
},
"buyer_name": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_name"
}
]
},
"buyer_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_name_kana"
}
]
},
"send_address": {
"allOf": [
{
"$ref": "#/components/schemas/send_address"
}
]
},
"buyer_mail_address": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_mail_address"
}
]
},
"buyer_type": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_type"
}
]
},
"buyer_platform_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_platform_id"
}
]
},
"buyer_platform_name": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_platform_name"
}
]
},
"api_key_display_flag": {
"allOf": [
{
"$ref": "#/components/schemas/api_key_display_flag"
}
]
},
"business_operator_id": {
"allOf": [
{
"$ref": "#/components/schemas/business_operator_id"
}
]
},
"partition_id": {
"allOf": [
{
"$ref": "#/components/schemas/partition_id"
}
]
},
"created": {
"allOf": [
{
"$ref": "#/components/schemas/properties-created"
}
]
},
"updated": {
"allOf": [
{
"$ref": "#/components/schemas/properties-updated"
}
]
}
},
"x-req-properties": {
"email": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"example": "new-mpb-user@example.com",
"description": "メールアドレス\\\n\\\nバイヤープラットフォームのユーザーのメールアドレス。\n"
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 254,
"example": "password1234",
"description": "パスワード\\\n\\\nバイヤープラットフォームのユーザーのパスワード。\n"
},
"tenant_buyer_url_id": {
"type": "string",
"minLength": 1,
"maxLength": 25,
"example": "tbu_*********************",
"description": "テナントバイヤー登録URL ID\\\n\\\nテナントバイヤー登録URLのID。\\\n[管理画面 > バイヤープラットフォームの運用と管理 > 構成](https://mpb-mizuhobank-dashboard.test.fincode.jp/buyer_platform/constitution)の『テナントバイヤー登録用のURL』の`tenant_buyer_url_id`の値をこのパラメータに指定します。\n"
}
}
},
"POST.BuyerPlatformJoinTenants.Response": {
"allOf": [
{
"$ref": "#/components/schemas/POST.BuyerPlatformJoinTenants"
}
]
},
"buyer_id": {
"type": "string",
"minLength": 13,
"maxLength": 13,
"example": "b_***********",
"description": "バイヤーID\n"
},
"corporate_name": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"example": "サンプル株式会社",
"description": "法人名\n"
},
"corporate_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"example": "サンプルカブシキガイシャ",
"description": "法人名（カナ）\n"
},
"hp": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"nullable": true,
"example": "https://www.sample-corp.example.com",
"description": "企業サイトURL\n"
},
"company_postal_code": {
"type": "string",
"nullable": true,
"minLength": 8,
"maxLength": 8,
"example": "123-4567",
"description": "会社住所 郵便番号\\\n形式： 半角数字（ハイフンあり）\n"
},
"company_prefecture": {
"type": "string",
"nullable": true,
"minLength": 3,
"maxLength": 4,
"example": "東京都",
"description": "会社住所 都道府県\\\n形式： 漢字\n"
},
"company_prefecture_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "トウキョウト",
"description": "会社住所 都道府県（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_municipality": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "渋谷区",
"description": "会社住所 市区町村\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_municipality_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "シブヤク",
"description": "会社住所 市区町村（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_section": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "道玄坂",
"description": "会社住所 町域\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_section_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "ドウゲンザカ",
"description": "会社住所 町域（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_chrome": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "1-2-3",
"description": "会社住所 番地\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_chrome_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "イチニサン",
"description": "会社住所 番地（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_building_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "サンプルビル",
"description": "会社住所 ビル名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_building_name_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "サンプルビル",
"description": "会社住所 ビル名（カナ）\\\n形式： 全角カタカナ\n"
},
"company_tel": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 15,
"example": "0312345678",
"description": "会社情報 電話番号\\\n形式： 半角数字（ハイフンなし）\n"
},
"representative_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "山田",
"description": "代表者 姓\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"representative_last_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "ヤマダ",
"description": "代表者 姓（カナ）\\\n形式： 全角カナ\n"
},
"representative_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "太郎",
"description": "代表者 名\\\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"representative_first_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "タロウ",
"description": "代表者 名（カナ）\\\n形式： 全角カナ\n"
},
"representative_birthday": {
"type": "string",
"pattern": "^\\d{4}/\\d{2}/\\d{2}$",
"nullable": true,
"example": "1980/01/01",
"description": "代表者 生年月日\\\n\\\n形式：`yyyy/MM/dd`\n"
},
"representative_postal_code": {
"type": "string",
"pattern": "^\\d{3}-\\d{4}$",
"nullable": true,
"minLength": 8,
"maxLength": 8,
"example": "150-0043",
"description": "代表者 住所 郵便番号\\\n形式：`xxx-xxxx`\n"
},
"representative_prefecture": {
"type": "string",
"minLength": 3,
"maxLength": 4,
"nullable": true,
"example": "東京都",
"description": "代表者 住所 都道府県\\\n形式： 漢字\n"
},
"representative_prefecture_kana": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "トウキョウト",
"description": "代表者 住所 都道府県（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_municipality": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "渋谷区",
"description": "代表者 住所 市区町村\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_municipality_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "シブヤク",
"description": "代表者 住所 市区町村（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_section": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "道玄坂",
"description": "代表者 住所 町域\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_section_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ドウゲンザカ",
"description": "代表者 住所 町域（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_chrome": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "1-14-6",
"description": "代表者 住所 番地\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_chrome_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "1-14-6",
"description": "代表者 住所 番地（カナ）\n"
},
"representative_address_building_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ヒューマックス渋谷ビル 7F",
"description": "代表者 住所 建物名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_building_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ヒューマックスシブヤビル ナナカイ",
"description": "代表者 住所 建物名（カナ）\\\n形式： 全角カナ\n"
},
"representative_tel": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^\\d{1,15}$",
"nullable": true,
"example": "0364330000",
"description": "代表者 電話番号\\\n形式： 半角数字（ハイフンなし、PHS番号不可）\n"
},
"staff1_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "鈴木",
"description": "担当者1 姓\\\n形式： 漢字/ひらがな/カタカナ/半角英字\\\n\\\nM's PayBridgeは担当者1,2宛てに審査結果の通知や審査保留対応の連絡などを行います。\n"
},
"staff1_last_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "スズキ",
"description": "担当者1 姓（カナ）\\\n形式： 全角カナ\n"
},
"staff1_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "次郎",
"description": "担当者1 名\\\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"staff1_first_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "ジロウ",
"description": "担当者1 名（カナ）\\\n形式： 全角カナ\n"
},
"staff1_company_name": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"nullable": true,
"example": "サンプル株式会社",
"description": "担当者1 会社名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"staff1_belongs": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "EC事業部",
"description": "担当者1 部署名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"staff1_tel": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^\\d{1,15}$",
"nullable": true,
"example": "09000000000",
"description": "担当者1 電話番号\\\n形式： 半角数字（ハイフンなし、PHS番号不可）\n"
},
"staff1_mail": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"format": "email",
"nullable": true,
"example": "staff-1@example.com",
"description": "担当者1 メールアドレス\\\n形式： RFC 5322\n"
},
"content_description": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 5000,
"example": "本サービスは、ユーザーが自由にWeb記事を投稿・販売できるコンテンツを提供しています。\n",
"description": "取扱商材の説明\\\n\\\nショップの提供する商材についての説明\n"
},
"BuyerContractDetail": {
"type": "object",
"properties": {
"corporate": {
"type": "boolean",
"nullable": true,
"example": true,
"description": "事業形態\n\n- `true`: 法人\n- `false`: 個人事業主\n"
},
"corporate_number": {
"type": "string",
"nullable": true,
"minLength": 13,
"maxLength": 13,
"example": "1234567890123",
"description": "法人番号\n"
},
"corporate_name": {
"allOf": [
{
"$ref": "#/components/schemas/corporate_name"
}
],
"nullable": true
},
"corporate_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/corporate_name_kana"
}
],
"nullable": true
},
"hp": {
"allOf": [
{
"$ref": "#/components/schemas/hp"
}
],
"nullable": true
},
"company_postal_code": {
"allOf": [
{
"$ref": "#/components/schemas/company_postal_code"
}
],
"nullable": true
},
"company_prefecture": {
"allOf": [
{
"$ref": "#/components/schemas/company_prefecture"
}
],
"nullable": true
},
"company_prefecture_kana": {
"allOf": [
{
"$ref": "#/components/schemas/company_prefecture_kana"
}
],
"nullable": true
},
"company_address_municipality": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_municipality"
}
],
"nullable": true
},
"company_address_municipality_kana": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_municipality_kana"
}
],
"nullable": true
},
"company_address_section": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_section"
}
],
"nullable": true
},
"company_address_section_kana": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_section_kana"
}
],
"nullable": true
},
"company_address_chrome": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_chrome"
}
],
"nullable": true
},
"company_address_chrome_kana": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_chrome_kana"
}
],
"nullable": true
},
"company_address_building_name": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_building_name"
}
],
"nullable": true
},
"company_address_building_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/company_address_building_name_kana"
}
],
"nullable": true
},
"company_tel": {
"allOf": [
{
"$ref": "#/components/schemas/company_tel"
}
],
"nullable": true
},
"representative_last_name": {
"allOf": [
{
"$ref": "#/components/schemas/representative_last_name"
}
],
"nullable": true
},
"representative_last_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_last_name_kana"
}
],
"nullable": true
},
"representative_first_name": {
"allOf": [
{
"$ref": "#/components/schemas/representative_first_name"
}
],
"nullable": true
},
"representative_first_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_first_name_kana"
}
],
"nullable": true
},
"representative_birthday": {
"allOf": [
{
"$ref": "#/components/schemas/representative_birthday"
}
],
"nullable": true
},
"representative_postal_code": {
"allOf": [
{
"$ref": "#/components/schemas/representative_postal_code"
}
],
"nullable": true
},
"representative_prefecture": {
"allOf": [
{
"$ref": "#/components/schemas/representative_prefecture"
}
],
"nullable": true
},
"representative_prefecture_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_prefecture_kana"
}
],
"nullable": true
},
"representative_address_municipality": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_municipality"
}
],
"nullable": true
},
"representative_address_municipality_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_municipality_kana"
}
],
"nullable": true
},
"representative_address_section": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_section"
}
],
"nullable": true
},
"representative_address_section_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_section_kana"
}
],
"nullable": true
},
"representative_address_chrome": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_chrome"
}
],
"nullable": true
},
"representative_address_chrome_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_chrome_kana"
}
],
"nullable": true
},
"representative_address_building_name": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_building_name"
}
],
"nullable": true
},
"representative_address_building_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/representative_address_building_name_kana"
}
],
"nullable": true
},
"representative_tel": {
"allOf": [
{
"$ref": "#/components/schemas/representative_tel"
}
],
"nullable": true
},
"staff1_last_name": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_last_name"
}
],
"nullable": true
},
"staff1_last_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_last_name_kana"
}
],
"nullable": true
},
"staff1_first_name": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_first_name"
}
],
"nullable": true
},
"staff1_first_name_kana": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_first_name_kana"
}
],
"nullable": true
},
"staff1_company_name": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_company_name"
}
],
"nullable": true
},
"staff1_belongs": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_belongs"
}
],
"nullable": true
},
"staff1_tel": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_tel"
}
],
"nullable": true
},
"staff1_mail": {
"allOf": [
{
"$ref": "#/components/schemas/staff1_mail"
}
],
"nullable": true
},
"content_description": {
"allOf": [
{
"$ref": "#/components/schemas/content_description"
}
],
"nullable": true
}
}
},
"BusinessOperator": {
"type": "object",
"properties": {
"business_operator_id": {
"type": "string",
"nullable": true,
"description": "事業者ID\n"
},
"business_operator_name": {
"type": "string",
"nullable": true,
"description": "事業者名\n"
},
"business_operator_name_kana": {
"type": "string",
"nullable": true,
"description": "事業者名カナ\n"
},
"service_name": {
"type": "string",
"nullable": true,
"description": "サービス名\n"
},
"business_operator_examination_status_code": {
"type": "number",
"nullable": true,
"description": "事業者審査ステータス\n"
}
}
},
"BusinessOperatorBuyerBankAccountInfo": {
"type": "object",
"properties": {
"bank_name": {
"type": "string",
"example": "GMOあおぞらネット銀行",
"minLength": 1,
"maxLength": 20,
"description": "金融機関名\n"
},
"bank_name_kana": {
"type": "string",
"example": "ジーエムオーアオゾラネットギンコウ",
"minLength": 1,
"maxLength": 100,
"description": "金融機関名カナ\n"
},
"bank_code": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"example": "0001",
"description": "金融機関コード\n"
},
"branch_name": {
"type": "string",
"example": "うみ支店",
"minLength": 1,
"maxLength": 20,
"description": "支店名\n"
},
"branch_name_kana": {
"type": "string",
"example": "ウミシテン",
"minLength": 1,
"maxLength": 100,
"description": "支店名カナ\n"
},
"branch_code": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "001",
"description": "支店コード\n"
},
"account_kind": {
"type": "number",
"enum": [
0,
1
],
"example": 0,
"description": "口座種別\n\n- `0`: 普通\n- `1`: 当座\n"
},
"account_number": {
"type": "string",
"minLength": 1,
"maxLength": 7,
"example": "1234567",
"description": "口座番号\n"
},
"account_name": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"example": "サンプル株式会社",
"description": "口座名義カナ\n"
}
}
},
"BuyerContractBankAccountInfo": {
"type": "object",
"properties": {
"contract_bank_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "金融機関名\n"
},
"contract_bank_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "金融機関名カナ\n"
},
"contract_bank_code": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"description": "金融機関コード\n"
},
"contract_branch_code": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"description": "支店コード\n"
},
"contract_branch_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "支店名\n"
},
"contract_branch_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "支店名カナ\n"
},
"contract_account_kind": {
"type": "number",
"enum": [
0,
1
],
"description": "口座種別\n\n- `0`: 普通\n- `1`: 当座\n"
},
"contract_account_number": {
"type": "string",
"minLength": 1,
"maxLength": 7,
"description": "口座番号\n"
},
"contract_account_name": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "口座名義カナ\n"
}
}
},
"BuyerContractDetailInfo": {
"type": "object",
"properties": {
"buyer_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
],
"description": "バイヤーID\n"
},
"status_code": {
"allOf": [
{
"$ref": "#/components/schemas/ContractStatus"
}
]
},
"create_date": {
"type": "string",
"example": "2021/01/01",
"description": "ショップを作成したユーザーの登録日\n\n形式：`yyyy/MM/dd`\n"
},
"contracted_at": {
"type": "string",
"nullable": true,
"example": "2021/01/01",
"description": "本番環境申請日 \n形式：`yyyy/MM/dd`\n"
},
"start_charging_at": {
"type": "string",
"nullable": true,
"example": "2021/01/01",
"description": "初回登録完了日\n 形式：`yyyy/MM/dd`\n"
},
"expired_at": {
"type": "string",
"nullable": true,
"example": "2021/01/01",
"description": "解約日\n 形式：`yyyy/MM/dd`\n"
},
"denied_at": {
"type": "string",
"nullable": true,
"example": "2021/01/01",
"description": "契約不成立日(審査NG日)\n 形式：`yyyy/MM/dd`\n"
},
"register_mail": {
"type": "string",
"minLength": 3,
"maxLength": 254,
"nullable": true,
"description": "登録メールアドレス\n"
},
"buyer_shop_type": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/BuyerShopType"
}
]
},
"buyer_platform_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_platform_id"
}
]
},
"buyer_platform_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"description": "バイヤープラットフォーム名\n"
},
"buyer_platform_examination_status_code": {
"type": "number",
"enum": [
1101,
1104,
1105
],
"nullable": true,
"example": 1101,
"description": "バイヤープラットフォームステータス\n\n- null：審査前\n- 1101：審査中\n- 1104：審査OK\n- 1105：登録完了\n"
},
"buyer_contract_detail": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerContractDetail"
}
],
"description": "契約情報\\\n\\\nM's PayBridgeに登録されているバイヤーの契約情報の詳細\n"
},
"buyer_examination": {
"type": "array",
"items": {
"type": "object",
"properties": {
"examination_master_id": {
"type": "integer",
"example": 1,
"description": "審査マスタID\\\n審査項目を識別するID\n"
},
"status_code": {
"type": "number",
"example": 1,
"description": "審査状況\n\n- 1：審査中\n- 2：審査OK\n- 3：審査NG\n"
},
"cut_over_at": {
"type": "string",
"nullable": true,
"example": "2021/01/01",
"description": "CO日\n\n形式：`yyyy/MM/dd`\n"
}
}
},
"description": "審査情報\\\n\\\n決済事業者ごとの審査状況を配列に格納しています。\\\nある決済手段について審査が開始されていない場合、その決済手段に対応する`examination_master_id`をもつオブジェクトは配列中に存在しません。\n"
},
"business_operator": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessOperator"
}
],
"description": "事業者情報\\\n\\\nM's PayBridgeに登録されているバイヤーの事業者情報の詳細\n"
},
"business_operator_bank_account_info": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessOperatorBuyerBankAccountInfo"
}
],
"description": "事業者銀行口座情報\\\n\\\nM's PayBridgeに登録されているバイヤーの銀行口座情報の詳細\n"
},
"buyer_contract_bank_account": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerContractBankAccountInfo"
}
],
"description": "バイヤー入金銀行口座情報\\\n\\\nM's PayBridgeに登録されているバイヤーの入金銀行口座情報の詳細\n"
}
}
},
"BuyerContracts.Retrieving.Response": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerContractDetailInfo"
}
]
},
"POST.BuyerContractsExaminations.Request": {
"type": "object",
"properties": {
"buyer_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
]
},
"force_credit_check_skip": {
"type": "boolean",
"description": "信用情報チェックを強制的にスキップする。\n\n- `true`: 審査管理画面から強制OKをする場合のみ\n- `false`: 本番環境申請時\n"
}
},
"required": [
"buyer_id",
"force_credit_check_skip"
]
},
"POST.BuyerContractsExaminations": {
"type": "object",
"properties": {
"buyer_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
],
"description": "バイヤーID\\\n\\\n審査申請を行うバイヤーID\n"
},
"status_code": {
"type": "number",
"enum": [
1,
2,
3
],
"example": 1,
"description": "申請ステータス\n\n- `1`: OK
申請が完了しました。審査を行います。\n- `2`: NG
M's PayBridgeの利用が認められませんでした。\n- `3`: 保留
申請は完了しており、審査は継続して行われます。\n"
}
}
},
"POST.BuyerContractsExaminations.Response": {
"allOf": [
{
"$ref": "#/components/schemas/POST.BuyerContractsExaminations"
}
]
},
"corporate_number": {
"type": "string",
"nullable": true,
"minLength": 13,
"maxLength": 13,
"example": "1234567890123",
"description": "法人番号\n"
},
"BuyerCorporateInfo": {
"type": "object",
"properties": {
"invoice_registration_number": {
"type": "string",
"nullable": true,
"minLength": 14,
"maxLength": 14,
"example": "1234567890123",
"description": "インボイス登録番号\n"
},
"corporate_name": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"example": "サンプル株式会社",
"description": "法人名\n"
},
"corporate_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"example": "サンプルカブシキガイシャ",
"description": "法人名（カナ）\n"
},
"hp": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"nullable": true,
"example": "https://www.sample-corp.example.com",
"description": "企業サイトURL\n"
},
"company_postal_code": {
"type": "string",
"nullable": true,
"minLength": 8,
"maxLength": 8,
"example": "123-4567",
"description": "会社住所 郵便番号\\\n形式： 半角数字（ハイフンあり）\n"
},
"company_prefecture": {
"type": "string",
"nullable": true,
"minLength": 3,
"maxLength": 4,
"example": "東京都",
"description": "会社住所 都道府県\\\n形式： 漢字\n"
},
"company_prefecture_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "トウキョウト",
"description": "会社住所 都道府県（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_municipality": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "渋谷区",
"description": "会社住所 市区町村\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_municipality_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "シブヤク",
"description": "会社住所 市区町村（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_section": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "道玄坂",
"description": "会社住所 町域\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_section_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "ドウゲンザカ",
"description": "会社住所 町域（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_chrome": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "1-2-3",
"description": "会社住所 番地\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_chrome_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "イチニサン",
"description": "会社住所 番地（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_building_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "サンプルビル",
"description": "会社住所 ビル名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_building_name_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "サンプルビル",
"description": "会社住所 ビル名（カナ）\\\n形式： 全角カタカナ\n"
},
"company_tel": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 15,
"example": "0312345678",
"description": "会社情報 電話番号\\\n形式： 半角数字（ハイフンなし）\n"
}
}
},
"BuyerContractInfo": {
"type": "object",
"properties": {
"representative_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "山田",
"description": "代表者 姓\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"representative_last_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "ヤマダ",
"description": "代表者 姓（カナ）\\\n形式： 全角カナ\n"
},
"representative_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "太郎",
"description": "代表者 名\\\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"representative_first_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "タロウ",
"description": "代表者 名（カナ）\\\n形式： 全角カナ\n"
},
"representative_postal_code": {
"type": "string",
"pattern": "^\\d{3}-\\d{4}$",
"nullable": true,
"minLength": 8,
"maxLength": 8,
"example": "150-0043",
"description": "代表者 住所 郵便番号\\\n形式：`xxx-xxxx`\n"
},
"representative_prefecture": {
"type": "string",
"minLength": 3,
"maxLength": 4,
"nullable": true,
"example": "東京都",
"description": "代表者 住所 都道府県\\\n形式： 漢字\n"
},
"representative_prefecture_kana": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "トウキョウト",
"description": "代表者 住所 都道府県（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_municipality": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "渋谷区",
"description": "代表者 住所 市区町村\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_municipality_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "シブヤク",
"description": "代表者 住所 市区町村（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_section": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "道玄坂",
"description": "代表者 住所 町域\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_section_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ドウゲンザカ",
"description": "代表者 住所 町域（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_chrome": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "1-14-6",
"description": "代表者 住所 番地\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_chrome_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "1-14-6",
"description": "代表者 住所 番地（カナ）\n"
},
"representative_address_building_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ヒューマックス渋谷ビル 7F",
"description": "代表者 住所 建物名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_building_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ヒューマックスシブヤビル ナナカイ",
"description": "代表者 住所 建物名（カナ）\\\n形式： 全角カナ\n"
},
"representative_tel": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^\\d{1,15}$",
"nullable": true,
"example": "0364330000",
"description": "代表者 電話番号\\\n形式： 半角数字（ハイフンなし、PHS番号不可）\n"
},
"representative_birthday": {
"type": "string",
"pattern": "^\\d{4}/\\d{2}/\\d{2}$",
"nullable": true,
"example": "1980/01/01",
"description": "代表者 生年月日\\\n\\\n形式：`yyyy/MM/dd`\n"
},
"staff1_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "鈴木",
"description": "担当者1 姓\\\n形式： 漢字/ひらがな/カタカナ/半角英字\\\n\\\nM's PayBridgeは担当者1,2宛てに審査結果の通知や審査保留対応の連絡などを行います。\n"
},
"staff1_last_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "スズキ",
"description": "担当者1 姓（カナ）\\\n形式： 全角カナ\n"
},
"staff1_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "次郎",
"description": "担当者1 名\\\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"staff1_first_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "ジロウ",
"description": "担当者1 名（カナ）\\\n形式： 全角カナ\n"
},
"staff1_company_name": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"nullable": true,
"example": "サンプル株式会社",
"description": "担当者1 会社名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"staff1_belongs": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "EC事業部",
"description": "担当者1 部署名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"staff1_tel": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^\\d{1,15}$",
"nullable": true,
"example": "09000000000",
"description": "担当者1 電話番号\\\n形式： 半角数字（ハイフンなし、PHS番号不可）\n"
},
"staff1_mail": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"format": "email",
"nullable": true,
"example": "staff-1@example.com",
"description": "担当者1 メールアドレス\\\n形式： RFC 5322\n"
},
"corporate": {
"type": "boolean",
"nullable": true,
"example": true,
"description": "事業形態\n\n- `true`: 法人\n- `false`: 個人事業主\n"
},
"expect_usage_amount": {
"type": "string",
"nullable": true,
"example": "1000000",
"description": "月間想定利用額\n"
},
"corporate_info": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerCorporateInfo"
}
],
"nullable": true,
"description": "法人情報\n\\\n`corporate`が`true`のとき必須\n"
}
}
},
"BuyerExaminationInfo": {
"type": "object",
"properties": {
"buyer_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
],
"description": "バイヤーID\n"
},
"corporate_number": {
"allOf": [
{
"$ref": "#/components/schemas/corporate_number"
}
],
"description": "法人番号\n"
},
"status_code": {
"allOf": [
{
"$ref": "#/components/schemas/ContractStatus"
}
]
},
"contract_info": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerContractInfo"
}
],
"description": "契約情報\\\n\\\nM's PayBridgeに登録されているバイヤーの契約情報の詳細\n"
},
"business_operator_bank_account_info": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessOperatorBuyerBankAccountInfo"
}
],
"description": "事業者口座情報\n"
}
}
},
"BuyerExaminationInfo.Retrieving.Response": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerExaminationInfo"
}
]
},
"BuyerCorporateInfo.PUT": {
"type": "object",
"properties": {
"invoice_registration_number": {
"type": "string",
"nullable": true,
"minLength": 14,
"maxLength": 14,
"example": "1234567890123",
"description": "インボイス登録番号\n"
},
"corporate_name": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"example": "サンプル株式会社",
"description": "法人名\n"
},
"corporate_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"example": "サンプルカブシキガイシャ",
"description": "法人名（カナ）\n"
},
"hp": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"nullable": true,
"example": "https://www.sample-corp.example.com",
"description": "企業サイトURL\n"
},
"company_postal_code": {
"type": "string",
"nullable": true,
"minLength": 8,
"maxLength": 8,
"example": "123-4567",
"description": "会社住所 郵便番号\\\n形式： 半角数字（ハイフンあり）\n"
},
"company_prefecture": {
"type": "string",
"nullable": true,
"minLength": 3,
"maxLength": 4,
"example": "東京都",
"description": "会社住所 都道府県\\\n形式： 漢字\n"
},
"company_prefecture_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 6,
"example": "トウキョウト",
"description": "会社住所 都道府県（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_municipality": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "渋谷区",
"description": "会社住所 市区町村\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_municipality_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "シブヤク",
"description": "会社住所 市区町村（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_section": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 50,
"example": "道玄坂",
"description": "会社住所 町域\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_section_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "ドウゲンザカ",
"description": "会社住所 町域（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_chrome": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "1-2-3",
"description": "会社住所 番地\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_chrome_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "イチニサン",
"description": "会社住所 番地（カナ）\\\n形式： 全角カタカナ\n"
},
"company_address_building_name": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "サンプルビル",
"description": "会社住所 ビル名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"company_address_building_name_kana": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 100,
"example": "サンプルビル",
"description": "会社住所 ビル名（カナ）\\\n形式： 全角カタカナ\n"
},
"company_tel": {
"type": "string",
"nullable": true,
"minLength": 1,
"maxLength": 15,
"example": "0312345678",
"description": "会社情報 電話番号\\\n形式： 半角数字（ハイフンなし）\n"
}
},
"required": [
"company_tel",
"corporate_name_kana",
"company_prefecture_kana",
"company_address_municipality_kana",
"company_address_section_kana",
"company_address_chrome_kana"
]
},
"BuyerContractInfo.PUT": {
"type": "object",
"properties": {
"representative_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "山田",
"description": "代表者 姓\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"representative_last_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "ヤマダ",
"description": "代表者 姓（カナ）\\\n形式： 全角カナ\n"
},
"representative_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "太郎",
"description": "代表者 名\\\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"representative_first_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "タロウ",
"description": "代表者 名（カナ）\\\n形式： 全角カナ\n"
},
"representative_postal_code": {
"type": "string",
"pattern": "^\\d{3}-\\d{4}$",
"nullable": true,
"minLength": 8,
"maxLength": 8,
"example": "150-0043",
"description": "代表者 住所 郵便番号\\\n形式：`xxx-xxxx`\n"
},
"representative_prefecture": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"nullable": true,
"example": "東京都",
"description": "代表者 住所 都道府県\\\n形式： 漢字\n"
},
"representative_prefecture_kana": {
"type": "string",
"minLength": 1,
"maxLength": 6,
"nullable": true,
"example": "トウキョウト",
"description": "代表者 住所 都道府県（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_municipality": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "渋谷区",
"description": "代表者 住所 市区町村\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_municipality_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "シブヤク",
"description": "代表者 住所 市区町村（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_section": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "道玄坂",
"description": "代表者 住所 町域\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_section_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ドウゲンザカ",
"description": "代表者 住所 町域（カナ）\\\n形式： 全角カナ\n"
},
"representative_address_chrome": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "1-14-6",
"description": "代表者 住所 番地\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_chrome_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "1-14-6",
"description": "代表者 住所 番地（カナ）\n"
},
"representative_address_building_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ヒューマックス渋谷ビル 7F",
"description": "代表者 住所 建物名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"representative_address_building_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"nullable": true,
"example": "ヒューマックスシブヤビル ナナカイ",
"description": "代表者 住所 建物名（カナ）\\\n形式： 全角カナ\n"
},
"representative_tel": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^\\d{1,15}$",
"nullable": true,
"example": "0364330000",
"description": "代表者 電話番号\\\n形式： 半角数字（ハイフンなし、PHS番号不可）\n"
},
"representative_birthday": {
"type": "string",
"pattern": "^\\d{4}/\\d{2}/\\d{2}$",
"nullable": true,
"example": "1980/01/01",
"description": "代表者 生年月日\\\n\\\n形式：`yyyy/MM/dd`\n"
},
"staff1_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "鈴木",
"description": "担当者1 姓\\\n形式： 漢字/ひらがな/カタカナ/半角英字\\\n\\\nM's PayBridgeは担当者1,2宛てに審査結果の通知や審査保留対応の連絡などを行います。\n"
},
"staff1_last_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "スズキ",
"description": "担当者1 姓（カナ）\\\n形式： 全角カナ\n"
},
"staff1_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "次郎",
"description": "担当者1 名\\\n形式： 漢字/ひらがな/カタカナ/半角英字\n"
},
"staff1_first_name_kana": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"nullable": true,
"example": "ジロウ",
"description": "担当者1 名（カナ）\\\n形式： 全角カナ\n"
},
"staff1_company_name": {
"type": "string",
"minLength": 1,
"maxLength": 150,
"nullable": true,
"example": "サンプル株式会社",
"description": "担当者1 会社名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"staff1_belongs": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"nullable": true,
"example": "EC事業部",
"description": "担当者1 部署名\\\n形式： 漢字/ひらがな/カタカナ/半角英数\n"
},
"staff1_tel": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^\\d{1,15}$",
"nullable": true,
"example": "09000000000",
"description": "担当者1 電話番号\\\n形式： 半角数字（ハイフンなし、PHS番号不可）\n"
},
"staff1_mail": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"format": "email",
"nullable": true,
"example": "staff-1@example.com",
"description": "担当者1 メールアドレス\\\n形式： RFC 5322\n"
},
"corporate": {
"type": "boolean",
"nullable": true,
"example": true,
"description": "事業形態\n\n- `true`: 法人\n- `false`: 個人事業主\n"
},
"expect_usage_amount": {
"type": "string",
"nullable": true,
"example": 1000000,
"description": "月間想定利用額\n"
},
"corporate_info": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerCorporateInfo.PUT"
}
],
"nullable": true,
"description": "法人情報\n\\\n`corporate`が`true`のとき必須\n"
}
},
"required": [
"representative_last_name",
"representative_last_name_kana",
"representative_first_name",
"representative_first_name_kana",
"representative_birthday",
"staff1_last_name",
"staff1_last_name_kana",
"staff1_first_name",
"staff1_first_name_kana",
"staff1_company_name",
"staff1_tel",
"staff1_mail",
"corporate"
]
},
"BusinessOperatorBuyerBankAccountInfo.PUT": {
"type": "object",
"properties": {
"bank_code": {
"type": "string",
"minLength": 4,
"maxLength": 4,
"example": "0001",
"description": "金融機関コード\n"
},
"branch_code": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "001",
"description": "支店コード\n"
},
"account_kind": {
"type": "number",
"enum": [
0,
1
],
"example": 0,
"description": "口座種別\n\n- `0`: 普通\n- `1`: 当座\n"
},
"account_number": {
"type": "string",
"minLength": 1,
"maxLength": 7,
"example": "1234567",
"description": "口座番号\n"
},
"account_name": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"example": "ヤマダ タロウ",
"description": "口座名義カナ\n"
}
},
"required": [
"bank_code",
"branch_code",
"account_kind",
"account_number"
]
},
"BuyerExaminationInfo.Updating.Request": {
"type": "object",
"properties": {
"corporate_number": {
"type": "string",
"nullable": false,
"minLength": 13,
"maxLength": 13,
"example": "1234567890123",
"description": "法人番号\n"
},
"contract_info": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerContractInfo.PUT"
}
],
"description": "契約情報\\\n\\\nM's PayBridgeに登録するバイヤー運営事業者の契約情報の詳細\n"
},
"business_operator_bank_account_info": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessOperatorBuyerBankAccountInfo.PUT"
}
],
"description": "事業者口座情報\\\n\\\nM's PayBridgeに登録する事業者の銀行口座情報の詳細\n"
}
},
"required": [
"corporate_number"
]
},
"BuyerExaminationInfo.Updating.Response": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerExaminationInfo"
}
]
},
"BuyerPlatformAccount.ListItem": {
"type": "object",
"description": "バイヤープラットフォーム報酬 一覧項目",
"properties": {
"id": {
"type": "string",
"description": "プラットフォーム報酬ID",
"example": "sales_bp_25062553595_250829_001"
},
"buyer_account_id": {
"type": "string",
"description": "精算ID",
"example": "00000000000000000001"
},
"buyer_id": {
"type": "string",
"description": "バイヤーID",
"example": "b_00000000001"
},
"aggregate_term_start": {
"type": "string",
"description": "集計対象期間（開始）\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2025/12/01 00:00:00.000"
},
"aggregate_term_end": {
"type": "string",
"description": "集計対象期間（終了）\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2025/12/31 23:59:59.999"
},
"scheduled_deposit_date": {
"type": "string",
"description": "入金予定日\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2025/12/09 08:50:01.424"
},
"deposit_date": {
"type": "string",
"nullable": true,
"description": "入金日\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n未入金の場合は `null`。\n",
"example": "2025/12/03 08:50:01.424"
},
"status_code": {
"type": "integer",
"description": "ステータスコード\n\n- `3001`: 集計中\n- `3002`: 集計済\n- `3003`: 入金待ち\n- `3004`: 入金済\n- `3005`: 入金失敗\n- `3011`: 取消\n- `3013`: 保留\n",
"example": 3003
},
"count": {
"type": "integer",
"description": "対象取引件数",
"example": 30
},
"total_amount": {
"type": "number",
"description": "取引総額",
"example": 400000
},
"platform_provision_fee_amount": {
"type": "number",
"description": "請求書書面上の請求金額",
"example": 30000
},
"platform_provision_fee_tax_amount": {
"type": "number",
"description": "プラットフォーム提供料消費税",
"example": 3000
},
"platform_kickback_fee_amount": {
"type": "number",
"description": "プラットフォーム還元額",
"example": 100000
},
"platform_kickback_fee_tax_amount": {
"type": "number",
"description": "プラットフォーム還元額消費税",
"example": 10000
},
"deposit_amount": {
"type": "number",
"description": "入金金額",
"example": 143000
},
"created": {
"type": "string",
"description": "登録日時\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2023/11/09 08:50:01.424"
},
"updated": {
"type": "string",
"description": "更新日時\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2023/11/09 10:10:01.424"
}
}
},
"BuyerPlatformAccount.list": {
"type": "object",
"properties": {
"list": {
"type": "array",
"description": "データリスト\n検索結果が0件の場合、空のリストを返却します。\n",
"items": {
"$ref": "#/components/schemas/BuyerPlatformAccount.ListItem"
}
}
}
},
"BuyerPlatformAccount.ListRetrieving.Response": {
"allOf": [
{
"$ref": "#/components/schemas/_ListResponse"
},
{
"$ref": "#/components/schemas/BuyerPlatformAccount.list"
}
]
},
"BuyerDepositDestinationHistory": {
"type": "object",
"description": "入金先口座情報",
"properties": {
"recipient_corporate_name": {
"type": "string",
"description": "入金先法人名",
"example": "入金先法人名"
},
"recipient_representative_last_name": {
"type": "string",
"description": "入金先代表者姓",
"example": "代表者姓"
},
"recipient_representative_first_name": {
"type": "string",
"description": "入金先代表者名",
"example": "代表者名"
},
"bank_name": {
"type": "string",
"description": "金融機関名",
"example": "金融機関名"
},
"bank_name_kana": {
"type": "string",
"description": "金融機関名（カナ）",
"example": "キンユウキカンメイ"
},
"bank_code": {
"type": "string",
"description": "金融機関コード",
"example": "0001"
},
"branch_name": {
"type": "string",
"description": "支店名",
"example": "支店名"
},
"branch_name_kana": {
"type": "string",
"description": "支店名（カナ）",
"example": "シテンメイ"
},
"branch_code": {
"type": "string",
"description": "支店コード",
"example": "1000"
},
"account_kind": {
"type": "integer",
"description": "預金種別\n\n- `0`: 普通\n- `1`: 当座\n",
"example": 0
},
"account_number": {
"type": "string",
"description": "口座番号",
"example": "1234567"
},
"account_name": {
"type": "string",
"description": "口座名義",
"example": "口座名義"
}
}
},
"BuyerPlatformAccount.Detail": {
"type": "object",
"description": "バイヤープラットフォーム報酬 詳細",
"properties": {
"id": {
"type": "string",
"description": "プラットフォーム報酬ID",
"example": "sales_bp_25062553595_250829_000"
},
"buyer_account_id": {
"type": "string",
"description": "精算ID",
"example": "00000000000000000000"
},
"buyer_id": {
"type": "string",
"description": "バイヤーID",
"example": "b_000000000000"
},
"aggregate_term_start": {
"type": "string",
"description": "集計対象期間（開始）\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2025/12/01 00:00:00.000"
},
"aggregate_term_end": {
"type": "string",
"description": "集計対象期間（終了）\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2025/12/31 23:59:59.999"
},
"scheduled_deposit_date": {
"type": "string",
"description": "入金予定日\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2025/12/09 08:50:01.424"
},
"deposit_date": {
"type": "string",
"nullable": true,
"description": "入金日\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n未入金の場合は `null`。\n",
"example": "2025/12/03 08:50:01.424"
},
"status_code": {
"type": "integer",
"description": "ステータスコード\n\n- `3001`: 集計中\n- `3002`: 集計済\n- `3003`: 入金待ち\n- `3004`: 入金済\n- `3005`: 入金失敗\n- `3011`: 取消\n- `3013`: 保留\n",
"example": 3003
},
"count": {
"type": "integer",
"description": "対象取引件数",
"example": 30
},
"total_amount": {
"type": "number",
"description": "取引総額",
"example": 400000
},
"platform_provision_fee_amount": {
"type": "number",
"description": "請求書書面上の請求金額",
"example": 1000000
},
"platform_provision_fee_tax_amount": {
"type": "number",
"description": "プラットフォーム提供料消費税",
"example": 30000
},
"platform_kickback_fee_amount": {
"type": "number",
"description": "プラットフォーム還元額",
"example": 30000
},
"platform_kickback_fee_tax_amount": {
"type": "number",
"description": "プラットフォーム還元額消費税",
"example": 3000
},
"platform_kickback_fee_tax_rate": {
"type": "number",
"description": "プラットフォーム還元額消費税率（%）",
"example": 10
},
"deposit_amount": {
"type": "number",
"description": "入金金額",
"example": 33000
},
"created": {
"type": "string",
"description": "登録日時\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2023/11/09 08:50:01.424"
},
"updated": {
"type": "string",
"description": "更新日時\n形式： `yyyy/MM/dd HH:mm:ss.SSS`\n",
"example": "2023/11/09 10:10:01.424"
},
"buyer_deposit_destination_history": {
"allOf": [
{
"$ref": "#/components/schemas/BuyerDepositDestinationHistory"
}
],
"description": "入金先口座情報"
}
}
},
"FincodeEventForBuyerPlatform": {
"type": "string",
"enum": [
"business_payments.regist",
"business_payments.exec",
"business_payments.update",
"buyer.contracts.status_code.updated"
],
"minLength": 1,
"maxLength": 40,
"example": "business_payments.regist",
"description": "Webhook通知 トリガーイベント\n"
},
"WebhookSettingBuyerPlatform": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "w_*********************",
"description": "Webhook設定ID\n"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://your-service.example.com/webhook-receiver",
"description": "Webhook通知先 URL\\\n\\\nWebhookの通知先URLを指定します。\\\nM's PayBridgeのWebhookはHTTPS通信かつ443ポートでのみ受信可能です。\n"
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
]
},
"signature": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"example": "WEBHOOK_FROM_MPB",
"description": "署名\\\n\\\nこのWebhookがM's PayBridgeから送信されたことを確認するための署名です。\\\nM's PayBridgeからのWebhook通知において`Fincode-Signature`ヘッダーにこの値が含まれます。\n"
},
"created": {
"nullable": false,
"allOf": [
{
"$ref": "#/components/schemas/created"
}
]
},
"updated": {
"nullable": false,
"allOf": [
{
"$ref": "#/components/schemas/updated"
}
]
}
}
},
"WebhookSettingBuyerPlatform.list": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookSettingBuyerPlatform"
}
}
}
},
"WebhookSetting_properties-id": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"example": "w_*********************",
"description": "Webhook設定ID\n"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://your-service.example.com/webhook-receiver",
"description": "Webhook通知先 URL\\\n\\\nWebhookの通知先URLを指定します。\\\nM's PayBridgeのWebhookはHTTPS通信かつ443ポートでのみ受信可能です。\n"
},
"signature": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"example": "WEBHOOK_FROM_MPB",
"description": "署名\\\n\\\nこのWebhookがM's PayBridgeから送信されたことを確認するための署名です。\\\nM's PayBridgeからのWebhook通知において`Fincode-Signature`ヘッダーにこの値が含まれます。\n"
},
"WebhookSettingBuyerPlatform.Creating.Request": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSetting_properties-id"
}
]
},
"url": {
"allOf": [
{
"$ref": "#/components/schemas/url"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
]
},
"signature": {
"allOf": [
{
"$ref": "#/components/schemas/signature"
}
]
}
},
"required": [
"event"
]
},
"WebhookSettingId_schema": {
"type": "string",
"example": "w_**********************"
},
"WebhookSettingBuyerPlatform.Updating.Request": {
"type": "object",
"properties": {
"url": {
"allOf": [
{
"$ref": "#/components/schemas/url"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
]
},
"signature": {
"allOf": [
{
"$ref": "#/components/schemas/signature"
}
]
}
}
},
"delete_flag": {
"type": "string",
"enum": [
"1",
"0"
],
"example": "1",
"description": "削除フラグ"
},
"WebhookSetting.Deleting.Response": {
"type": "object",
"properties": {
"id": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookSetting_properties-id"
}
],
"description": "削除されたWebhook設定のID"
},
"delete_flag": {
"allOf": [
{
"$ref": "#/components/schemas/delete_flag"
}
]
}
}
},
"BusinessPaymentStatus": {
"type": "string",
"enum": [
"DRAFT",
"REVIEWING",
"REVIEW_NG",
"PAYING",
"FAILED",
"PAID",
"EXPIRED",
"CANCELED",
"DELETED"
],
"minLength": 1,
"maxLength": 40,
"example": "business_payments.regist",
"description": "ステータス。\n- `DRAFT`:下書き\n- `REVIEWING`:審査中\n- `REVIEW_NG`:審査NG\n- `PAYING`:支払い中\n- `FAILED`:失敗\n- `PAID`:支払い完了\n- `EXPIRED`:期限切れ\n- `CANCELED`:キャンセル済\n- `DELETED`:削除\n"
},
"WebhookEvent.BusinessPaymentsRegister": {
"type": "object",
"properties": {
"buyer_shop_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
]
},
"access_id": {
"type": "string",
"example": "bp_8og75dSNQgOLbxxxxxxxxx",
"description": "取引ID\n"
},
"billing_amount": {
"type": "number",
"description": "請求金額\n",
"example": 112640
},
"card_payment_fee": {
"type": "number",
"description": "カード払い手数料\n",
"example": 2252
},
"fee_rate": {
"type": "number",
"description": "手数料率\n",
"example": 0.02
},
"min_fee": {
"type": "number",
"description": "最低手数料金額\n",
"example": 1000
},
"total_amount": {
"type": "number",
"description": "合計金額\n",
"example": 114892
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPaymentStatus"
}
],
"example": "DRAFT"
},
"process_date": {
"type": "string",
"description": "処理日時\n",
"example": "2026/03/02 15:02:16.138"
},
"transaction_id": {
"type": "string",
"description": "支払い情報ID\n",
"example": "20260302144529d334a6f4-9181-4fca-b5e1-989dbf069f47"
},
"due_date": {
"type": "string",
"description": "支払期日\n",
"example": "2026/04/08"
},
"transfer_exec_date": {
"type": "string",
"description": "振込実行日\n",
"example": null
},
"remitter_name": {
"type": "string",
"description": "振込依頼人名\n",
"example": "バイヤー"
},
"receipt_id": {
"type": "string",
"description": "支払ID。\\\n支払管理の支払情報を請求書カード払いする場合に指定します。\n",
"example": null
}
}
},
"WebhookResponse": {
"type": "object",
"properties": {
"receive": {
"type": "string",
"minLength": 1,
"maxLength": 1,
"enum": [
"0",
"1"
],
"example": "0",
"description": "Webhook通知受信\\\n\\\nWebhookの受信が正常に完了したかどうかをM's PayBridgeにレスポンスします。\n\n- `0`: 受信成功
M's PayBridgeは受信に成功したと判断し、通知を終了します。\n- `1`: 受信失敗
M's PayBridgeは受信に失敗したと判断します。Webhookの受信に失敗した場合は、M's PayBridgeはリトライを行います。\n"
}
}
},
"WebhookResponse-plain": {
"type": "string",
"description": "- `0`: 受信成功
M's PayBridgeは受信に成功したと判断し、通知を終了します。\n- `1`: 受信失敗
M's PayBridgeは受信に失敗したと判断します。Webhookの受信に失敗した場合は、M's PayBridgeはリトライを行います。\n",
"example": 0
},
"WebhookEvent.BusinessPaymentsExec": {
"type": "object",
"properties": {
"buyer_shop_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
],
"example": "business_payments.exec"
},
"access_id": {
"type": "string",
"example": "bp_8og75dSNQgOLbxxxxxxxxx",
"description": "取引ID\n"
},
"billing_amount": {
"type": "number",
"description": "請求金額\n",
"example": 112640
},
"card_payment_fee": {
"type": "number",
"description": "カード払い手数料\n",
"example": 2252
},
"fee_rate": {
"type": "number",
"description": "手数料率\n",
"example": 0.02
},
"min_fee": {
"type": "number",
"description": "最低手数料金額\n",
"example": 1000
},
"total_amount": {
"type": "number",
"description": "合計金額\n",
"example": 114892
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPaymentStatus"
}
],
"example": "REVIEWING"
},
"process_date": {
"type": "string",
"description": "処理日時\n",
"example": "2026/03/02 15:02:16.138"
},
"transaction_id": {
"type": "string",
"description": "支払い情報ID\n",
"example": "20260302144529d334a6f4-9181-4fca-b5e1-989dbf069f47"
},
"due_date": {
"type": "string",
"description": "支払期日\n",
"example": "2026/04/08"
},
"transfer_exec_date": {
"type": "string",
"description": "振込実行日\n",
"example": null
},
"remitter_name": {
"type": "string",
"description": "振込依頼人名\n",
"example": "バイヤー"
},
"receipt_id": {
"type": "string",
"description": "支払ID。\\\n支払管理の支払情報を請求書カード払いする場合に指定します。\n",
"example": null
}
}
},
"WebhookEvent.BusinessPaymentsUpdate": {
"type": "object",
"properties": {
"buyer_shop_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
],
"example": "business_payments.update"
},
"access_id": {
"type": "string",
"example": "bp_8og75dSNQgOLbxxxxxxxxx",
"description": "取引ID\n"
},
"billing_amount": {
"type": "number",
"description": "請求金額\n",
"example": 112640
},
"card_payment_fee": {
"type": "number",
"description": "カード払い手数料\n",
"example": 2252
},
"fee_rate": {
"type": "number",
"description": "手数料率\n",
"example": 0.02
},
"min_fee": {
"type": "number",
"description": "最低手数料金額\n",
"example": 1000
},
"total_amount": {
"type": "number",
"description": "合計金額\n",
"example": 114892
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/BusinessPaymentStatus"
}
],
"example": "PAID"
},
"process_date": {
"type": "string",
"description": "処理日時\n",
"example": "2026/03/02 15:02:16.138"
},
"transaction_id": {
"type": "string",
"description": "支払い情報ID\n",
"example": "20260302144529d334a6f4-9181-4fca-b5e1-989dbf069f47"
},
"due_date": {
"type": "string",
"description": "支払期日\n",
"example": "2026/04/08"
},
"transfer_exec_date": {
"type": "string",
"description": "振込実行日\n",
"example": null
},
"remitter_name": {
"type": "string",
"description": "振込依頼人名\n",
"example": "バイヤー"
},
"receipt_id": {
"type": "string",
"description": "支払ID。\\\n支払管理の支払情報を請求書カード払いする場合に指定します。\n",
"example": null
}
}
},
"AcquirerTenantBuyer": {
"type": "string",
"enum": [
"BPSP"
],
"description": "審査対象\n\n- `BPSP`: 請求書カード払い\n",
"x-ja-description": "審査対象（和名）\n\n- `決済事業者審査: BPSP`\n"
},
"AcquirerContractStatus": {
"type": "string",
"enum": [
"701",
"702",
"703",
"704",
"705",
"706",
"707",
"708",
"709"
],
"description": "決済事業者 契約ステータス\n\n- `701`: 申込なし
まだこの決済手段を利用申請していません\n- `702`: 審査受付
M's PayBridgeが審査を受け付けました。まだこの決済手段は利用できません。\n- `703`: 審査待ち
M's PayBridgeによる審査開始を待っています。まだこの決済手段は利用できません。\n- `704`: 審査中
M's PayBridgeによる審査中です。まだこの決済手段は利用できません。\n- `705`: 審査保留中
審査の過程で保留中が発生しました。まだこの決済手段は利用できません。\n- `706`: 審査OK
M's PayBridgeによる審査の結果OKとなりました。まだこの決済手段は利用できません。\n- `707`: 利用可能
この決済手段は利用可能です。\n- `708`: 審査NG
M's PayBridgeによる審査の結果NGとなりました。この決済手段は利用できません。\n- `709`: 申込中止
この決済手段の利用申請を中止しました。\n",
"x-ja-description": "決済事業者 契約ステータス（和名）\n\n- `申込なし`\n- `審査受付`\n- `審査待ち`\n- `審査中`\n- `審査保留中`\n- `審査OK`\n- `利用可能`\n- `審査NG`\n- `申込中止`\n"
},
"WebhookEvent.BuyerContract": {
"type": "object",
"properties": {
"buyer_id": {
"allOf": [
{
"$ref": "#/components/schemas/buyer_id"
}
]
},
"event": {
"allOf": [
{
"$ref": "#/components/schemas/FincodeEventForBuyerPlatform"
}
]
},
"body": {
"type": "array",
"description": "テナントバイヤー決済手段 契約状況リスト\\\n\\\n決済手段の種別とその契約ステータスを含むオブジェクトの配列です。\n",
"items": {
"type": "object",
"properties": {
"acquirer": {
"allOf": [
{
"$ref": "#/components/schemas/AcquirerTenantBuyer"
}
]
},
"examination_task": {
"type": "string",
"description": "審査対象（和名）\n\n- `決済事業者審査: BPSP`\n"
},
"status_code": {
"allOf": [
{
"$ref": "#/components/schemas/AcquirerContractStatus"
}
]
},
"status": {
"type": "string",
"description": "決済事業者 契約ステータス（和名）\n\n- `申込なし`\n- `審査受付`\n- `審査待ち`\n- `審査中`\n- `審査保留中`\n- `審査OK`\n- `利用可能`\n- `審査NG`\n- `申込中止`\n"
},
"updated": {
"type": "boolean",
"description": "更新の有無\\\n\\\n更新があった場合は `true`になります。\n"
}
}
}
}
}
}
}
},
"x-tagGroups": [
{
"name": "請求書カード払い",
"tags": [
"請求書カード払い"
]
},
{
"name": "テナントバイヤー管理",
"tags": [
"テナントバイヤー"
]
},
{
"name": "テナントバイヤー申請管理",
"tags": [
"テナントバイヤー申請管理"
]
},
{
"name": "バイヤープラットフォーム精算",
"tags": [
"バイヤープラットフォーム報酬"
]
},
{
"name": "Webhook",
"tags": [
"Webhook設定",
"Webhook_通知仕様"
]
}
]
}