API docs by Redocly

MPM API (0.0.1)

Download OpenAPI specification:Download

License: valuedesign inc.

MPM サービスAPI

user

ユーザー

ユーザ情報取得

ユーザ情報を取得します

エラーコード

エラーコード エラー内容 備考
E-UG-001 ユーザー情報が見つからない -
E-UG-002 Cognitoからの情報取得時に想定外のエラー -
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "mailaddress": "user@example.com",
  • "logged_in_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

ユーザー情報削除

ユーザ情報を削除します

エラーコード

エラーコード エラー内容 備考
E-UD-001 パスワード誤り -
E-UD-002 アカウント認証時に想定外のエラー -
E-UD-003 DB接続エラー -
E-UD-004 DB側のアカウント情報削除に失敗 -
E-UD-005 Cognito上に削除の対象となるアカウントが存在しない -
E-UD-006 Cognito上のアカウント削除処理時に想定外のエラー -
E-UD-007 アカウント削除処理時に想定外のエラー -
E-UD-008 退会通知メール送信失敗 ログ出力のみ
Authorizations:
bearerAuth
Request Body schema: application/json
password
required
string <password> (password)

パスワード

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "title": "エラー",
  • "code": "E-XXX",
  • "message": "処理エラー"
}

ログイン

ログイン状態に遷移して、アクセストークンの発行及び有効化を行う

エラーコード

エラーコード エラー内容 備考
E-LI-001 アカウント情報が存在しない -
E-LI-002 Cognitoからの情報取得時に想定外のエラー -
E-LI-003 一時的にログインが制限されている 複数回ログインに失敗した等でアカウントロック
E-LI-004 認証失敗回数の更新に失敗 回数加算
E-LI-005 認証失敗 -
E-LI-006 認証処理を行う際に想定外のエラー -
E-LI-007 認証失敗回数の更新に失敗 回数リセット
E-LI-008 ログイン通知メール送信失敗 ログ出力のみ
E-LI-009 リクエスト不備 -
Request Body schema: application/json
mailaddress
required
string <email> (mailaddress)

メールアドレス

password
required
string <password> (password)

パスワード

remember
boolean (remember)
Default: false

ログイン状態を保持

Responses

Request samples

Content type
application/json
{
  • "mailaddress": "user@example.com",
  • "password": "pa$$word",
  • "remember": false
}

Response samples

Content type
application/json
Example
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "mailaddress": "user@example.com",
  • "logged_in_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "tokens": {
    }
}

認証系のトークン更新

リフレッシュトークンを用いて、各種認証系トークンの更新を行う

エラーコード

エラーコード エラー内容 備考
E-TR-001 Cookieが存在しない 再ログインを推奨する
E-TR-002 Cookie情報の取得に失敗 サポートへの連絡を推奨する
E-TR-003 Cookieにリフレッシュトークンが存在しない 再ログインを推奨する
E-TR-004 リフレッシュトークンが無効 再ログインを推奨する
E-TR-005 認証トークン更新時に想定外のエラー サポートへの連絡を推奨する
Authorizations:
cookieRefreshAuth
Request Body schema: application/json
user_id
required
string (userId)

ユーザID

Responses

Request samples

Content type
application/json
{
  • "user_id": "string"
}

Response samples

Content type
application/json
Example
{
  • "tokens": {
    }
}

ログアウト

ログアウト状態に遷移して、リフレッシュトークンの無効化を行う

エラーコード

エラーコード エラー内容 備考
E-LO-001 Cookie情報の取得に失敗 -
E-LO-002 リフレッシュトークン無効化処理を行う際、エラーが発生した -
Authorizations:
cookieRefreshAuth

Responses

Response samples

Content type
application/json
{
  • "title": "エラー",
  • "code": "E-XXX",
  • "message": "処理エラー"
}

password

パスワード変更

パスワード変更

  1. パスワードの変更を行う
  2. パスワードの変更完了メールを送信する

    エラーコード

    エラーコード エラー内容 備考
    E-PCC-001 ユーザー情報が見つからない -
    E-PCC-002 パスワード誤り -
    E-PCC-003 パスワード要件を満たしていない -
    E-PCC-004 パスワード変更処理時に想定外のエラー -
    E-PCC-005 Cognitoのユーザー情報にメールアドレスが存在しない -
    E-PCC-006 パスワード変更回数上限 -
