# M's PayBridge API

> M's PayBridgeのAPIリファレンスです。 (version 1.0.0)

- 本番環境: https://api.fincode.jp
- テスト環境: https://api.test.fincode.jp

## エンドポイント

### 顧客
- [GET /v1/customers](/reference/mpb/endpoints/get-v1-customers.md): 顧客 一覧取得
- [POST /v1/customers](/reference/mpb/endpoints/post-v1-customers.md): 顧客 登録
- [GET /v1/customers/{id}](/reference/mpb/endpoints/get-v1-customers-id.md): 顧客 取得
- [PUT /v1/customers/{id}](/reference/mpb/endpoints/put-v1-customers-id.md): 顧客 更新
- [DELETE /v1/customers/{id}](/reference/mpb/endpoints/delete-v1-customers-id.md): 顧客 削除

### カード
- [GET /v1/customers/{customer_id}/cards](/reference/mpb/endpoints/get-v1-customers-customer-id-cards.md): カード 一覧取得
- [POST /v1/customers/{customer_id}/cards](/reference/mpb/endpoints/post-v1-customers-customer-id-cards.md): カード 登録
- [GET /v1/customers/{customer_id}/cards/{id}](/reference/mpb/endpoints/get-v1-customers-customer-id-cards-id.md): カード 取得
- [PUT /v1/customers/{customer_id}/cards/{id}](/reference/mpb/endpoints/put-v1-customers-customer-id-cards-id.md): カード 更新
- [DELETE /v1/customers/{customer_id}/cards/{id}](/reference/mpb/endpoints/delete-v1-customers-customer-id-cards-id.md): カード 削除
- [GET /v1/cards](/reference/mpb/endpoints/get-v1-cards.md): カード 一覧取得（顧客情報共有グループ単位）

### 決済手段
- [GET /v1/customers/{customer_id}/payment_methods](/reference/mpb/endpoints/get-v1-customers-customer-id-payment-methods.md): 決済手段 一覧取得
- [POST /v1/customers/{customer_id}/payment_methods](/reference/mpb/endpoints/post-v1-customers-customer-id-payment-methods.md): 決済手段 登録
- [GET /v1/customers/{customer_id}/payment_methods/{id}](/reference/mpb/endpoints/get-v1-customers-customer-id-payment-methods-id.md): 決済手段 取得
- [PUT /v1/customers/{customer_id}/payment_methods/{id}](/reference/mpb/endpoints/put-v1-customers-customer-id-payment-methods-id.md): 決済手段 更新
- [DELETE /v1/customers/{customer_id}/payment_methods/{id}](/reference/mpb/endpoints/delete-v1-customers-customer-id-payment-methods-id.md): 決済手段 削除
- [PUT /v1/customers/{customer_id}/payment_methods/{id}/reactivate](/reference/mpb/endpoints/put-v1-customers-customer-id-payment-methods-id-reactivate.md): 決済手段 再有効化
- [PUT /v1/customers/{customer_id}/payment_methods/{id}/inactivate](/reference/mpb/endpoints/put-v1-customers-customer-id-payment-methods-id-inactivate.md): 決済手段 停止

### 決済
- [GET /v1/payments](/reference/mpb/endpoints/get-v1-payments.md): 決済 一覧取得
- [POST /v1/payments](/reference/mpb/endpoints/post-v1-payments.md): 決済 登録
- [GET /v1/payments/{id}](/reference/mpb/endpoints/get-v1-payments-id.md): 決済 取得
- [PUT /v1/payments/{id}](/reference/mpb/endpoints/put-v1-payments-id.md): 決済 実行
- [PUT /v1/payments/{id}/capture](/reference/mpb/endpoints/put-v1-payments-id-capture.md): 決済 売上確定
- [PUT /v1/payments/{id}/cancel](/reference/mpb/endpoints/put-v1-payments-id-cancel.md): 決済 キャンセル
- [PUT /v1/payments/{id}/auth](/reference/mpb/endpoints/put-v1-payments-id-auth.md): 決済 再オーソリ
- [PUT /v1/payments/{id}/change](/reference/mpb/endpoints/put-v1-payments-id-change.md): 決済 金額変更
- [PUT /v1/payments/{id}/secure](/reference/mpb/endpoints/put-v1-payments-id-secure.md): 認証後決済 実行
- [PUT /v1/payments/{id}/barcode](/reference/mpb/endpoints/put-v1-payments-id-barcode.md): バーコード発行

