GMO にカードを登録する API です。このカードは決済を行うカードを登録します。
使わないカード情報は削除をして有効なカードのみ登録されている状態にします。
支払方法登録画面で本 API は利用します。
また自動でカードの有効性チェックが行われます。
| メソッド | URI | Headers |
|---|---|---|
{GmoApiUrl}/SaveCard |
Default |
| パラメーター名 | 必須 | 型 | 桁 | 項目名 | 特記 |
|---|---|---|---|---|---|
| version | CHAR | 3 | バージョン | パラメータバージョン(予約項目のため、省略してください。) | |
| siteID | 〇 | CHAR | 13 | サイト ID | 弊社が発行する値を設定します。 |
| sitePass | 〇 | CHAR | 10 | サイトパスワード | 弊社が発行する値を設定します。 |
| memberID | 〇 | CHAR | 60 | 会員 ID | カードを登録する対象の会員 ID を設定します。|本システムでは監理団体の GmoID |
| cardName | CHAR | 10 | カード会社略称 | 登録するカードのカード会社等を設定します。(ENUM の名称を保存) | |
| token | △ | CHAR | 64 | トークン | カード番号トークン化サービス |
※トークンは「カードトークン取得 API」を確認してください
{
"siteID" :"tsite99887902",
"sitePass":"7rab53fqm",
"memberID":"member01",
"token" :"Lg9sRgo5nx6yfefJ51z8bj/1VdNFAaCZYWZ+qLKJyqWwBS7yYvxSiC0zeMVH+O4F"
}
ステータスコード:200
| パラメーター名 | 型 | 桁 | 項目名 | 特記 |
|---|---|---|---|---|
| memberID | CHAR | 60 | 会員 ID | 登録された会員の ID を返却します。 |
| CardSeq | CHAR | 4 | カード登録連番 | 登録が完了したカード番号の値を返却します。同一カードでも、モードにより返却内容が異なります。 |
| CardNo | CHAR | 16 | カード番号 | 登録したカード番号を返却します。 設定していない場合下 4 桁以外マスクされた値を返却します。 |
| Forward | CHAR | 7 | 仕向先コード | 有効性チェックを行った際に仕向けたカード会社のコードを返却します。 |
| カード属性照会 API が利用可能な場合は、以下の情報も出力します。(※) | ||||
| Brand | CHAR | 16 | 国際ブランド | 国際ブランド名(VISA, MASTER, JCB, AMEX,DINERS)を返します。※判別不能時は空文字を返します。 |
| DomesticFlag | CHAR | 1 | 国内発行フラグ | 1:国内発行カード 0:海外発行カード 2:不明(上記以外) |
| IssuerCode | CHAR | 7 | イシュアコード | イシュアコードを返します。※イシュアを特定できた場合のみ返却。 |
| DebitPrepaidFlag | CHAR | 1 | デビット/プリペイドフラグ | 2:プリペイドカード 1:デビットカード 0:上記以外 |
| DebitPrepaidIssuerName | CHAR | 75 | デビット/プリペイドカード発行会社名 | デビット(DebitPrepaidFlag =1)もしくはプリペイド(DebitPrepaidFlag =2)の場合のみ返却。 |
| ForwardFinal | CHAR | 7 | 最終仕向先のカード会社コード | 最終仕向先のカード会社のコードを返します |
※カード属性照会 API は、GMO が保有する情報を元に出力します。
※カード属性照会 API を、利用できるのか問い合わせ中(20211101)
{
"cardSeq" :"1456",
"cardNo" :"************9999",
"forward" :"2SF37F6",
"brand" :"VISA",
"domesticFlag" :"0",
"issuerCode" :"2SFBAF6",
"debitPrepaidFlag" :"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal" :"2SF37F6",
}
ステータスコード:不明
| パラメーター名 | 型 | 桁 | 項目名 | 特記 |
|---|---|---|---|---|
| ErrCode | CHAR | 3 | エラーコード | エラー発生時のみ 複数ある場合は"|"で接続された文字列 |
| ErrInfo | CHAR | 9 | エラー詳細コード | エラー発生時のみ 複数ある場合は"|"で接続された文字列 |
・エラー時(複数エラーがある場合は下記のような形式にて出力されます。ErrCode の n 番目と ErrInfo の n 番目は対となります)
[
{
"errCode":"E01",
"errInfo":"E01010001"
},
{
"errCode":"E01",
"errInfo":"E01020001"
},
]