Authorizations:
bearerAuth
Request Body schema: application/json
user_id
required
string (userId)

ユーザID

old_password
required
string <password> (password)

パスワード

new_password
required
string <password> (password)

パスワード

access_token
required
string (accessToken)

アクセストークン

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "old_password": "pa$$word",
  • "new_password": "pa$$word",
  • "access_token": "string"
}

Response samples

Content type
application/json
Example
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "mailaddress": "user@example.com",
  • "logged_in_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

パスワードリセットメール送信

指定したメールアドレスにパスワードリセットメール（パスワード変更トークン）の送信を行う 該当するメールアドレスが存在しなくても正常に終了する

エラーコード

エラーコード エラー内容 備考
E-PRR-001 Cognitoからの情報取得時に想定外のエラー -
E-PRR-002 パスワードの初期設定がまだ行われていない アカウント状態が「仮登録」
E-PRR-003 ユーザーIDの取得に失敗 -
E-PRR-004 Cognitoのアカウントステータス更新時に想定外のエラー -
E-PRR-005 パスワードリセット回数のソフト上限到達 -
E-PRR-006 Cognitoのパスワードリセットメール送信時に想定外のエラー -
Request Body schema: application/json
mailaddress
required
string <email> (mailaddress)

メールアドレス

Responses

Request samples

Content type
application/json
{
  • "mailaddress": "user@example.com"
}

Response samples

Content type
application/json
{
  • "title": "エラー",
  • "code": "E-XXX",
  • "message": "処理エラー"
}

パスワードリセット完了

  1. パスワードのリセットを完了する
  2. ログオフ状態であればログイン状態に遷移する
  3. パスワードのリセット完了メールを送信する

    エラーコード

    エラーコード エラー内容 備考
    E-PRV-001 パスワード要件を満たしていない -
    E-PRV-002 confirmation_code不一致 -
    E-PRV-003 confirmation_code期限切れ -
    E-PRV-004 Cognitoのパスワードリセット処理時に想定外のエラー -
    E-PRV-005 Cognitoのユーザー情報取得時に想定外のエラー -
    E-PRV-006 Cognitoのユーザー情報にメールアドレスが存在しない -
    E-PRV-007 パスワードリセット後のログイン処理時にエラー -
    E-PRV-008 アカウントステータス更新時にエラー -
    E-PRV-009 リセット通知メール送信失敗 ログ出力のみ
    E-PRV-010 リクエスト不足または不正なリクエスト -
Request Body schema: application/json
user_id
required
string (userId)

ユーザID

password
required
string <password> (password)

パスワード

confirmation_code
required
string (confirmationCode)

承認コード

remember
boolean (remember)
Default: false

ログイン状態を保持

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "password": "pa$$word",
  • "confirmation_code": "string",
  • "remember": false
}

Response samples

Content type
application/json
Example
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "mailaddress": "user@example.com",
  • "logged_in_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "tokens": {
    }
}

mailaddress

メールアドレス変更

メールアドレス変更メール送信

メールアドレス変更トークンメールの送信を行う

エラーコード

エラーコード エラー内容 備考
E-MR-001 ユーザー情報が見つからない -
E-MR-002 メールアドレスが変更前のものと同じ -
E-MR-003 すでに登録済みのメールアドレス -
E-MR-004 想定外の要因でメールアドレス変更失敗 -
E-MR-005 想定外の要因でDBとの接続失敗 -
E-MR-006 再利用可能期間が経過していないメールアドレス -
E-MR-007 変更申請通知メール送信失敗 変更前のアドレスに送信されるメール
Authorizations:
bearerAuth
Request Body schema: application/json
mailaddress
required
string <email> (mailaddress)

メールアドレス

user_id
required
string (userId)

ユーザID

access_token
required
string (accessToken)

アクセストークン

Responses

Request samples

Content type
application/json
{
  • "mailaddress": "user@example.com",
  • "user_id": "string",
  • "access_token": "string"
}

