クレジットカード決済 API一覧
HTTP仕様(.idPass)
HTTP仕様(.json)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
EntryTran 取引登録
決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID加盟店様が取引を識別するための値 |
||
JobCd | jobCd | 必須
処理区分
|
||
ItemCode | itemCode | 半角数字7桁 固定
商品コード
カード会社との間の契約で使用する商品コードが決められた場合のみ設定 |
||
Amount | amount | 必須 半角数字7桁
利用金額処理区分が『有効性チェック』の場合は設定不要 |
||
Tax | tax | 半角数字7桁
税送料
利用金額+税送料で1円~9,999,999円設定可能 |
/payment/EntryTran.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"orderID":"ORDER0000001",
"jobCd":"AUTH",
"amount":"1000"
}
/payment/EntryTran.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000
レスポンス
{
"accessID"="a6a6b0061347e90cdef806b39bd28705",
"accessPass"="5e0e54b892e14ed03e8cf807a6053813"
}
AccessID=acdc7d53f7a78f488d8d0997eff99c6f&AccessPass=8edc86b5c8b34e92a224f577dec63990
[
{
"errCode":"M01",
"errInfo":"M01470008"
}
]
ErrCode=E01&ErrInfo=E01040001
ExecTran 決済実行
カード会社と通信を行い決済をします。
利用する決済方法を選択し、共通パラメータに加えて、必要なパラメータを設定してください。
他決済方法のパラメータを指定した場合、想定外の決済方法で処理されることがございますのでご注意ください。
-
トークンを利用して決済する場合
トークン発行後、呼び出してください。
-
会員ID決済する場合
会員ID/カード登録後、呼び出してください。
-
カード番号を利用して決済する場合
カード番号の取り扱いが許可された加盟店様のみ利用可能です。トークンとカード番号・有効期限・セキュリティコード・名義人を併せて指定するとトークンが優先されます。
カード番号の取り扱いが許可されていない加盟店様については、パラメータを指定した場合はE61040001エラーが発生します。
リクエスト
AccessID | accessID |
必須
半角英数32桁 固定
取引ID【取引登録】で発行された値を設定します。 |
||
---|---|---|---|---|
AccessPass | accessPass |
必須
半角英数32桁 固定
取引パスワード【取引登録】で発行された値を設定します。 |
||
OrderID | orderID |
必須
半角英数記号27桁
オーダーID【取引登録】で指定した値を設定します。 |
||
Method | method |
必須
支払方法
処理区分が「有効性チェック」の場合は設定不要 |
||
PayTimes | payTimes |
半角数字2桁
支払回数支払方法が「分割」の場合は必須 |
||
PIN | pin |
半角数字4桁
暗証番号クレジットカードの暗証番号 |
||
ClientField1 | clientField1 |
全半角100バイト
加盟店自由項目1 |
||
ClientField2 | clientField2 |
全半角100バイト
加盟店自由項目2 |
||
ClientField3 | clientField3 |
全半角100バイト
加盟店自由項目3 |
||
ClientFieldFlag | clientFieldFlag |
加盟店自由項目返却フラグ
|
トークンを使用する場合
各パラメータはトークン利用のみ設定してください。
TokenType | tokenType |
トークンタイプカード情報トークンタイプ
|
||
---|---|---|---|---|
Token | token |
必須
半角英数64桁
トークントークンタイプ「1」の場合 トークンタイプ「2」の場合 |
会員IDを使用する場合
下記パラメータは会員ID利用のみ設定してください。
SiteID | siteID |
必須
半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass |
必須
半角英数10桁
サイトパスワード |
||
MemberID | memberID |
必須
半角英数記号60桁
会員ID |
||
SeqMode | seqMode |
カード登録連番モード
|
||
CardSeq | cardSeq |
必須
半角数字4桁
カード登録連番 |
||
CardPass | cardPass |
半角英数20桁
カードパスワードカード登録時に設定したパスワード |
||
SecurityCode | securityCode |
半角数字4桁
セキュリティーコードカードに記載されている3桁もしくは4桁の数字 |
カード番号を使用する場合
下記パラメータはカード番号利用のみ設定してください。
CardNo | cardNo |
必須
半角数字16桁
クレジットカード番号 |
||
---|---|---|---|---|
Expire | expire |
必須
半角数字4桁 固定
有効期限クレジットカードの有効期限 |
||
HolderName | holderName |
半角英数記号50桁
名義人クレジットカードの名義 |
||
SecurityCode | securityCode |
半角数字4桁
セキュリティコードカードに記載されている3桁もしくは4桁の数字 |
/payment/ExecTran.json
{
"accessID":"8867bfeec7b7fc35f78320d01c9a6c10",
"accessPass":"c07822acefba90d95417ae37beb198de",
"orderID":"TEST-20190628-133057",
"method":"1",
"token":"Lg9sRgo5nx6yfefJ51z8bj/1VdNFAaCZYWZ+qLKJyqWwBS7yYvxSiC0zeMVH+O4F"
}
{
"accessID":"8867bfeec7b7fc35f78320d01c9a6c10",
"accessPass":"c07822acefba90d95417ae37beb198de",
"orderID":"TEST-20190628-133057",
"siteID":"tsite99887814",
"method":"1",
"sitePass":"PASSWORD",
"memberID":"Member00",
"cardSeq":"1",
"cardPass":"PassWord"
}
{
"accessID":"8867bfeec7b7fc35f78320d01c9a6c10",
"accessPass":"c07822acefba90d95417ae37beb198de",
"orderID":"TEST-20190628-133057",
"method":"1",
"cardNo":"4111111111111111",
"expire":"2512"
}
/payment/ExecTran.idPass
AccessID=8867bfeec7b7fc35f78320d01c9a6c10&AccessPass=c07822acefba90d95417ae37beb198de&OrderID=TEST-20190628-133057&Method=1&Token=Lg9sRgo5nx6yfefJ51z8bj/1VdNFAaCZYWZ+qLKJyqWwBS7yYvxSiC0zeMVH+O4F
AccessID=8867bfeec7b7fc35f78320d01c9a6c10&AccessPass=c07822acefba90d95417ae37beb198de&OrderID=TEST-20190628-133057&Method=1&SiteID=tsite99887814&SitePass=PASSWORD&MemberID=Member00&CardSeq=1&CardPass=PassWord
AccessID=8867bfeec7b7fc35f78320d01c9a6c10&AccessPass=c07822acefba90d95417ae37beb198de&OrderID=TEST-20190628-133057&Method=1&CardNo=4111111111111111&Expire=2512
レスポンス
正常
ACS | acs |
ACS呼出判定
|
||
---|---|---|---|---|
OrderID | orderID |
半角英数記号27桁
オーダーID【取引登録】で指定した値 |
||
Forward | forward |
半角英数記号7桁
仕向先コード |
||
Method | method |
半角数字1桁
支払方法 |
||
PayTimes | payTimes |
半角数字2桁
支払回数 |
||
Approve | approve |
半角英数7桁
承認番号 |
||
TranID | tranID |
半角数字28桁
トランザクションID |
||
TranDate | tranDate |
半角数字14桁
決済日付 |
||
CheckString | checkString |
半角英数32桁
MD5ハッシュ出力パラメータのオーダーID、仕向け先コード、支払い方法、支払い回数、承認番号、トランザクションID、決済日付+ショップパスワードのハッシュ値を返却します。 |
||
ClientField1 | clientField1 |
全半角100バイト
加盟店自由項目1 |
||
ClientField2 | clientField2 |
全半角100バイト
加盟店自由項目2 |
||
ClientField3 | clientField3 |
全半角100バイト
加盟店自由項目3 |
{
"acs":"0",
"orderID":"TEST-20190628-115812",
"forward":"2b55195",
"method":"1",
"payTimes":"3",
"approve":"1234567",
"tranID":"1917900745",
"tranDate":"20190628120831",
"checkString":"6bff1f1547394b9fc37407dfc0d49c31",
}
[
{
"errCode":"M01",
"errInfo":"M01470008"
}
]
ACS=0&OrderID=TEST-20190628-115812&Forward=2b55195&Method=1&PayTimes=3&Approve=1234567&TranID=1917900745&TranDate=20190628120831&CheckString=6bff1f1547394b9fc37407dfc0d49c31
ErrCode=M01&ErrInfo=M01470008
AlterTran 決済変更
決済が完了した取引の決済内容を変更します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID |
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード |
||
JobCd | jobCd | 必須
処理区分
|
||
Amount | amount | 必須 半角数字7桁
利用金額処理区分が「キャンセル」の場合は設定不要 |
||
Tax | tax | 半角数字7桁
税送料
利用金額+税送料で1円~9,999,999円設定可能 |
||
Method | method |
支払方法処理区分が「仮売上」「即時売上」の場合は必須
|
||
PayTimes | payTimes |
半角数字2桁
支払回数支払方法が「分割」の場合は必須 |
/payment/AlterTran.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"accessID":"4cfffa3f3ef6e90692dbc204e09b351b",
"accessPass":"c07822acefba90d95417ae37beb198de",
"jobCd":"AUTH",
"amount":"1000"
}
/payment/AlterTran.idPass
ShopID=tshop99887902&ShopPass=PASSWORD&AccessID=4cfffa3f3ef6e90692dbc204e09b351b&AccessPass=c07822acefba90d95417ae37beb198de&JobCd=AUTH&Amount=1000
レスポンス
正常
AccessID | accessID | 半角英数32桁 固定
取引ID |
||
---|---|---|---|---|
AccessPass | accessPass | 半角英数32桁 固定
取引パスワード |
||
Forward | forward | 半角英数7桁
仕向先コード |
||
Approve | approve | 半角英数7桁
承認番号 |
||
TranID | tranID | 半角数字28桁
トランザクションID |
||
TranDate | tranDate | 半角数字14桁 固定
決済日付 |
{
"accessID":"4cfffa3f3ef6e90692dbc204e09b351b",
"accessPass":"c07822acefba90d95417ae37beb198de",
"forward":"2b55195",
"approve":"1234567",
"tranID":"1917900745",
"tranDate":"20190628120831"
}
AccessID=b4e08d3cd75df2755d32b783e40bf13b&AccessPass=c07822acefba90d95417ae37beb198de&Forward=2b55195&Approve=1234567&TranID=1917900745&TranDate=20190628120831
[
{
"errCode":"M01",
"errInfo":"M01470008"
}
]
ErrCode=E01&ErrInfo=E01040001
ChangeTran 金額変更
決済が完了した取引に対して決済金額の変更を行います。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID加盟店様が取引を識別するための値 |
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード加盟店様が取引を識別するための値 |
||
JobCd | jobCd | 必須
処理区分
|
||
Amount | amount | 必須 半角数字7桁
利用金額 |
||
Tax | tax | 半角数字7桁
税送料
利用金額+税送料で1円~9,999,999円設定可能 |
/payment/ChangeTran.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"accessID":"4cfffa3f3ef6e90692dbc204e09b351b",
"accessPass":"c07822acefba90d95417ae37beb198de",
"jobCd":"AUTH",
"amount":"1000"
}
/payment/ChangeTran.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=4cfffa3f3ef6e90692dbc204e09b351b&AccessPass=c07822acefba90d95417ae37beb198de&JobCd=AUTH&Amount=1000
レスポンス
正常
AccessID | accessID | 半角英数32桁 固定
取引ID |
||
---|---|---|---|---|
AccessPass | accessPass | 半角英数32桁 固定
取引パスワード |
||
Forward | forward | 半角英数7桁
仕向先コード |
||
Approve | approve | 半角英数7桁
承認番号 |
||
TranID | tranID | 半角英数28桁
トランザクションID |
||
TranDate | tranDate | 半角数字14桁 固定
決済日付 |
{
"accessID":"a6a6b0061347e90cdef806b39bd28705",
"accessPass":"5e0e54b892e14ed03e8cf807a6053813",
"forward":"2b55195",
"approve":"1234567",
"tranID":"1917900745",
"tranDate":"20190628120831"
}
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Forward=2b55195&Approve=1234567&TranID=1917900745&TranDate=20190628120831
[
{
"errCode":"M01",
"errInfo":"M01470008"
}
]
ErrCode=E01&ErrInfo=E01040001
SearchTrade 取引状態参照
指定したオーダーIDの取引情報を取得します。
通信障害でタイムアウトが発生する等の状況で決済結果が取得できなかった場合は、本インタフェースにて取得してください。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID加盟店様が取引を識別するための値 |
||
UseSiteMaskLevel | useSiteMaskLevel |
サイト設定のマスクレベル利用有無
|
||
UseFloatingMask | useFloatingMask |
可変マスク利用有無
|
/payment/SearchTrade.json
{
"shopID":"tshop11223344",
"shopPass":"PASSWORD",
"orderID":"ORDER0000001",
"useSiteMaskLevel":"0"
}
/payment/SearchTrade.idPass
ShopID=tshop99887902&ShopPass=PASSWORD&OrderID=TEST-20190628-115812&UseSiteMaskLevel=0
レスポンス
正常
OrderID | orderID | 半角英数27桁
オーダーID |
||
---|---|---|---|---|
Status | status | 半角英字15桁
現状態 |
||
ProcessDate | processDate | 半角数字14桁 固定
処理日時 |
||
JobCd | jobCd | 半角英字10桁
処理区分 |
||
AccessID | accessID | 半角英数32桁 固定
取引ID |
||
AccessPass | accessPass | 半角英数32桁 固定
取引パスワード |
||
ItemCode | itemCode | 半角英数7桁
商品コード |
||
Amount | amount | 半角数字7桁
利用金額 |
||
Tax | tax | 半角数字7桁
税送料 |
||
SiteID | siteID | 半角英数13桁
サイトID |
||
MemberID | memberID | 半角英数60桁
会員ID |
||
CardNo | cardNo | 半角数字16桁
カード番号 |
||
Expire | expire | 半角数字4桁
有効期限 |
||
Method | method | 半角数字1桁
支払方法 |
||
PayTimes | payTimes | 半角数字2桁
支払回数 |
||
Forward | forward | 半角英数7桁
仕向先コード |
||
TranID | tranID | 半角英数28桁
トランザクションID |
||
Approve | approve | 半角英数7桁
承認番号 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1 |
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2 |
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3 |
{
"orderID":"2019062701",
"status":"AUTH",
"processDate":"20190213200436",
"jobCd":"AUTH",
"accessID":"67ed6da3551771c9f592cd6f7a19a90c",
"accessPass":"0695cc5eb676f9e11ab6e432f3747941",
"itemCode":"abc1234",
"amount":"10000",
"tax":"1000",
"siteID":"",
"memberID":"",
"cardNo":"************9999",
"expire":"2203",
"method":"1",
"payTimes":"",
"forward":"2SF37F6",
"tranID":"1917900745",
"approve":"123456a",
"clientField1":"",
"clientField2":"",
"clientField3":""
}
OrderID=2019062701&Status=AUTH&ProcessDate=20190213200436&JobCd=AUTH&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&ItemCode=abc1234&Amount=10000&Tax=1000&SiteID=&MemberID=&CardNo=************9999&Expire=2203&Method=1&PayTimes=&Forward=2SF37F6&TranID=1917900745&Approve=123456a&ClientField1=&ClientField2=&ClientField3=
[
{
"errCode":"M01",
"errInfo":"M01470008"
}
]
ErrCode=E01&ErrInfo=E01040001