### 3Dセキュア認証
- [GET /v1/secure2/{access_id}](/reference/mpb/endpoints/get-v1-secure2-access-id.md): 3Dセキュア 認証結果確定
- [PUT /v1/secure2/{access_id}](/reference/mpb/endpoints/put-v1-secure2-access-id.md): 3Dセキュア 認証実行

### リダイレクト型決済
- [POST /v1/sessions](/reference/mpb/endpoints/post-v1-sessions.md): 決済URL 作成

### リダイレクト型カード登録
- [POST /v1/card_sessions](/reference/mpb/endpoints/post-v1-card-sessions.md): カード登録URL 作成

### プラン
- [GET /v1/plans](/reference/mpb/endpoints/get-v1-plans.md): プラン 一覧取得
- [POST /v1/plans](/reference/mpb/endpoints/post-v1-plans.md): プラン 登録
- [GET /v1/plans/{id}](/reference/mpb/endpoints/get-v1-plans-id.md): プラン 取得
- [PUT /v1/plans/{id}](/reference/mpb/endpoints/put-v1-plans-id.md): プラン 更新
- [DELETE /v1/plans/{id}](/reference/mpb/endpoints/delete-v1-plans-id.md): プラン 削除

### サブスクリプション
- [GET /v1/subscriptions](/reference/mpb/endpoints/get-v1-subscriptions.md): サブスクリプション 一覧取得
- [POST /v1/subscriptions](/reference/mpb/endpoints/post-v1-subscriptions.md): サブスクリプション 登録
- [GET /v1/subscriptions/{id}](/reference/mpb/endpoints/get-v1-subscriptions-id.md): サブスクリプション 取得
- [PUT /v1/subscriptions/{id}](/reference/mpb/endpoints/put-v1-subscriptions-id.md): サブスクリプション 更新
- [DELETE /v1/subscriptions/{id}](/reference/mpb/endpoints/delete-v1-subscriptions-id.md): サブスクリプション 解約
- [GET /v1/subscriptions/{id}/result](/reference/mpb/endpoints/get-v1-subscriptions-id-result.md): サブスクリプション結果 一覧取得

### 一括決済
- [GET /v1/payments/bulk](/reference/mpb/endpoints/get-v1-payments-bulk.md): 一括決済 一覧取得
- [POST /v1/payments/bulk](/reference/mpb/endpoints/post-v1-payments-bulk.md): 一括決済 登録
- [GET /v1/payments/bulk/{id}](/reference/mpb/endpoints/get-v1-payments-bulk-id.md): 一括決済詳細 一覧取得
- [DELETE /v1/payments/bulk/{id}](/reference/mpb/endpoints/delete-v1-payments-bulk-id.md): 一括決済 削除

### インボイス機能
- [GET /v1/invoices](/reference/mpb/endpoints/get-v1-invoices.md): インボイス 一覧取得
- [POST /v1/invoices](/reference/mpb/endpoints/post-v1-invoices.md): インボイス 作成
- [GET /v1/invoices/{id}](/reference/mpb/endpoints/get-v1-invoices-id.md): インボイス 取得
- [PUT /v1/invoices/{id}](/reference/mpb/endpoints/put-v1-invoices-id.md): インボイス 更新
- [DELETE /v1/invoices/{id}](/reference/mpb/endpoints/delete-v1-invoices-id.md): インボイス 削除
- [PUT /v1/invoices/{id}/open](/reference/mpb/endpoints/put-v1-invoices-id-open.md): インボイス 発行
- [PUT /v1/invoices/{id}/cancel](/reference/mpb/endpoints/put-v1-invoices-id-cancel.md): インボイス キャンセル
- [PUT /v1/invoices/{id}/paid_externally](/reference/mpb/endpoints/put-v1-invoices-id-paid-externally.md): インボイス 外部支払いマーク
- [PUT /v1/invoices/{id}/virtual_account/refresh](/reference/mpb/endpoints/put-v1-invoices-id-virtual-account-refresh.md): インボイス バーチャル口座再発行
- [PUT /v1/invoices/{id}/amount_register/payee_account](/reference/mpb/endpoints/put-v1-invoices-id-amount-register-payee-account.md): インボイス 入金登録（銀行振込（指定口座））
- [PUT /v1/invoices/{id}/capture/payee_account](/reference/mpb/endpoints/put-v1-invoices-id-capture-payee-account.md): インボイス 支払い完了（銀行振込（指定口座））