Response samples

Content type
application/json
{
  • "title": "エラー",
  • "code": "E-XXX",
  • "message": "処理エラー"
}

メールアドレス変更完了

  1. メールアドレスの変更を完了する
  2. メールアドレスの変更完了メールを送信する

    エラーコード

    エラーコード エラー内容 備考
    E-MV-001 Cognito側のユーザー情報取得時に想定外のエラー -
    E-MV-002 Cognito側に変更予定のメールアドレスが設定されていない or アカウントステータスがアクティベート以外 -
    E-MV-003 DB側のアカウント情報取得時に想定外のエラー -
    E-MV-004 登録済みor再利用可能期間が経過していないメールアドレスへの変更 -
    E-MV-005 DB側の更新対象が存在しなかった -
    E-MV-006 confirmation_code不一致 -
    E-MV-007 confirmation_code期限切れ -
    E-MV-008 Cognito側のメールアドレス変更時に想定外のエラー -
    E-MV-009 DB側のアカウント情報の更新時に想定外のエラー -
    E-MV-010 Cognito情報の更新失敗 更新失敗でも影響自体はない為ログ出力のみ
    E-MV-011 変更通知メール送信失敗 変更自体は完了済みの為ログ出力のみ
Authorizations:
bearerAuth
Request Body schema: application/json
user_id
required
string (userId)

ユーザID

confirmation_code
required
string (confirmationCode)

承認コード

access_token
required
string (accessToken)

アクセストークン

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "confirmation_code": "string",
  • "access_token": "string"
}

Response samples

Content type
application/json
Example
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "mailaddress": "user@example.com",
  • "logged_in_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

signup

ユーザー登録

ユーザ登録メール送信

指定したメールアドレスにユーザ登録トークンメールの送信を行う 既にユーザ登録済みの場合は正常終了して、ユーザ登録が試みられた事を知らせるメールを送信する

エラーコード

エラーコード エラー内容 備考
E-SR-001 リクエスト不足または不正なリクエスト -
E-SR-002 CognitoのID情報取得に失敗 仮登録済みアカウントが対象
E-SR-003 メールアドレス確認処理時に想定外のエラー -
E-SR-004 登録済みor再利用期間が経過していないメールアドレス -
E-SR-005 Cognitoへのユーザー作成処理が失敗 -
E-SR-006 CognitoのID情報取得に失敗 -
E-SR-007 仮パスワードの設定に失敗 -
E-SR-008 パスワードリセット処理が失敗 新規登録はパスワードリセット機能で擬似的に実装
E-SR-009 DBへのアカウント情報登録時に想定外のエラー -
E-SR-010 Cognitoへの情報更新処理に失敗 -
E-SR-011 パスワードリセット処理が失敗 仮登録済みアカウントが対象
E-SR-012 登録済みメールアドレスが利用されたことを通知するメールの送信失敗 ログ出力のみ
Request Body schema: application/json
mailaddress
required
string <email> (mailaddress)

メールアドレス

from
string (from)

ログイン状態後の遷移先

Responses

Request samples

Content type
application/json
{
  • "mailaddress": "user@example.com",
  • "from": "string"
}

Response samples

Content type
application/json
{
  • "title": "エラー",
  • "code": "E-XXX",
  • "message": "処理エラー"
}

ユーザ登録完了

  1. ユーザ情報の登録を完了する
  2. ログイン状態になる
  3. ユーザ情報登録完了メールを送信する

    エラーコード

    エラーコード エラー内容 備考
    E-SV-001 パスワード要件を満たしていない -
    E-SV-002 confirmation_code不一致 -
    E-SV-003 confirmation_code期限切れ -
    E-SV-004 Cognitoのパスワードリセット処理時に想定外のエラー 新規登録はパスワードリセット機能で擬似的に実装
    E-SV-005 Cognitoへの情報更新に失敗 -
    E-SV-006 Cognitoのユーザー情報取得に失敗 -
    E-SV-007 Cognitoにメールアドレスの情報が存在しない -
    E-SV-008 DB側のアカウント情報の更新に失敗 -
    E-SV-009 ログイン処理に失敗 -
    E-SV-010 登録完了メール送信失敗 ログ出力のみ
    E-SV-011 リクエスト不足または不正なリクエスト -
