ReCORE.co-api

GMO銀行振込

振込検索

概要

• 振込の検索を行う

基本情報

• リクエストパス: GET /provider/gmo_banks
• JWTスコープ: provider:gmo_bank:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
referable_ids	関連先ID	整数のみ、カンマ区切りで複数指定可能
referable_type	関連先タイプ	-
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /provider/gmo_banks?statuses=PENDING

• Response

[
  {
    "id": 9,
    "store":{
      "id": 1,
      "name": "本店"
    },
    "status": "PENDING",
    "apply_no": null,
    "account_id": "2232434322322",
    "sender_name": null,
    "amount": 33,
    "bank_code": "0033",
    "bank_branch_code": "001",
    "bank_account_number": "3214234",
    "bank_account_name": "タカハシタロウ",
    "note": null,
    "referable_id": 262,
    "referable_type": "rt_bas",
    "error_code": null,
    "error_message": null,
    "done_at": null,
    "created_at": 1732770236,
    "updated_at": 1732770236
  }
]

key	type	説明
*	array<object>	振込
*.id	int	振込ID
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.status	string	ステータス
*.apply_no	string | null	GMO側振込ID
*.account_id	string	出金口座ID
*.sender_name	string | null	振込依頼名義
*.amount	int	振込金額
*.bank_code	string	銀行コード
*.bank_branch_code	string	銀行支店コード
*.bank_account_number	string	銀行口座番号
*.bank_account_name	string	銀行口座名義
*.note	string | null	メモ
*.referable_id	int | null	関連先ID
*.referable_type	string | null	関連先タイプ
*.error_code	string | null	エラーコード
*.error_message	string | null	エラー内容
*.done_at	int | null	振込完了日時
*.created_at	int | null	作成日時
*.updated_at	int | null	更新日時

• ステータス
  • PENDING 振込実行待ち
  • IN_PROGRESS 処理中
  • CANCELED キャンセル
  • DONE 振込完了
• 関連先タイプ
  • rt_bad 宅配買取
  • rt_big 一般仕入
  • rt_bac 委託仕入
  • rt_bas 店頭買取

振込取得

概要

• 振込を1件取得する

基本情報

• リクエストパス: GET /provider/gmo_banks/{gmo_bank_id}
• JWTスコープ: provider:gmo_bank:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /provider/gmo_banks/44

• Response

振込検索のresponse[0]と同様

振込作成

概要

• 振込を作成する
• ステータスPENDINGとして作成され、実際の振込実行は一括振込APIを使用

基本情報

• リクエストパス: POST /provider/gmo_banks
• JWTスコープ: provider:gmo_bank:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
account_id	string	出金口座ID	12文字以上 29文字まで
sender_name	?string | null	振込依頼名義	48文字まで、ひらがなカタカナ英数字記号のみ
amount	int	振込金額	1以上
bank_code	string	銀行コード	4文字、数値のみ
bank_branch_code	string	銀行支店コード	3文字、数値のみ
bank_account_number	string	銀行口座番号	7文字、数値のみ
bank_account_name	string	銀行口座名義	30文字まで、ひらがなカタカナ英数字記号のみ
note	?string | null	メモ	-
referable_id	?int | null	関連先ID	-
referable_type	?string | null	関連先タイプ	-

例

• Request

POST /provider/gmo_banks

{
  "account_id": "2232434322322",
  "amount": 33,
  "bank_code": "0033",
  "bank_branch_code": "001",
  "bank_account_number": "3214234",
  "bank_account_name": "タカハシタロウ"
}

• Response

振込取得と同様

振込更新

概要

• 振込を更新する
• ステータスPENDINGのみ更新可

基本情報

• リクエストパス: PUT /provider/gmo_banks/{gmo_bank_id}
• JWTスコープ: provider:gmo_bank:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

振込作成との差分のみ記載

key	type	説明	制約など
account_id	?string	出金口座ID	12文字以上 29文字まで
amount	?int	振込金額	1以上
bank_code	?string	銀行コード	4文字、数値のみ
bank_branch_code	?string	銀行支店コード	3文字、数値のみ
bank_account_number	?string	銀行口座番号	7文字、数値のみ
bank_account_name	?string	銀行口座名義	30文字まで、ひらがなカタカナ英数字記号のみ

例

• Request

PUT /provider/gmo_banks/44

{
  "note": "メモ"
}

• Response

振込取得と同様

振込削除

概要

• 振込を削除する
• ステータスPENDINGのみ削除可

基本情報

• リクエストパス: DELETE /provider/gmo_banks/{gmo_bank_id}
• JWTスコープ: provider:gmo_bank:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

例

• Request

DELETE /provider/gmo_banks/44

• Response

なし

コンフィグ取得

概要

• 設定値を取得する

基本情報

• リクエストパス: GET /provider/gmo_banks/config
• JWTスコープ: provider:gmo_bank:config:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /provider/gmo_banks/config

• Response

{
  "is_enabled": true,
  "accounts":[
    {
      "id": "102011692518",
      "name": "1692518: 株式会社ＮＯＶＡＳＴＯ"
    }
  ]
}

key	type	説明
is_enabled	boolean	有効かどうか
accounts	array<object>	出金口座
accounts.*.id	string	出金口座ID
accounts.*.name	string	出金口座名

一括振込実行

概要

• ステータスPENDINGのリソースに対し、実際に振込実行を行う

基本情報

• リクエストパス: PUT /provider/gmo_banks/transfer
• JWTスコープ: provider:gmo_bank:transfer:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
*	array<object>	-	-
*.gmo_bank_id	int	振込ID	-

例

• Request

PUT /provider/gmo_banks/transfer

[
  {
    "gmo_bank_id": 18
  },
  {
    "gmo_bank_id": 19
  }
]

• Response

なし

一括振込キャンセル

概要

• ステータスPENDINGのリソースに対し、振込キャンセルを行う

基本情報

• リクエストパス: PUT /provider/gmo_banks/cancel
• JWTスコープ: provider:gmo_bank:cancel:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
*	array<object>	-	-
*.gmo_bank_id	int	振込ID	-

例

• Request

PUT /provider/gmo_banks/cancel

[
  {
    "gmo_bank_id": 18
  },
  {
    "gmo_bank_id": 19
  }
]

• Response

なし