### 請求管理
- [GET /v1/billings](/reference/mpb/endpoints/get-v1-billings.md): 請求 一覧取得
- [POST /v1/billings](/reference/mpb/endpoints/post-v1-billings.md): 請求書 作成
- [GET /v1/billings/{id}](/reference/mpb/endpoints/get-v1-billings-id.md): 請求 取得
- [PUT /v1/billings/{id}](/reference/mpb/endpoints/put-v1-billings-id.md): 請求 更新
- [DELETE /v1/billings/{id}](/reference/mpb/endpoints/delete-v1-billings-id.md): 請求 削除
- [PUT /v1/billings/{id}/open](/reference/mpb/endpoints/put-v1-billings-id-open.md): 請求 発行
- [PUT /v1/billings/{id}/cancel](/reference/mpb/endpoints/put-v1-billings-id-cancel.md): 請求 キャンセル
- [PUT /v1/billings/{id}/paid_externally](/reference/mpb/endpoints/put-v1-billings-id-paid-externally.md): 請求 外部支払いマーク
- [PUT /v1/billings/{id}/virtual_account/refresh](/reference/mpb/endpoints/put-v1-billings-id-virtual-account-refresh.md): 請求 バーチャル口座再発行
- [PUT /v1/billings/{id}/amount_register/payee_account](/reference/mpb/endpoints/put-v1-billings-id-amount-register-payee-account.md): 請求 入金登録（銀行振込（指定口座））
- [PUT /v1/billings/{id}/capture/payee_account](/reference/mpb/endpoints/put-v1-billings-id-capture-payee-account.md): 請求 支払い完了（銀行振込（指定口座））

### 売上入金
- [GET /v1/accounts](/reference/mpb/endpoints/get-v1-accounts.md): 売上入金 一覧取得
- [GET /v1/accounts/{id}](/reference/mpb/endpoints/get-v1-accounts-id.md): 売上入金 取得
- [GET /v1/accounts/{id}/detail](/reference/mpb/endpoints/get-v1-accounts-id-detail.md): 売上入金詳細 一覧取得

### プラットフォーム利用料収入
- [GET /v1/platform_accounts](/reference/mpb/endpoints/get-v1-platform-accounts.md): プラットフォーム利用料収入 一覧取得
- [GET /v1/platform_accounts/{id}](/reference/mpb/endpoints/get-v1-platform-accounts-id.md): プラットフォーム利用料収入 取得
- [GET /v1/platform_accounts/{id}/summary](/reference/mpb/endpoints/get-v1-platform-accounts-id-summary.md): プラットフォーム利用料収入サマリー 一覧取得

### チャージバック
- [GET /v1/shop_charge_backs](/reference/mpb/endpoints/get-v1-shop-charge-backs.md): チャージバック 一覧取得
- [GET /v1/shop_charge_backs/{id}](/reference/mpb/endpoints/get-v1-shop-charge-backs-id.md): チャージバック 取得
- [POST /v1/shop_charge_backs/{id}/reply](/reference/mpb/endpoints/post-v1-shop-charge-backs-id-reply.md): チャージバック 回答登録
- [POST /v1/charge_backs/file_upload](/reference/mpb/endpoints/post-v1-charge-backs-file-upload.md): チャージバック 反証資料アップロード

### プラットフォームショップ
- [GET /v1/platforms](/reference/mpb/endpoints/get-v1-platforms.md): プラットフォームショップ 一覧取得
- [GET /v1/platforms/{id}](/reference/mpb/endpoints/get-v1-platforms-id.md): プラットフォームショップ 取得
- [PUT /v1/platforms/{id}](/reference/mpb/endpoints/put-v1-platforms-id.md): プラットフォームショップ 更新

### テナントショップ
- [GET /v1/tenants](/reference/mpb/endpoints/get-v1-tenants.md): テナントショップ 一覧取得
- [GET /v1/tenants/{id}](/reference/mpb/endpoints/get-v1-tenants-id.md): テナントショップ 取得
- [PUT /v1/tenants/{id}](/reference/mpb/endpoints/put-v1-tenants-id.md): テナントショップ 更新