Request Body schema: application/json
user_id
required
string (userId)

ユーザID

password
required
string <password> (password)

パスワード

confirmation_code
required
string (confirmationCode)

承認コード

remember
boolean (remember)
Default: false

ログイン状態を保持

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "password": "pa$$word",
  • "confirmation_code": "string",
  • "remember": false
}

Response samples

Content type
application/json
Example
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "mailaddress": "user@example.com",
  • "logged_in_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "tokens": {
    }
}

application

アプリケーション情報

お知らせ情報一覧の取得

お知らせ情報の一覧を取得する
カード設定IDが指定されている場合は、カード設定に関連するお知らせ情報も含める

エラーコード

エラーコード エラー内容 備考
E-GNL-001 リクエスト不足または不正なリクエスト -
E-GNL-002 情報取得時に想定外のエラー -
Authorizations:
bearerAuth
query Parameters
card_config_id
string <uuid>

カード設定ID

offset
integer >= 0
Default: 0

オフセット

limit
integer
Default: 20

取得件数

is_system
boolean

システムお知らせ指定

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

お知らせ情報の取得

お知らせ情報を取得します

エラーコード

エラーコード エラー内容 備考
E-GND-001 お知らせ情報が見つからない -
E-GND-002 情報取得時に想定外のエラー -
Authorizations:
bearerAuth
path Parameters
notification_id
required
string <uuid>

お知らせ情報ID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "card_config_id": "xxxx-xxxx-xxxxx",
  • "link_url": "http://example.com",
  • "is_system": true,
  • "is_force": true,
  • "pinned_from": "2019-08-24T14:15:22Z",
  • "pinned_to": "2019-08-24T14:15:22Z",
  • "notified_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

最新のお知らせ情報の取得

最新のお知らせ情報を取得します

  • latest
    • 最新のお知らせ
  • pinned
    • 最新の抜粋表示するお知らせ
  • force
    • 最新の強制表示するお知らせ

      エラーコード

      エラーコード エラー内容 備考
      E-GN-001 カード設定情報が見つからない リクエストにカード設定IDが存在する場合に確認
      E-GN-002 情報取得時に想定外のエラー -
Authorizations:
bearerAuth
query Parameters
card_config_id
string <uuid>

カード設定ID

Responses

Response samples

Content type
application/json
Example
{
  • "latest": {
    },
  • "pinned": {
    },
  • "force": {
    }
}

cardConfig

カード設定

カード設定情報一覧の取得

カード設定情報の一覧を取得する

エラーコード

エラーコード エラー内容 備考
E-CCGL-001 リクエスト不足または不正なリクエスト -
E-CCGL-002 取得時に何らかの要因でエラーが発生 -
Authorizations:
bearerAuth
query Parameters
offset
integer >= 0
Default: 0

オフセット

limit
integer
Default: 20

取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

カード設定情報の取得

カード設定情報を取得します

エラーコード

エラーコード エラー内容 備考
E-CCGD-001 カード設定情報が存在しない -
E-CCGD-002 取得時に何らかの要因でエラーが発生 -
path Parameters
card_config_id
required
string <uuid>

カード設定ID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "xxxx-xxxx-xxxxx",
  • "name": "テストカード",
  • "help_url": "https://example@test.co.jp",
  • "terms_url": "https://example@test.co.jp/images/image.png",
  • "image_name": "string",
  • "enable_value": true,
  • "enable_point": true,
  • "available_mpm": true,
  • "available_charge": true,
  • "summary": "string",
  • "description": "このカードは、 \nテストカードです\n",
  • "deleteConfirm_text": "元に戻すことはできません \n残高も無くなります\n",
  • "updated_terms_at": "2023-05-22T10:34:49Z",
  • "updated_at": "2023-05-22T10:34:49Z",
  • "created_at": "2023-05-22T10:34:49Z",
  • "notified_at": "2019-08-24T14:15:22Z"
}

card

カード情報

カード情報の一覧取得

カード情報の一覧を取得します

エラーコード

