クレカ情報追加
OpenAPI説明
当該OpenAPIはクレカ情報を新規追加する際に利用します。
OpenAPI権限
当該OpenAPIはテナント権限が必要です。
リクエストURI
/api/openapi/users/credit-cards
リクエスト形式
POST
リクエスト例
{
"employeeId": "EMP-001",
"creditCardUserId": "xxx123456",
"creditCardCompanyCode": "JC",
"userCompanyCode": "TIS",
"isEnabled": true
}
リクエスト項目
項目名 | タイプ | 必須 | キー | 規則 | 説明 |
---|---|---|---|---|---|
employeeId | String | 〇 | 〇 | 最大32文字 | 従業員番号 |
creditCardUserId | String | 〇 | 〇 | 最大20文字 | クレカユーザID |
creditCardCompanyCode | String | 〇 | 〇 | 固定2文字 | クレカ会社コード MS:三井住友カード JC:JCB DI:三井住友トラフトクラブ(ダイナース) AM:AMEX NI:三菱UFJニコス CS:クレディセゾン TF:トヨタファイナンス UC:UCカード HC:三菱HCキャピタル |
userCompanyCode | String | 〇 | 〇 | 最大36文字 | 従業員の会社コード |
isEnabled | Boolean | デフォルト:true | ステータス true:有効 false:無効 |
OpenAPIリターン例
成功例
{
"message": "success",
"key": "xxx123456"
}
失敗例
{
"message": "クレカユーザIDは既に存在します:xxx123456",
"errorCode": "xxxxx"
}
項目説明
項目名 | タイプ | 説明 |
---|---|---|
message | String | メッセージを返す |
key | String | クレカユーザID |
errorCode | String | エラーコードを返す |
エラーコード説明
errorCode | message | 説明 |
---|---|---|
0013 | パラメータ:{0}は{1}文字以内で指定してください | |
120003 | パラメータ:{0}は指定必須の項目です | |
120016 | パラメータ:{0}は{1}文字で指定してください | |
1202071 | 従業員番号は存在しません:{0} | |
6047055 | 無効な会社コードです。 | |
CREDIT_CARD_005 | クレカ会社コードは存在しません:{0} | |
CREDIT_CARD_006 | クレカユーザIDは既に存在します:{0} | |
CREDIT_CARD_008 | 会社はクレジットカードのサービスが開通されていません:{0} | |
120001 | テナントの権限がありません | |
THIRD_PARTY_APPLICATION_004 | 認識できないクライアントマークまたはクライアントには権限がない |