### テナント申請管理
- [POST /v1/tenant_entries](/reference/mpb/endpoints/post-v1-tenant-entries.md): テナントショップ 作成（新規ユーザー登録）
- [POST /v1/join_tenants](/reference/mpb/endpoints/post-v1-join-tenants.md): テナントショップ 作成（既存ユーザー参加）
- [GET /v1/contracts/examinations_v2/tenants/{id}](/reference/mpb/endpoints/get-v1-contracts-examinations-v2-tenants-id.md): テナントショップ本番環境申請情報 取得
- [PUT /v1/contracts/examinations_v2/tenants/{id}](/reference/mpb/endpoints/put-v1-contracts-examinations-v2-tenants-id.md): テナントショップ本番環境申請情報 更新
- [POST /v1/contracts/examinations/tenants/{id}/files](/reference/mpb/endpoints/post-v1-contracts-examinations-tenants-id-files.md): テナントショップ 審査ファイルアップロード
- [POST /v1/contracts/examinations](/reference/mpb/endpoints/post-v1-contracts-examinations.md): テナントショップ 本番環境申請
- [POST /v1/contracts/examinations/tenants/{id}/providers/reserve](/reference/mpb/endpoints/post-v1-contracts-examinations-tenants-id-providers-reserve.md): テナントショップ 決済手段追加申請
- [GET /v1/contracts/{id}](/reference/mpb/endpoints/get-v1-contracts-id.md): テナントショップ契約情報 取得
- [POST /v1/change_requests](/reference/mpb/endpoints/post-v1-change-requests.md): テナントショップ 変更申請 登録
- [GET /v1/change_requests/{shopId}](/reference/mpb/endpoints/get-v1-change-requests-shopid.md): テナントショップ 変更申請 取得

### 社印
- [GET /v1/company_stamps](/reference/mpb/endpoints/get-v1-company-stamps.md): 社印 取得
- [POST /v1/company_stamps](/reference/mpb/endpoints/post-v1-company-stamps.md): 社印 登録
- [DELETE /v1/company_stamps](/reference/mpb/endpoints/delete-v1-company-stamps.md): 社印 削除

### ショップ決済手段
- [GET /v1/shops/payment_methods](/reference/mpb/endpoints/get-v1-shops-payment-methods.md): ショップ決済手段 一覧取得
- [POST /v1/shops/payment_methods](/reference/mpb/endpoints/post-v1-shops-payment-methods.md): ショップ決済手段 登録
- [GET /v1/shops/payment_methods/{id}](/reference/mpb/endpoints/get-v1-shops-payment-methods-id.md): ショップ決済手段 取得
- [PUT /v1/shops/payment_methods/{id}](/reference/mpb/endpoints/put-v1-shops-payment-methods-id.md): ショップ決済手段 更新
- [DELETE /v1/shops/payment_methods/{id}](/reference/mpb/endpoints/delete-v1-shops-payment-methods-id.md): ショップ決済手段 削除

### Webhook設定
- [GET /v1/webhook_settings](/reference/mpb/endpoints/get-v1-webhook-settings.md): Webhook設定 一覧取得
- [POST /v1/webhook_settings](/reference/mpb/endpoints/post-v1-webhook-settings.md): Webhook設定 登録
- [GET /v1/webhook_settings/{id}](/reference/mpb/endpoints/get-v1-webhook-settings-id.md): Webhook設定 取得
- [PUT /v1/webhook_settings/{id}](/reference/mpb/endpoints/put-v1-webhook-settings-id.md): Webhook設定 更新
- [DELETE /v1/webhook_settings/{id}](/reference/mpb/endpoints/delete-v1-webhook-settings-id.md): Webhook設定 削除