エラーコード エラー内容 備考
E-CGL-001 リクエスト不足または不正なリクエスト -
E-CGL-002 取得時に何らかの要因でエラーが発生 -
Authorizations:
bearerAuth
query Parameters
card_config_id
string <uuid>

カード設定ID

status
Array of strings
Items Enum: "registered" "unregistered" "active" "deactive"

状態

offset
integer >= 0
Default: 0

オフセット

limit
integer
Default: 20

取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

カードを登録

カードを登録して利用（選択）状態にする

エラーコード

エラーコード エラー内容 備考
E-CI-001 リクエスト不足または不正なリクエスト -
E-CI-002 カード設定情報が見つからない 存在しないor削除済みetc
E-CI-003 すでに同じカード設定のカードを所持 複数所持不可設定の場合のみ
E-CI-004 VDASPへのアクセス情報が存在しない -
E-CI-005 情報取得時に想定外のエラーが発生 -
E-CI-006 発行可能なカードが存在しない 発行カードIDの残数が0
E-CI-007 端末IDまたはアクセスキーが不正 VDASPエラー
E-CI-008 リクエスト不備 VDASPエラー
E-CI-009 存在しないカード番号またはPINが不正 VDASPエラー
E-CI-010 カードステータスが「発行前(未使用)」以外 VDASPエラー
E-CI-011 上記以外の要因のエラー VDASPエラー
E-CI-012 カード発行処理中に想定外のエラーが発生 -
Authorizations:
bearerAuth
Request Body schema: application/json
One of
card_config_id
required
string <uuid>

カード設定ID

Responses

Request samples

Content type
application/json
Example
{
  • "card_config_id": "9386630e-fb19-45e4-9a0b-aa4ae69d0172"
}

Response samples

Content type
application/json
Example
{
  • "id": "xxxx-xxxx-xxxxx",
  • "card_number": "xxxxxxxxxxxxx",
  • "status": "not_activate",
  • "expiration_at": "2023-05-22T10:34:49Z",
  • "reference_at": "2023-05-22T10:34:49Z",
  • "received_at": "2023-05-22T10:34:49Z",
  • "updated_at": "2023-05-22T10:34:49Z",
  • "created_at": "2023-05-22T10:34:49Z",
  • "card_config": {
    }
}

カード情報の取得

登録済みのカード情報を取得します

エラーコード

エラーコード エラー内容 備考
E-CGD-001 カード情報が見つからない -
E-CGD-002 取得時に何らかの要因でエラーが発生 -
Authorizations:
bearerAuth
path Parameters
card_id
required
string <uuid>

カードID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "xxxx-xxxx-xxxxx",
  • "card_number": "xxxxxxxxxxxxx",
  • "status": "not_activate",
  • "expiration_at": "2023-05-22T10:34:49Z",
  • "reference_at": "2023-05-22T10:34:49Z",
  • "received_at": "2023-05-22T10:34:49Z",
  • "updated_at": "2023-05-22T10:34:49Z",
  • "created_at": "2023-05-22T10:34:49Z",
  • "card_config": {
    }
}

カード情報の削除

登録済みカード情報を削除する

エラーコード

エラーコード エラー内容 備考
E-CD-001 リクエスト不足または不正なリクエスト -
E-CD-002 パスワード誤り -
E-CD-003 その他のCognito関連エラー -
E-CD-004 カード情報が見つからない 存在しないor削除済みorアカウントに紐付いていない
E-CD-005 カードの状態がアクティベート状態以外 -
E-CD-006 VDASPへのアクセス情報が存在しない -
E-CD-007 情報取得時に想定外のエラーが発生 -
E-CD-008 端末IDまたはアクセスキーが不正 VDASPエラー
E-CD-009 リクエスト不備 VDASPエラー
E-CD-010 存在しないカード番号またはPINが不正 VDASPエラー
E-CD-011 上記以外の要因の場合 VDASPエラー
E-CD-012 カード削除処理中に想定外のエラー -
Authorizations:
bearerAuth
path Parameters
card_id
required
string <uuid>

カードID

Request Body schema: application/json
password
required
string <password> (password)

パスワード

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "title": "エラー",
  • "code": "E-XXX",
  • "message": "処理エラー"
}

カード残高取得

カードの残高を取得します

エラーコード

エラーコード エラー内容 備考
E-CB-001 企業情報および企業に紐づくAPIエンドポイントが存在しない 取得にカードIDを利用している為、その存在有無の可能性もある
E-CB-002 端末IDまたはアクセスキーが不正 VDASPエラー
E-CB-003 リクエスト不備 VDASPエラー
E-CB-004 存在しないカード番号またはPINが不正 VDASPエラー
E-CB-005 カードステータスが「発行前(未使用)」 VDASPエラー
E-CB-006 上記以外の要因のエラー VDASPエラー
E-CB-007 情報取得時に想定外のエラーが発生 -
Authorizations:
bearerAuth
path Parameters
card_id
required
string <uuid>

カードID

Responses

Response samples

Content type
application/json
Example
{
  • "balance_basic": 0,
  • "balance_point": 0,
  • "balance_bonus": 0,
  • "balance_coupon": 0,
  • "expire_date_basic": "2019-08-24T14:15:22Z",
  • "expire_date_point": "2019-08-24T14:15:22Z",
  • "expire_date_bonus": "2019-08-24T14:15:22Z",
  • "expire_date_coupon": "2019-08-24T14:15:22Z"
}

カード利用履歴一覧取得

カード利用履歴一覧を取得します

エラーコード

エラーコード エラー内容 備考
E-CH-001 リクエスト不足または不正なリクエスト -
E-CH-002 企業情報および企業に紐づくAPIエンドポイントが存在しない 取得にカードIDを利用している為、その存在有無の可能性もある
E-CH-003 端末IDまたはアクセスキーが不正 VDASPエラー
E-CH-004 上記以外の要因のエラー VDASPエラー
E-CH-005 情報取得時に想定外のエラーが発生 -
Authorizations:
bearerAuth
path Parameters
card_id
required
string <uuid>

カードID

query Parameters
date
string

年月（yyyy-mm-01）

offset
integer >= 0
Default: 0

オフセット

limit
integer
Default: 20

取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

カードIDトークン取得

トークン化したカードIDを取得します

エラーコード

エラーコード エラー内容 備考
Authorizations:
bearerAuth
path Parameters
card_id
required
string <uuid>

カードID

query Parameters
payment_method
required
string (PaymentMethod)
Enum: "prepaid" "direct"

決済方法

決済方法 string
プリペイド決済 prepaid
ダイレクト決済 direct

Responses

Response samples

Content type
application/json
Example
{
  • "token": "string",
  • "expiration_at": "2023-05-22T10:34:49Z"
}

shop

店舗

店舗情報一覧の取得

店舗情報の一覧を取得する

エラーコード

エラーコード エラー内容 備考
E-SL-001 リクエスト不足または不正なリクエスト -
E-SL-002 情報取得時に想定外のエラー -
E-SL-003 カード設定情報が見つからない -
Authorizations:
bearerAuth
query Parameters
card_config_id
required
string <uuid>

カード設定ID

offset
integer >= 0
Default: 0

オフセット

limit
integer
Default: 20

取得件数

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

payment

決済

支払トランザクショントークンの取得

支払トランザクショントークンを取得します

エラーコード

エラーコード エラー内容 備考
E-MIT-001 リクエスト不足または不正なリクエスト -
E-MIT-002 MPM QRコード情報が存在しない -
E-MIT-003 MPM QRコードに紐づく決済可能方式が存在しない -
E-MIT-004 カード情報が存在しない 紐づいていない場合も表示
E-MIT-005 カード状態がアクティベートでない -
E-MIT-006 対象店舗ではこのカードは利用できない -
E-MIT-007 VDASPへのアクセス情報が存在しない -
E-MIT-008 上記の情報群の取得中に想定外のエラー -
E-MIT-009 ワンタイムトークン作成に失敗 -
E-MIT-010 トークン作成時に想定外のエラー -
Authorizations:
bearerAuth
Request Body schema: application/json
card_id
required
string <uuid> (cardId)

カード情報ID

mpm_code
required
string <uuid> (mpmCode)