### Webhook_通知仕様
- [POST /your-endpoint-on-card-payment](/reference/mpb/endpoints/post-your-endpoint-on-card-payment.md): カード決済
- [POST /your-endpoint-on-applepay-payment](/reference/mpb/endpoints/post-your-endpoint-on-applepay-payment.md): Apple Pay
- [POST /your-endpoint-on-googlepay-payment](/reference/mpb/endpoints/post-your-endpoint-on-googlepay-payment.md): GooglePay
- [POST /your-endpoint-on-konbini-payment](/reference/mpb/endpoints/post-your-endpoint-on-konbini-payment.md): コンビニ決済
- [POST /your-endpoint-on-paypay-payment](/reference/mpb/endpoints/post-your-endpoint-on-paypay-payment.md): PayPay
- [POST /your-endpoint-on-directdebit-payment](/reference/mpb/endpoints/post-your-endpoint-on-directdebit-payment.md): 口座振替
- [POST /your-endpoint-on-virtualaccount-payment](/reference/mpb/endpoints/post-your-endpoint-on-virtualaccount-payment.md): 銀行振込（バーチャル口座）
- [POST /your-endpoint-on-customer-payment_method](/reference/mpb/endpoints/post-your-endpoint-on-customer-payment-method.md): 決済手段
- [POST /your-endpoint-on-card](/reference/mpb/endpoints/post-your-endpoint-on-card.md): カード
- [POST /your-endpoint-on-card-updater-complete](/reference/mpb/endpoints/post-your-endpoint-on-card-updater-complete.md): カード：カード更新機能（洗替）
- [POST /your-endpoint-on-card-subscription](/reference/mpb/endpoints/post-your-endpoint-on-card-subscription.md): サブスクリプション（カード決済）
- [POST /your-endpoint-on-directdebit-subscription](/reference/mpb/endpoints/post-your-endpoint-on-directdebit-subscription.md): サブスクリプション（口座振替）
- [POST /your-endpoint-on-card-recurring-batch](/reference/mpb/endpoints/post-your-endpoint-on-card-recurring-batch.md): サブスクリプション課金（カード決済）
- [POST /your-endpoint-on-directdebit-recurring-batch](/reference/mpb/endpoints/post-your-endpoint-on-directdebit-recurring-batch.md): サブスクリプション課金（口座振替）
- [POST /your-endpoint-on-card-payment-bulk-regist](/reference/mpb/endpoints/post-your-endpoint-on-card-payment-bulk-regist.md): 一括決済
- [POST /your-endpoint-on-card-payment-bulk-batch](/reference/mpb/endpoints/post-your-endpoint-on-card-payment-bulk-batch.md): 一括決済課金
- [POST /your-endpoint-on-contract](/reference/mpb/endpoints/post-your-endpoint-on-contract.md): 決済手段 契約状況
- [POST /your-endpoint-on-invoice](/reference/mpb/endpoints/post-your-endpoint-on-invoice.md): インボイス
- [POST /your-endpoint-on-chargeback](/reference/mpb/endpoints/post-your-endpoint-on-chargeback.md): チャージバック
- [POST /your-endpoint-on-change-request](/reference/mpb/endpoints/post-your-endpoint-on-change-request.md): 変更申請

## ガイド

- [文字コード](/reference/mpb/guides/guide-1.md): M's PayBridgeのリクエスト・レスポンスの文字コードはUTF-8が使用されます。
- [リクエストヘッダー](/reference/mpb/guides/guide-2.md): M's PayBridgeのAPIリクエストを行う際に指定可能なリクエストヘッダーの一覧です。
- [ページネーション](/reference/mpb/guides/guide-3.md): 一覧取得系のAPIは大量データの送信を防ぐためにページング機能が実装されています。
- [冪等処理](/reference/mpb/guides/guide-4.md): 加盟店様がAPIリクエストのリクエストヘッダー`idempotent_key`に冪等キー（任意）を設定することで、リクエストを一意に特定し、2回目以降のリクエストで同じ結果を返却します。
- [エラーオブジェクト](/reference/mpb/guides/guide-5.md): HTTPステータスコード`4xx`系と`5xx`系のエラーが発生した場合、API共通のエラーオブジェクトを返します。
- [エラー](/reference/mpb/guides/guide-6.md): APIリクエスト後、以下のHTTPステータスコードとともにレスポンスがされます。

## 仕様データ

- [OpenAPI (yml)](/reference/mpb/openapi.yml)
- [OpenAPI (json)](/reference/mpb/openapi.json)
- [エラーコード (json)](/reference/mpb/errors.json)
- [エラーコード (md)](/reference/mpb/guides/errors.md)