mpm支払コード

request_code
string <uuid> (requestCode)

要求コード 指定する事で支払トランザクショントークンの重複生成の制御が可能

Responses

Request samples

Content type
application/json
{
  • "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304",
  • "mpm_code": "57644e62-e941-458a-9503-9a60b401f446",
  • "request_code": "845db423-f084-4fdb-a042-281b08631293"
}

Response samples

Content type
application/json
Example
{
  • "token": "b5507016-7da2-4777-a161-1e8042a6a377",
  • "card_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01304",
  • "shop_id": "89e430df-96ce-4ad0-b869-a7ba3bbdf710",
  • "amount": {
    },
  • "available_payment_methods": [
    ],
  • "result_code": "string",
  • "terminated_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

支払の確定

支払の確定

エラーコード

エラーコード エラー内容 備考
E-PE-001 リクエスト不足または不正なリクエスト -
E-PE-002 支払い用トランザクショントークンが存在しない or 期限切れ -
E-PE-003 トークンを作成したアカウントと決済実行したアカウントが違う -
E-PE-004 支払い可能最低金額よりも支払い額が小さい -
E-PE-005 支払い可能最高金額よりも支払い額が大きい -
E-PE-006 トークン解析時に想定外のエラー -
E-PE-007 支払いに利用するカード情報が見つからない -
E-PE-008 情報取得または取引履歴ステータス更新時に想定外のエラー -
E-PE-009 アクセスキーまたは端末IDが不正 VDASPエラー
E-PE-010 引数が不正 VDASPエラー
E-PE-011 存在しないカード番号またはPINが不正 VDASPエラー
E-PE-012 上記以外の要因の場合 VDASPエラー
E-PE-013 決済に失敗したが、要求取消は成功 -
E-PE-014 決済に失敗し、かつ要求取消がタイムアウト 障害の可能性あり
E-PE-015 決済に失敗し、かつ要求取消も失敗 障害の可能性あり
E-PE-016 事前に作成したはずのinitial状態の取引履歴情報が存在しない -
E-PE-017 取引履歴情報の取得時に想定外のエラー -
E-PE-018 カードが利用できない状態 VDASPエラー
E-PE-019 残高が不足 VDASPエラー
E-PE-020 カードステータスが「未使用」 VDASPエラー
Authorizations:
bearerAuth
path Parameters
payment_token
required
string <uuid>

決済トランザクショントークン

Request Body schema: application/json
amount
required
integer (amount)

支払金額

Array of objects (PaymentComposition)

支払内訳

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "composition": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "balance_basic": 0,
  • "balance_point": 0,
  • "balance_bonus": 0,
  • "balance_coupon": 0,
  • "expire_date_basic": "2019-08-24T14:15:22Z",
  • "expire_date_point": "2019-08-24T14:15:22Z",
  • "expire_date_bonus": "2019-08-24T14:15:22Z",
  • "expire_date_coupon": "2019-08-24T14:15:22Z",
  • "result_code": 0,
  • "error_message": "string",
  • "seq_no": "string",
  • "deal_no": "string",
  • "receipt_no": "string",
  • "balance_total": 0,
  • "value_deposit": 0,
  • "value_withdraw": 0,
  • "value_send_back": 0,
  • "value_deposit_cancel": 0,
  • "value_withdraw_cancel": 0,
  • "value_deposit_max": 0,
  • "bonus_withdraw": 0,
  • "bonus_given": 0,
  • "coupon_withdraw": 0,
  • "point_given": 0,
  • "point_deposit_max": 0,
  • "point_withdraw": 0
}

MPM Codeコード情報取得

MPM Codeコードに紐づけられたカード設定、及び店舗情報取得

エラーコード

エラーコード エラー内容 備考
E-MCG-001 MPMコード情報が見つからない -
E-MCG-002 MPMコード情報取得時に想定外のエラー -
path Parameters
mpm_code
required
string <uuid>

mpm支払コード

Responses

Response samples

Content type
application/json
Example
{
  • "mpm_code": "57644e62-e941-458a-9503-9a60b401f446",
  • "shop": {
    },
  • "card_configs": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}