API docs by Redocly

VeriTrans4G API接続ガイド (1.3.1)

Download OpenAPI specification:

License: サイト利用条件

本ガイドの内容

本ガイドは、株式会社DGフィナンシャルテクノロジーが提供するVeriTrans4G 接続 API(以下、接続 API)を利用し、

インターネット店舗等で株式会社DGフィナンシャルテクノロジーが公開しているサービスを導入する開発者向けのガイドです。

開発の際の必要となる接続 API のインターフェース仕様、電文フォーマットなどについて記載しています。

本ガイドには接続 API に関連する部分のみが記述されておりますので、

【VeriTrans4G 開発ガイド】、【VeriTrans4G インターフェース詳細】も合わせてご参照ください。

APIの利用方法

認証

APIの認証にはJSON 内のauthHashを使用します。

authHashは、マーチャントCCID、リクエスト内のParams要素の文字列、マーチャント認証鍵を連結した文字列から SHA256ハッシュを生成し設定します

authHashを生成する際のParams要素は最小化(minify)する必要があります。

以下にハッシュ生成の手順のサンプルを示します。

PowerShell

# マーチャントCCID
$merchantCcid = "A100000000000000000000cc"

# マーチャント認証鍵
$merchantKey  = "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"

# リクエストJSON
$json = '
{
  "params": {
    "orderId":"dummy1503015213",
    "amount":"5",
    "jpo":"10",
    "withCapture":"false",
    "payNowIdParam":{
      "token":"0a812412-682c-4dad-8a5d-720caf23bca0"
    },
  "txnVersion":"2.0.0",
  "dummyRequest":"1",
  "merchantCcid":"A100000000000000000000cc"
  },
  "authHash": ""
}' | ConvertFrom-Json

# リクエストからparams要素を取り出し最小化(minify)
$minifyParams = ConvertTo-Json -InputObject $json.params -Depth 10 -Compress

# マーチャントCCID、最小化したparams要素、マーチャント認証鍵を連結した文字列を作成
$joinedStraing = $merchantCcid + $minifyParams + $merchantKey

# SHA256ハッシュを生成
$bytes = [System.Text.Encoding]::UTF8.GetBytes($joinedStraing)
$hash = [System.Security.Cryptography.SHA256]::Create().ComputeHash($bytes)
$authHash = ([BitConverter]::ToString($hash)).Replace("-", "").ToLower()


# リクエストJSONにauthHashを追加
$json.authHash = $authHash

Write-Output $json | ConvertTo-Json -Depth 10
{
     "params":  {
                    "orderId":  "dummy1503015213",
                    "amount":  "5",
                    "jpo":  "10",
                    "withCapture":  "false",
                    "payNowIdParam":  {
                                          "token":  "0a812412-682c-4dad-8a5d-720caf23bca0"
                                      },
                    "txnVersion":  "2.0.0",
                    "dummyRequest":  "1",
                    "merchantCcid":  "A100000000000000000000cc"
                },
     "authHash":  "d1080ba284de0a71cabfe0079ba95f46d78e610c00a6f16ff642bf2bcce1f2fe"
 }

シェルスクリプト

# マーチャントCCID
merchantCcid="A100000000000000000000cc"

# マーチャント認証鍵
merchantKey="abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"

# リクエストJSON
json='
{
  "params": {
    "orderId":"dummy1503015213",
    "amount":"5",
    "jpo":"10",
    "withCapture":"false",
    "payNowIdParam":{
      "token":"0a812412-682c-4dad-8a5d-720caf23bca0"
    },
  "txnVersion":"2.0.0",
  "dummyRequest":"1",
  "merchantCcid":"A100000000000000000000cc"
  },
  "authHash": ""
}'
    
# リクエストからparams要素を取り出し最小化(minify)
minifyParams=$(echo "$json" | jq -c '.params')
    
# マーチャントCCID、最小化したparams要素、マーチャント認証鍵を連結した文字列を作成
joinedString="${merchantCcid}${minifyParams}${merchantKey}"
    
# SHA256ハッシュを生成
authHash=$(echo -n "$joinedString" | sha256sum | cut -d " " -f 1)
    
# リクエストJSONにauthHashを追加
updatedJson=$(echo "$json" | jq --arg authHash "$authHash" '.authHash = $authHash')
    
echo "$updatedJson" | jq .
{
  "params": {
    "orderId": "dummy1503015213",
    "amount": "5",
    "jpo": "10",
    "withCapture": "false",
    "payNowIdParam": {
      "token": "0a812412-682c-4dad-8a5d-720caf23bca0"
    },
    "txnVersion": "2.0.0",
    "dummyRequest": "1",
    "merchantCcid": "A100000000000000000000cc"
  },
  "authHash": "d1080ba284de0a71cabfe0079ba95f46d78e610c00a6f16ff642bf2bcce1f2fe"
}

リクエスト(JSON)のエンコード

APIのリクエスト(JSON)はURLエンコードを行い送信する必要があります。

以下にリクエストのURLエンコード手順のサンプルを示します。

PowerShell

# リクエストURL
$uri = 'https://api3.veritrans.co.jp:443/test-paynow/v2/Authorize/card'

# リクエストJSON
$json = '
{
  "params": {
    "orderId":"dummy1503015213",
    "amount":"5",
    "jpo":"10",
    "withCapture":"false",
    "payNowIdParam":{
      "token":"0a812412-682c-4dad-8a5d-720caf23bca0"
    },
  "txnVersion":"2.0.0",
  "dummyRequest":"1",
  "merchantCcid":"A100000000000000000000cc"
  },
  "authHash": "d1080ba284de0a71cabfe0079ba95f46d78e610c00a6f16ff642bf2bcce1f2fe"
}' | ConvertFrom-Json

# JSONの最小化(minify)
$minifyJson = ConvertTo-Json -InputObject $json -Depth 10 -Compress

# URLエンコード
$encodedJson = [System.Net.WebUtility]::UrlEncode($minifyJson)

# URLエンコード結果確認
Write-Output $encodedJson

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$response = Invoke-RestMethod -Uri $uri -Method POST -Body $encodedJson -ContentType "application/json"

# 結果の確認
Write-Output $response | ConvertTo-Json -Depth 10
{
    "result":  {
                   "vResultCode":  "A001000000000000",
                   "custTxn":  "12345678",
                   "acquirerCode":  "05",
                   "cardTransactiontype":  "a",
                   "centerRequestDate":  "20230921135249",
                   "centerResponseDate":  "20230921135249",
                   "connectedCenterId":  "jcn",
                   "gatewayRequestDate":  "20230921135249",
                   "gatewayResponseDate":  "20230921135249",
                   "loopback":  "0",
                   "pending":  "0",
                   "reqAcquirerCode":  "05",
                   "reqAmount":  "5",
                   "reqCardExpire":  "*****",
                   "reqCardNumber":  "411111********11",
                   "reqItemCode":  "0990",
                   "reqJpoInformation":  "10",
                   "reqSecurityCode":  "0000",
                   "reqWithCapture":  "false",
                   "resActionCode":  "000",
                   "resAuthCode":  "000000",
                   "resCenterErrorCode":  "   ",
                   "resReturnReferenceNumber":  "012345678901",
                   "marchTxn":  "12345678",
                   "merrMsg":  "処理が成功しました。",
                   "mstatus":  "success",
                   "optionResults":  [
                                     ],
                   "orderId":  "dummy1503015213",
                   "serviceType":  "card",
                   "txnVersion":  "2.0.0"
               }
}

シェルスクリプト

# リクエストURL
uri='https://api3.veritrans.co.jp:443/test-paynow/v2/Authorize/card'

# リクエストJSON
json='
{
  "params": {
    "orderId":"dummy1503015213",
    "amount":"5",
    "jpo":"10",
    "withCapture":"false",
    "payNowIdParam":{
      "token":"0a812412-682c-4dad-8a5d-720caf23bca0"
    },
    "txnVersion":"2.0.0",
    "dummyRequest":"1",
    "merchantCcid":"A100000000000000000000cc"
  },
  "authHash": "d1080ba284de0a71cabfe0079ba95f46d78e610c00a6f16ff642bf2bcce1f2fe"
}'
    
# JSONの最小化(minify) と URLエンコード
encodedJson=$(echo -n "$json" | jq -c @uri | tr -d '"')
    
# URLエンコード結果確認
echo $encodedJson
    
# cURLを使用してAPIリクエストを送信
response=$(curl -X POST -H "Content-Type: application/json" --data "$encodedJson" "$uri")
    
# 結果の確認
echo $response | jq .
{
  "result": {
    "vResultCode": "A001000000000000",
    "custTxn": "12345678",
    "acquirerCode": "05",
    "cardTransactiontype": "a",
    "centerRequestDate": "20230921135249",
    "centerResponseDate": "20230921135249",
    "connectedCenterId": "jcn",
    "gatewayRequestDate": "20230921135249",
    "gatewayResponseDate": "20230921135249",
    "loopback": "0",
    "pending": "0",
    "reqAcquirerCode": "05",
    "reqAmount": "5",
    "reqCardExpire": "*****",
    "reqCardNumber": "411111********11",
    "reqItemCode": "0990",
    "reqJpoInformation": "10",
    "reqSecurityCode": "0000",
    "reqWithCapture": "false",
    "resActionCode": "000",
    "resAuthCode": "000000",
    "resCenterErrorCode": "   ",
    "resReturnReferenceNumber": "012345678901",
    "marchTxn": "12345678",
    "merrMsg": "処理が成功しました。",
    "mstatus": "success",
    "optionResults": [],
    "orderId": "dummy1503015213",
    "serviceType": "card",
    "txnVersion": "2.0.0"
  }
}

MDKトークン

  • MDKトークンサーバー（以下、トークンサーバー）は、カード情報非保持・非通過のシステムを実現するために必要な「トークン」を発行します。

  • トークンサーバーに対してクレジットカード情報を送信することで、決済に利用するためのトークンを取得できます。

  • トークンを取得する際は、JavaScriptを用いてクレジットカード情報を消費者ブラウザから直接トークンサーバーに送信します。決済要求時には、クレジットカード番号の代わりにトークンを送ることで、ECサイト側のシステムではクレジットカード情報を通過させることなく決済が可能です。

  • トークンを利用可能な決済サービスは「2-4 トークンで利用できる決済サービス」を参照して下さい。

クレジットカード決済および3Dセキュアにて消費者ブラウザからトークンサーバーに対してクレジットカード情報を送信することで、決済に利用するためのトークンを取得できます。

詳細はMDKトークン 開発ガイドをご確認ください

MDKトークンのリクエストではauthHashによる認証およびリクエストのURLエンコード処理は必要ありません。

MDKトークン

Request Body schema: spplication/json
card_number
required
string <= 19 characters ^[0-9]{19}$

カード番号

数字のみで指定（19桁）

card_expire
required
string <= 5 characters ^\d{2}/\d{2}$

カード有効期限

MM/YY （月 + "/" + 年）の形式

（例 "08/26"）

security_code
string <= 4 characters ^\d{3,4}$

セキュリティコード

cardholder_name
string [ 2 .. 45 ] characters

カード保有者名

半角英数字記号

token_api_key
required
string <= 36 characters

トークンAPIキー

店舗様毎に発行されたトークン取得に使う鍵

lang
string
Enum: "ja" "en"

言語

応答電文の"message"の言語を指定

ja: 日本語

en: 英語

※指定なしのばあいAccept-Languageの値を使用

Responses

Request samples

Content type
spplication/json
{
  • "card_number": "4111111111111111",
  • "card_expire": "01/20",
  • "security_code": "123",
  • "cardholder_name": "TARO YAMADA",
  • "token_api_key": "3fa9b2f7-a2b6-4d1b-9487-12a34b56c7d8",
  • "lang": "ja"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "token_expire_date": "20230923153045",
  • "req_card_number": "411111********11",
  • "status": "success",
  • "code": "success",
  • "message": "トークンの生成に成功しました。"
}

クレジットカード決済

与信

クレジットカード 与信

詳細はインターフェース詳細(クレジットカード決済) CardAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

CardAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1 共通」 に記載の「orderId（取引ID）について」を参照

amount
required
string <= 8 characters ^[0-9]{1,8}$

決済金額

1 以上99,999,999 以下

cardNumber
string <= 19 characters ^[0-9\-]{16,19}$

カード番号

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「2.1.1カード情報の非保持化について」を参照してください。

数字のみ、またはハイフン含みで指定（ハイフン含みの場合は19桁以内で指定）

cardExpire
string^\d{2}/\d{2}$

カード有効期限

(重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「2.1.1カード情報の非保持化について」を参照してください。

MM/YY （月 + "/" + 年）の形式 （例 "08/26"）

jpo
string <= 83 characters ^(10|21|61C\d{2}|80)$
Default: "10"

支払種別

10: （一括払い）

21: （ボーナス一括）

61Cxx: （分割払い、xxに分割回数指定）

80: （リボルビング払い）

※指定が無い場合は、"10"（一括払い）が適用されます。

※直接契約 / 包括契約でそれぞれ使用できる支払種別が異なります。詳細は「3-1支払種別情報の指定」を参照してください。j

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

true: 与信・売上

false: 与信のみ

※指定が無い場合は、デフォルト値の"false"が設定されます。

securityCode
string^\d{3,4}$

セキュリティコード

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「2.1.1カード情報の非保持化について」を参照してください。

セキュリティコード（CVV2/CVC2）とは、カード券面に記載された3桁ないし4桁の数字です。

cardholderName
string [ 2 .. 45 ] characters

カード保有者名

カード保有者名を指定します。

通常は指定する必要はありません。

当項目を指定した場合は、取引情報にカード保有者名が保存されます。保存されたカード保有者名は当該取引をMpiReAuthorizeRequestDtoの元取引として指定した場合に使用されます。

カード保有者名は、決済サーバー内に保存されますが、保存されている値を取得・参照することはできないので、カード保有者を確認する用途では使用できません。

cardOptionType
string
Enum: "mpi" ""

カードオプションタイプ

MPI有り

他社本人認証サービスにより既に認証結果を取得している場合に使用

mpi（本人認証結果付与）

MPI無し : 【未使用】

dddMessageVersion
string <= 10 characters

3Dメッセージバージョン

MPI有り

Message Version Number （例 "2.1.0"）

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddTransactionId
string <= 28 characters

3DトランザクションID

MPI有り

Transaction Identifier(XID)

20桁バイナリ値をBase64にて28桁英数字に変換した値を指定します。

3DS Serverから値を受信した場合に設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddTransactionStatus
string <= 1 characters
Enum: "Y" "A" ""

3Dトランザクションステータス

MPI有り

3Dセキュアトランザクションステータス

Y：本人認証成功

A :Attempt

：値なし（空白）

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

※値のバリエーションは増える可能性があります

MPI無し : 【未使用】

dddCavvAlgorithm
string <= 1 characters
Enum: "9" ""

3DCAVVアルゴリズム

MPI有り

3DセキュアCAVVアルゴリズム

9 :取引ごとの指定なし（Message Version Numberが2.X.Xの場合）

：値なし（空白）

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

※値のバリエーションは増える可能性があります

MPI無し : 【未使用】

dddCavv
string <= 28 characters

3DセキュアCAVV

MPI有り

3DセキュアCAVV

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版） 』を参照してください。

MPI無し : 【未使用】

dddEci
string^\d{2}$
Enum: "01" "02" "05" "06" "07" ""

3DECI

MPI有り

3Dセキュア ECI

01 :Attempt（Master Card）

02 :認証成功（Master Card）

05 :認証成功（VISA、JCB、AMEX、Diners）

06 :Attempt（VISA、JCB）又は未参加（VISA、JCB、AMEX、Diners）

07：認証実行不能（共通）

※リスクは加盟店

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddDsTransactionId
string <= 36 characters

3DDSトランザクションID

MPI有り

ARes/RReqにおけるDS Transaction IDを指定します。

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddServerTransactionId
string <= 36 characters

3DサーバトランザクションID

MPI有り

ARes/RReqにおける3DS Server Transaction IDを指定します。

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

object (payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

再取引(再与信)

クレジットカード再与信

詳細はインターフェース詳細(クレジットカード決済) CardReAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object (CardReAuthorizeRequestDto)

CardReAuthorizeRequest

originalOrderId
required
string^[a-zA-Z0-9]{1,100}$

元取引ID

再取引を行う過去取引の取引ID

※弊社サーバーに取引履歴が保管されている期間は標準で400日間となります。保管期間の起算日の考え方は、取引のステータスが最後に変化した日が起算日となりますので、直近の再取引に使用した取引IDを指定することをお薦めいたします。

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1 共通」 に記載の「orderId（取引ID）について」を参照

amount
required
string <= 8 characters ^[0-9]{1,8}$

決済金額

1 以上99,999,999 以下

cardNumber
string <= 19 characters ^[0-9\-]{16,19}$

カード番号

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「2.1.1カード情報の非保持化について」を参照してください。

数字のみ、またはハイフン含みで指定（ハイフン含みの場合は19桁以内で指定）

cardExpire
string^\d{2}/\d{2}$

カード有効期限

(重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「2.1.1カード情報の非保持化について」を参照してください。

MM/YY （月 + "/" + 年）の形式 （例 "08/26"）

jpo
string <= 83 characters ^(10|21|61C\d{2}|80)$
Default: "10"

支払種別

10: （一括払い）

21: （ボーナス一括）

61Cxx: （分割払い、xxに分割回数指定）

80: （リボルビング払い）

※指定が無い場合は、"10"（一括払い）が適用されます。

※直接契約 / 包括契約でそれぞれ使用できる支払種別が異なります。詳細は「3-1支払種別情報の指定」を参照してください。j

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

true: 与信・売上

false: 与信のみ

※指定が無い場合は、デフォルト値の"false"が設定されます。

securityCode
string^\d{3,4}$

セキュリティコード

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「2.1.1カード情報の非保持化について」を参照してください。

セキュリティコード（CVV2/CVC2）とは、カード券面に記載された3桁ないし4桁の数字です。

cardholderName
string [ 2 .. 45 ] characters

カード保有者名

カード保有者名を指定します。

通常は指定する必要はありません。

当項目を指定した場合は、取引情報にカード保有者名が保存されます。保存されたカード保有者名は当該取引をMpiReAuthorizeRequestDtoの元取引として指定した場合に使用されます。

カード保有者名は、決済サーバー内に保存されますが、保存されている値を取得・参照することはできないので、カード保有者を確認する用途では使用できません。

cardOptionType
string
Enum: "mpi" ""

カードオプションタイプ

MPI有り

他社本人認証サービスにより既に認証結果を取得している場合に使用

mpi（本人認証結果付与）

MPI無し : 【未使用】

dddMessageVersion
string <= 10 characters

3Dメッセージバージョン

MPI有り

Message Version Number （例 "2.1.0"）

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddTransactionId
string <= 28 characters

3DトランザクションID

MPI有り

Transaction Identifier(XID)

20桁バイナリ値をBase64にて28桁英数字に変換した値を指定します。

3DS Serverから値を受信した場合に設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddTransactionStatus
string <= 1 characters
Enum: "Y" "A" ""

3Dトランザクションステータス

MPI有り

3Dセキュアトランザクションステータス

Y：本人認証成功

A :Attempt

：値なし（空白）

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

※値のバリエーションは増える可能性があります

MPI無し : 【未使用】

dddCavvAlgorithm
string <= 1 characters
Enum: "9" ""

3DCAVVアルゴリズム

MPI有り

3DセキュアCAVVアルゴリズム

9 :取引ごとの指定なし（Message Version Numberが2.X.Xの場合）

：値なし（空白）

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

※値のバリエーションは増える可能性があります

MPI無し : 【未使用】

dddCavv
string <= 28 characters

3DセキュアCAVV

MPI有り

3DセキュアCAVV

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版） 』を参照してください。

MPI無し : 【未使用】

dddEci
string^\d{2}$
Enum: "01" "02" "05" "06" "07" ""

3DECI

MPI有り

3Dセキュア ECI

01 :Attempt（Master Card）

02 :認証成功（Master Card）

05 :認証成功（VISA、JCB、AMEX、Diners）

06 :Attempt（VISA、JCB）又は未参加（VISA、JCB、AMEX、Diners）

07：認証実行不能（共通）

※リスクは加盟店

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddDsTransactionId
string <= 36 characters

3DDSトランザクションID

MPI有り

ARes/RReqにおけるDS Transaction IDを指定します。

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

dddServerTransactionId
string <= 36 characters

3DサーバトランザクションID

MPI有り

ARes/RReqにおける3DS Server Transaction IDを指定します。

3DS Serverから受信した値を設定してください。

※本項目は、「cardOptionType（カードオプションタイプ）」に"mpi"（本人認証結果付与）を指定した場合に指定可能となります。『本人認証サービス補足資料（3Dセキュア2.0対応版）』も参照してください。

MPI無し : 【未使用】

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

売上

クレジットカードによる売上を行います。

詳細はインターフェース詳細(クレジットカード決済) CardCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object

CardCaptureRequest

orderId
required
string^[a-zA-Z0-9]{1,100}$

取引ID

与信時に採番した取引ID

amount
required
string <= 8 characters ^[0-9]{1,8}$

決済金額

与信時に設定した金額以下を指定 1 以上 99,999,999 以下

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

キャンセル

クレジットカードによる決済の取消を行います。

詳細はインターフェース詳細(クレジットカード決済) CardCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object

CardCancelRequest

orderId
required
string^[a-zA-Z0-9]{1,100}$

取引ID

与信時に採番した取引ID

amount
string^[0-9]{1,8}$

決済金額

与信時に設定した金額以下、かつ1以上99,999,999以下

※一部キャンセルも可能

※指定なしの場合、全額取消

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

3Dセキュア(3DS2.0)

認可

カード番号を元にイシュア判定を実施し、3Dセキュアの利用可否を判定します。

詳細は3Dセキュア(3DS2.0)開発ガイド インターフェース詳細 MpiAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

MpiAuthorizeRequest

serviceOptionType
required
string
Enum: "mpi-complete" "mpi-company" "mpi-merchant" "mpi-none"

"mpi-complete" : 完全認証

"mpi-company" : 通常認証（カード会社リスク負担）

"mpi-merchant" : 通常認証（カード会社、加盟店リスク負担）

"mpi-none" : 本人認証単体サービス

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

取引を識別する一意のID

「4-1基本項目について」を参照してください。

amount
required
integer [ 1 .. 99999999 ] ^[0-9]{1,8}$

決済金額

1 以上99,999,999 以下

cardNumber
string <= 19 characters ^[0-9\-]{16,19}$

カード番号

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「4.2.1 カード決済関連」の「■カード情報の非保持化について」を参照してください。

数字のみ、またはハイフン含みで指定（ハイフン含みの場合は19桁以内で指定）

※トークンまたはカード情報が必須

cardExpire
string^\d{2}/\d{2}$

カード有効期限

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「4.2.1 カード決済関連」の「■カード情報の非保持化について」を参照してください。

MM/YY （月 + "/" + 年）の形式 （例 "08/26"）

jpo
string <= 83 characters ^(10|21|61C\d{2}|80)$
Default: "10"

支払種別

"10" （一括払い）

"21" （ボーナス一括）

"61Cxx" （分割払い、xxに分割回数指定）

"80" （リボルビング払い）※指定が無い場合は、"10"（一括払い）が適用されます。

※直接契約 / 包括契約でそれぞれ使用できる支払種別が異なります。

詳細は『インターフェース詳細 ～クレジットカード決済～』の「クレジットカード決済 支払種別情報の指定」を参照してください。

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

"true": 与信・売上

"false": 与信のみ※指定が無い場合は、デフォルト値の"false"が設定されます。

securityCode
string^\d{3,4}$

セキュリティコード

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「4.2.1カード決済関連」の「■カード情報の非保持化について」を参照してください。

セキュリティコード（CVV2/CVC2）とは、カード券面に記載された3桁ないし4桁の数字です。

redirectionUri
required
string <= 1024 characters ^[a-zA-Z0-9]{1,1024}$

リダイレクションURI

検証結果を返すURIを指定

(重要)

決済サービスオプションタイプ（serviceOptionType）でMPI単体サービス（"mpi-none"）を選択する場合は、SSLを必須とします。必ず"https://"から始まるURIをご指定下さい。

verifyResultLink
string
Enum: "0" "1" "2"

詳細パラメータ連携フラグ

0:パラメータ連携しない

1:パラメータ連携する

2:パラメータ連携しない(GET)

※未指定の場合は、加盟店ごとの設定で異なる挙動になるため、このフラグを設定することをお勧めします。

httpUserAgent
string

HTTPユーザエージェント

消費者のブラウザ情報

※3Dセキュア 2.0で未指定の場合は、決済サーバー側で表示する画面から取得した値を使用します。

httpAccept
string

HTTPアクセプト

消費者のブラウザ情報

※3Dセキュア 2.0で未指定の場合は、決済サーバー側で表示する画面から取得した値を使用します。

pushUrl
string <= 256 characters ^[A-Za-z0-9\-_\.~:/?#\[\]@!$&'()*+,;=%]+$

プッシュURL

結果通知先URLを指定

指定がない場合には予め登録されたURLを用います。

verifyTimeout
string [ 1 .. 999 ] ^[0-9]{1,3}$

本人認証有効期限

本人認証処理の有効期限（分単位のタイムアウト値）を指定

1 以上999 以下

消費者が本人認証の画面で長時間滞留する等、認証完了までに時間がかかった取引を無効（エラー）にする場合は、この値を設定してください。

タイムアウト判定の起点は、認可要求の処理時刻です。

ECサイトのセッションタイムアウト値よりも数分程度短く設定することを推奨します。

※未指定の場合、弊社サービス上のタイムアウトは発生しないため、長時間経過後に決済が成立する場合があります。

deviceChannel
required
string^[0-9]{2}$
Value: "02"

デバイスチャネル

デバイスチャネルを指定します。

"02": ブラウザベース

重要:本パラメータは必ず設定してください。

accountType
string^[0-9]{2}$
Enum: "01" "02" "03"

アカウントタイプ

アカウントの種類を指定します。

"01": 該当なし

"02": クレジット

"03": デビット

※通常は指定する必要はありません。また、デビットカードを拒否する等の用途で利用できるものではありません。

cardholderName
required
string <= 45 characters

カード保有者名

半角英数記号 2桁以上 45桁以内

カード保有者名を指定します。

※ トークンにカード保有者名設定している場合は、ここでの設定は不要です。

姓名の書き方には明確なルールはありません。

カード券面に記載されている通りの表記で設定することを推奨しますが、以下のような場合にも弊社システム上はエラーにはせず、カード会社の判断に委ねます。

・名と姓の順番が逆

・名と姓の間にスペースがない

・名と姓の間に半角スペースが複数ある

cardholderNameOmitFlag
string
Deprecated
Default: "false"
Enum: "true" "false"

カード保有者名省略フラグ

"true": カード保有者名を省略可能

"false": カード保有者名は必須

※指定が無い場合は、デフォルト値の"false"が設定されます。

※このパラメータは非推奨です。

cardholderEmail
required
string <= 254 characters

カード保有者メールアドレス

カード保有者メールアドレスを指定します。

RFC5322に準拠していないメールアドレスを設定すると、エラーが発生する可能性があります。RFCに準拠していないメールアドレスの場合は当項目は設定せず、代わりに電話番号を設定するなどしてください。

参考: https://www.docomo.ne.jp/service/docomo_mail/rfc_add/

cardholderHomePhoneCountry
required
string <= 3 characters ^[0-9]{3}$

カード保有者自宅電話番号国コード

カード保有者自宅電話番号の国コードを指定します。

ITU-T E.164で規定された地域別国コードを指定(日本の場合は「81」)

cardholderHomePhoneNumber
required
string <= 15 characters ^[0-9]{15}$

カード保有者自宅電話番号

カード保有者自宅電話番号を指定します。

(例：0312345678)

cardholderMobilePhoneCountry
required
string <= 3 characters ^[0-9]{3}$

カード保有者携帯電話番号国コード

カード保有者携帯電話番号の国コードを指定します。

ITU-T E.164で規定された地域別国コードを指定(本の場合は「81」)

cardholderMobilePhoneNumber
required
string <= 15 characters ^[0-9]{15}$

カード保有者携帯電話番号

カード保有者携帯電話番号を指定します。

(例：09012345678)

cardholderWorkPhoneCountry
string <= 3 characters ^[0-9]{3}$

カード保有者勤務先電話番号国コード

カード保有者勤務先電話番号の国コードを指定します。

ITU-T E.164で規定された地域別国コードを指定(本の場合は「81」)

cardholderWorkPhoneNumber
required
string <= 15 characters ^[0-9]{15}$

カード保有者勤務先電話番号

カード保有者勤務先電話番号を指定します。

(例：0312345678)

billingAddressCity
string <= 50 characters ^.{1,50}$

請求先住所_市区町村

請求先住所の市区町村を指定します。

billingAddressCountry
string <= 3 characters ^[0-9]{3}$

請求先住所_国

請求先住所_都道府県を指定した場合は必須

請求先住所の国を指定します。ISO 3166-1 numericで定義されているコードを設定します。先頭が0の場合も省略せずに3桁で設定してください（例:「040」）。

billingAddressLine1
string <= 50 characters ^.{1,50}$

請求先住所1

請求先住所1を指定します。

billingAddressLine2
string <= 50 characters ^.{1,50}$

請求先住所2

請求先住所2を指定します。

billingAddressLine3
string <= 50 characters ^.{1,50}$

請求先住所3

請求先住所3を指定します。

billingPostalCode
string <= 16 characters

請求先郵便番号

半角英数字記号

請求先郵便番号を指定します。

billingAddressState
string <= 3 characters ^[0-9]{3}$

請求先住所_都道府県

請求先住所の都道府県を指定します。

ISO 3166-2で定義されているコードを設定します。

shippingAddressCity
string <= 50 characters ^.{1,50}$

配送先住所_市区町村

配送先住所の市区町村を指定します。

shippingAddressCountry
string <= 3 characters ^[0-9]{3}$

配送先住所_国

配送先住所_都道府県を指定する場合は必須

配送先住所の国を指定します。

ISO 3166-1 numericで定義されているコードを設定します。先頭が0の場合も省略せずに3桁で設定してください（例:「040」）。

shippingAddressLine1
string <= 50 characters ^.{1,50}$

配送先住所1

配送先住所1を指定します。

shippingAddressLine2
string <= 50 characters ^.{1,50}$

配送先住所2

配送先住所2を指定します。

shippingAddressLine3
string <= 50 characters ^.{1,50}$

配送先住所3

配送先住所3を指定します。

shippingPostalCode
string <= 16 characters ^[0-9]{,16}$

配送先郵便番号

半角英数字記号

配送先郵便番号を指定します。

shippingAddressState
string <= 3 characters ^[0-9]{3}$

配送先住所_都道府県

配送先住所の都道府県を指定します。

ISO 3166-2で定義されているコードを設定します。

customerIp
required
string <= 45 characters ^[a-zA-Z0-9]{1,45}$

消費者IPアドレス

消費者のブラウザ情報をアプリケーションサーバから取得して設定します。

MAPの「各種設定変更」のページで以下のチェックボックスをチェックしている場合はここでは設定不要です。

IPアドレスを自動収集する ☑

requestorChallengeIndicator
string <= 2 characters ^[0-9]{2}$

リクエスターチャレンジインジケーター

このリクエストに対してチャレンジ認証を要求するかを指定します。

"01": No preference（任意）

"02": No challenge requested（チャレンジ認証を要求しない）

"03": Challenge requested (3DS Requestor preference)（チャレンジ認証を要求する）

"04": Challenge requested (Mandate)（チャレンジ認証を要求する）

※"04"を指定しても必ずチャレンジ認証が行われるとは限りません。

※このパラメータは、通常は指定する必要はありません。カード会社から設定を指示された場合にご利用ください。（カード会社からの指示に従ってください）

※未指定の場合は、'01'と同様の挙動になります。

tempRegistration
string
Default: "0"
Enum: "0" "1"

仮登録フラグ このパラメータを利用すると、3D セキュア（本人認証＋カード決済）の利用時に、カード情報（および継続課金データ）が登録されるタイミングを制御できます。

3D セキュアの認可が成功した時点で、カード情報を仮登録扱いにするかどうかを以下のフラグで指定します。

0: 仮登録扱いにしない（認可が成功した時点でカード情報を登録する）

1: 仮登録扱いとする（認可成功時点では仮登録とし、カード決済の成功時にカード情報を本登録する）

※未設定時は"0"です。

object (payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

再取引

過去の取引で利用されたカード番号で、再度認可を要求します。

詳細は3Dセキュア(3DS2.0)開発ガイド インターフェース詳細 MpiReAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object (MpiReAuthorizeRequestDto)

MpiReAuthorizeRequest

originalOrderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

元取引ID

再取引を行う過去取引の取引ID

serviceOptionType
required
string
Enum: "mpi-complete" "mpi-company" "mpi-merchant" "mpi-none"

"mpi-complete" : 完全認証

"mpi-company" : 通常認証（カード会社リスク負担）

"mpi-merchant" : 通常認証（カード会社、加盟店リスク負担）

"mpi-none" : 本人認証単体サービス

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

取引を識別する一意のID

「4-1基本項目について」を参照してください。

amount
required
integer [ 1 .. 99999999 ] ^[0-9]{1,8}$

決済金額

1 以上99,999,999 以下

cardNumber
string <= 19 characters ^[0-9\-]{16,19}$

カード番号

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「4.2.1 カード決済関連」の「■カード情報の非保持化について」を参照してください。

数字のみ、またはハイフン含みで指定（ハイフン含みの場合は19桁以内で指定）

※トークンまたはカード情報が必須

cardExpire
string^\d{2}/\d{2}$

カード有効期限

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「4.2.1 カード決済関連」の「■カード情報の非保持化について」を参照してください。

MM/YY （月 + "/" + 年）の形式 （例 "08/26"）

jpo
string <= 83 characters ^(10|21|61C\d{2}|80)$
Default: "10"

支払種別

"10" （一括払い）

"21" （ボーナス一括）

"61Cxx" （分割払い、xxに分割回数指定）

"80" （リボルビング払い）※指定が無い場合は、"10"（一括払い）が適用されます。

※直接契約 / 包括契約でそれぞれ使用できる支払種別が異なります。

詳細は『インターフェース詳細 ～クレジットカード決済～』の「クレジットカード決済 支払種別情報の指定」を参照してください。

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

"true": 与信・売上

"false": 与信のみ※指定が無い場合は、デフォルト値の"false"が設定されます。

securityCode
string^\d{3,4}$

セキュリティコード

（重要）カード情報の非保持（非通過、非保持）への対応のため、通常は設定しないでください。

詳しくは「4.2.1カード決済関連」の「■カード情報の非保持化について」を参照してください。

セキュリティコード（CVV2/CVC2）とは、カード券面に記載された3桁ないし4桁の数字です。

redirectionUri
required
string <= 1024 characters ^[a-zA-Z0-9]{1,1024}$

リダイレクションURI

検証結果を返すURIを指定

(重要)

決済サービスオプションタイプ（serviceOptionType）でMPI単体サービス（"mpi-none"）を選択する場合は、SSLを必須とします。必ず"https://"から始まるURIをご指定下さい。

verifyResultLink
string
Enum: "0" "1" "2"

詳細パラメータ連携フラグ

0:パラメータ連携しない

1:パラメータ連携する

2:パラメータ連携しない(GET)

※未指定の場合は、加盟店ごとの設定で異なる挙動になるため、このフラグを設定することをお勧めします。

httpUserAgent
string

HTTPユーザエージェント

消費者のブラウザ情報

※3Dセキュア 2.0で未指定の場合は、決済サーバー側で表示する画面から取得した値を使用します。

httpAccept
string

HTTPアクセプト

消費者のブラウザ情報

※3Dセキュア 2.0で未指定の場合は、決済サーバー側で表示する画面から取得した値を使用します。

pushUrl
string <= 256 characters ^[A-Za-z0-9\-_\.~:/?#\[\]@!$&'()*+,;=%]+$

プッシュURL

結果通知先URLを指定

指定がない場合には予め登録されたURLを用います。

verifyTimeout
string [ 1 .. 999 ] ^[0-9]{1,3}$

本人認証有効期限

本人認証処理の有効期限（分単位のタイムアウト値）を指定

1 以上999 以下

消費者が本人認証の画面で長時間滞留する等、認証完了までに時間がかかった取引を無効（エラー）にする場合は、この値を設定してください。

タイムアウト判定の起点は、認可要求の処理時刻です。

ECサイトのセッションタイムアウト値よりも数分程度短く設定することを推奨します。

※未指定の場合、弊社サービス上のタイムアウトは発生しないため、長時間経過後に決済が成立する場合があります。

deviceChannel
required
string^[0-9]{2}$
Value: "02"

デバイスチャネル

デバイスチャネルを指定します。

"02": ブラウザベース

重要:本パラメータは必ず設定してください。

accountType
string^[0-9]{2}$
Enum: "01" "02" "03"

アカウントタイプ

アカウントの種類を指定します。

"01": 該当なし

"02": クレジット

"03": デビット

※通常は指定する必要はありません。また、デビットカードを拒否する等の用途で利用できるものではありません。

cardholderName
required
string <= 45 characters

カード保有者名

半角英数記号 2桁以上 45桁以内

カード保有者名を指定します。

※ トークンにカード保有者名設定している場合は、ここでの設定は不要です。

姓名の書き方には明確なルールはありません。

カード券面に記載されている通りの表記で設定することを推奨しますが、以下のような場合にも弊社システム上はエラーにはせず、カード会社の判断に委ねます。

・名と姓の順番が逆

・名と姓の間にスペースがない

・名と姓の間に半角スペースが複数ある

cardholderNameOmitFlag
string
Deprecated
Default: "false"
Enum: "true" "false"

カード保有者名省略フラグ

"true": カード保有者名を省略可能

"false": カード保有者名は必須

※指定が無い場合は、デフォルト値の"false"が設定されます。

※このパラメータは非推奨です。

cardholderEmail
required
string <= 254 characters

カード保有者メールアドレス

カード保有者メールアドレスを指定します。

RFC5322に準拠していないメールアドレスを設定すると、エラーが発生する可能性があります。RFCに準拠していないメールアドレスの場合は当項目は設定せず、代わりに電話番号を設定するなどしてください。

参考: https://www.docomo.ne.jp/service/docomo_mail/rfc_add/

cardholderHomePhoneCountry
required
string <= 3 characters ^[0-9]{3}$

カード保有者自宅電話番号国コード

カード保有者自宅電話番号の国コードを指定します。

ITU-T E.164で規定された地域別国コードを指定(日本の場合は「81」)

cardholderHomePhoneNumber
required
string <= 15 characters ^[0-9]{15}$

カード保有者自宅電話番号

カード保有者自宅電話番号を指定します。

(例：0312345678)

cardholderMobilePhoneCountry
required
string <= 3 characters ^[0-9]{3}$

カード保有者携帯電話番号国コード

カード保有者携帯電話番号の国コードを指定します。

ITU-T E.164で規定された地域別国コードを指定(本の場合は「81」)

cardholderMobilePhoneNumber
required
string <= 15 characters ^[0-9]{15}$

カード保有者携帯電話番号

カード保有者携帯電話番号を指定します。

(例：09012345678)

cardholderWorkPhoneCountry
string <= 3 characters ^[0-9]{3}$

カード保有者勤務先電話番号国コード

カード保有者勤務先電話番号の国コードを指定します。

ITU-T E.164で規定された地域別国コードを指定(本の場合は「81」)

cardholderWorkPhoneNumber
required
string <= 15 characters ^[0-9]{15}$

カード保有者勤務先電話番号

カード保有者勤務先電話番号を指定します。

(例：0312345678)

billingAddressCity
string <= 50 characters ^.{1,50}$

請求先住所_市区町村

請求先住所の市区町村を指定します。

billingAddressCountry
string <= 3 characters ^[0-9]{3}$

請求先住所_国

請求先住所_都道府県を指定した場合は必須

請求先住所の国を指定します。ISO 3166-1 numericで定義されているコードを設定します。先頭が0の場合も省略せずに3桁で設定してください（例:「040」）。

billingAddressLine1
string <= 50 characters ^.{1,50}$

請求先住所1

請求先住所1を指定します。

billingAddressLine2
string <= 50 characters ^.{1,50}$

請求先住所2

請求先住所2を指定します。

billingAddressLine3
string <= 50 characters ^.{1,50}$

請求先住所3

請求先住所3を指定します。

billingPostalCode
string <= 16 characters

請求先郵便番号

半角英数字記号

請求先郵便番号を指定します。

billingAddressState
string <= 3 characters ^[0-9]{3}$

請求先住所_都道府県

請求先住所の都道府県を指定します。

ISO 3166-2で定義されているコードを設定します。

shippingAddressCity
string <= 50 characters ^.{1,50}$

配送先住所_市区町村

配送先住所の市区町村を指定します。

shippingAddressCountry
string <= 3 characters ^[0-9]{3}$

配送先住所_国

配送先住所_都道府県を指定する場合は必須

配送先住所の国を指定します。

ISO 3166-1 numericで定義されているコードを設定します。先頭が0の場合も省略せずに3桁で設定してください（例:「040」）。

shippingAddressLine1
string <= 50 characters ^.{1,50}$

配送先住所1

配送先住所1を指定します。

shippingAddressLine2
string <= 50 characters ^.{1,50}$

配送先住所2

配送先住所2を指定します。

shippingAddressLine3
string <= 50 characters ^.{1,50}$

配送先住所3

配送先住所3を指定します。

shippingPostalCode
string <= 16 characters ^[0-9]{,16}$

配送先郵便番号

半角英数字記号

配送先郵便番号を指定します。

shippingAddressState
string <= 3 characters ^[0-9]{3}$

配送先住所_都道府県

配送先住所の都道府県を指定します。

ISO 3166-2で定義されているコードを設定します。

customerIp
required
string <= 45 characters ^[a-zA-Z0-9]{1,45}$

消費者IPアドレス

消費者のブラウザ情報をアプリケーションサーバから取得して設定します。

MAPの「各種設定変更」のページで以下のチェックボックスをチェックしている場合はここでは設定不要です。

IPアドレスを自動収集する ☑

requestorChallengeIndicator
string <= 2 characters ^[0-9]{2}$

リクエスターチャレンジインジケーター

このリクエストに対してチャレンジ認証を要求するかを指定します。

"01": No preference（任意）

"02": No challenge requested（チャレンジ認証を要求しない）

"03": Challenge requested (3DS Requestor preference)（チャレンジ認証を要求する）

"04": Challenge requested (Mandate)（チャレンジ認証を要求する）

※"04"を指定しても必ずチャレンジ認証が行われるとは限りません。

※このパラメータは、通常は指定する必要はありません。カード会社から設定を指示された場合にご利用ください。（カード会社からの指示に従ってください）

※未指定の場合は、'01'と同様の挙動になります。

tempRegistration
string
Default: "0"
Enum: "0" "1"

仮登録フラグ このパラメータを利用すると、3D セキュア（本人認証＋カード決済）の利用時に、カード情報（および継続課金データ）が登録されるタイミングを制御できます。

3D セキュアの認可が成功した時点で、カード情報を仮登録扱いにするかどうかを以下のフラグで指定します。

0: 仮登録扱いにしない（認可が成功した時点でカード情報を登録する）

1: 仮登録扱いとする（認可成功時点では仮登録とし、カード決済の成功時にカード情報を本登録する）

※未設定時は"0"です。

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

本人認証結果確認

本人認証結果を取得できます。

詳細は3Dセキュア(3DS2.0)開発ガイド インターフェース詳細 MpiGetResultRequestDto をご確認ください

Request Body schema: application/json
required
required
object

MpiGetResultRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

取引を識別する一意のID

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ワンクリック継続課金

会員情報 追加

会員情報 追加

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) AccountAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (AccountAddRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員情報 変更

会員情報 変更

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) AccountUpdateRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (AccountUpdateRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員情報 削除

会員情報 削除

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) AccountDeleteRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (AccountDeleteRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員情報 復元

会員情報 復元

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) AccountRestoreRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (AccountRestoreRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員情報 複製

会員情報 複製

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) AccountCopyRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (AccountCopyRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

継続課金管理 追加

継続課金管理 追加

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) RecurringAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (RecurringAddRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

継続課金管理 更新

継続課金管理 更新

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) RecurringUpdateRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (RecurringUpdateRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

継続課金管理 削除

継続課金管理 削除

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) RecurringDeleteRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (RecurringDeleteRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

継続課金管理 取得

継続課金管理 取得

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) RecurringGetRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (RecurringGetRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

登録カード管理 追加

登録カード管理 追加

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) CardInfoAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (CardInfoAddRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

登録カード管理 更新

登録カード管理 更新

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) CardInfoUpdateRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (CardInfoUpdateRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

登録カード管理 削除

登録カード管理 削除

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) CardInfoDeleteRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (CardInfoDeleteRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

登録カード管理 取得

登録カード管理 取得

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) CardInfoGetRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (CardInfoGetRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

登録口座管理 追加

登録口座管理 追加

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) BankAccountAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (BankAccountAddRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

登録口座管理 削除

登録口座管理 削除

詳細は ワンクリック継続課金 インターフェース詳細(ワンクリック継続課金) BankAccountDeleteRequestDto をご確認ください

Request Body schema: application/json
required
required
object
object (BankAccountDeleteRequestDto)
txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

PayPay

申込

詳細は ID決済 PayPay インターフェース詳細 5.1.1 申込 PaypayAuthorizeRequestDto をご確認ください

申込 /Authorize

【都度決済】 (与信)

申込(与信)コマンドと、申込(与信+売上)コマンドのどちらを利用するか(売上処理を与信の後に行うか、与信と同時に行うか)は、あらかじめ加 盟店契約の際に決めていただく必要があります。「6.1.2 売上方式について(都度決済)」をご参照ください。

【随時決済】 (承諾)

利用承諾を要求します。

要求パラメータのaccountingTypeを1に設定した場合は、随時決済の申込を行います。

Request Body schema: application/json
required
required
object

PayPayAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定("online": オンライン決済)

accountingType
string
Default: "0"
Enum: "0" "1"

課金種別

利用する決済方法の課金種別を指定

0: 都度決済(デフォルト値)

1: 随時決済

(未指定の場合は0: 都度決済となります)'

amount
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額を指定

1~9999999の間で指定できます。

随時決済:指定できません

itemName
string <= 40 characters

商品名

商品名を指定 (文字列のサイズは、全角 1 文字を 2 バイトとみなした数値です。

40 バイトの場合は全角文字 20 桁となります

※詳細は「6-2 PayPay（オンライン決済）文字制限に関する補足」を参照して下さい。

※現在の仕様では商品名はPayPayの画面には表示されません。加盟店様が弊社の管理画面（MAP）で確認する用途のみに利用されるものですので、省略は可能です。

itemId
required
string <= 32 characters

商品ID

店舗側で商品やサービスを特定する ID を指定 (半角英数字32桁以内)

※詳細は「6-2 PayPay（オンライン決済） 文字制限に関する補足」を参照して下さい。

※現在の仕様では商品IDはPayPayの画面には表示されませんが、接続先事業者（SBPS社）の仕様上必須とされておりますので、任意の値を指定してください。

successUrl
string <= 1024 characters

決済完了時URL

決済成功時に、店舗側サイトに画面遷移を戻すための URL (クエリパラメータ指定可) を指定

※未指定の場合は、管理画面 (MAP) で設定した値を使用

cancelUrl
string <= 1024 characters

決済キャンセル時URL

決済キャンセル時に、店舗側サイトに画面遷移を戻すための URL (クエリパラメータ指定可)を指定

※未指定の場合は、管理画面 (MAP) で設定した値を使用

errorUrl
string <= 1024 characters

決済エラー時URL

決済エラー時に、店舗側サイトに画面遷移を戻すための URL (クエリパラメータ指定可) を指定

※未指定の場合は、管理画面 (MAP) で設定した値を使用

pushUrl
string <= 256 characters

結果通知のプッシュ URL を指定 (クエリパラメータ指定可) を指定

※未指定の場合は、管理画面 (MAP) で設定した値を使用

transitionType
string
Value: "1"

遷移種別

スマートフォンアプリから PayPay を利用する場合は 以下の値を指定してください。

1:アプリから遷移(WebLink)

※詳細は「6-6 遷移種別(transitionType)の指定に ついて」を参照して下さい。

随時決済:指定できません

extendParameterType
string
Default: "0"
Enum: "0" "1"

拡張パラメータフラグ

結果通知と消費者ブラウザから店舗側の完了画面へリダイレクトする時のクエリパラメータの設定タイプを指定

0:デフォルトタイプの設定(デフォルト値)

1:拡張タイプの設定

※拡張タイプの場合、今後パラメータが追加される 可能性があります。

※未指定の場合は、管理画面(MAP)で設定した値 を使用。管理画面での設定値がない場合は、0: デフォルトタイプの設定となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

再与信

詳細は ID決済 PayPay インターフェース詳細 5.1.2 再与信 PaypayReAuthorizeRequestDto をご確認ください

随時決済の利用承諾を取得した取引を元取引として決済処理を要求します。

決済処理は与信同時売上となります。

要求電文のパラメータを調整することで、再与信実行時に消費者の残高不足で決済処理ができなかった場合でも消費者に対して支払い要求を送信し決済処理を促すことが可能です。

詳しくは「5.1.2 再与信」をご参照下さい。

Request Body schema: application/json
required
required
object

PaypayReAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

「orderId（取引ID）について」参照

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online": オンライン決済

originalOrderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

元取引ID

随時決済の申込で指定した取引 ID を指定します

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額を指定

itemName
string

商品名

商品名を指定

文字列のサイズは、全角 1 文字を 2 バイトとみなした数値です。40 バイトの場合は全角文字 20 桁となります

※詳細は「6-2 PayPay（オンライン決済） 文字制限に関する補足」を参照して下さい。

※未指定の場合は、申込時に入力した値を使用します。申込時に未指定の場合は、設定しません。

※現在の仕様では商品名はPayPayの画面には表示されません。加盟店様が弊社の管理画面（MAP）で確認する用途のみに利用されるものです。

itemId
string <= 32 characters

商品ID

店舗側で商品やサービスを特定する ID を指定

※詳細は「6-2 PayPay（オンライン決済） 文字制限に関する補足」を参照して下さい。

※未指定の場合は、申込時に入力した値を使用します。

※現在の仕様では商品IDはPayPayの画面には表示されません。

nsfRecoveryFlag
string
Enum: "true" "false"

支払い要求実行フラグ

再与信処理が消費者の残高不足が原因で失敗した場合に、消費者アプリに支払い要求を送信するかどうかを指定します。

true：支払い要求を送信する

false：支払い要求を送信せず、売上処理失敗とする

※未指定の場合は、"false"を設定します。'

nsfRecoveryExpiredDatetime
string <= 14 characters

支払い有効期限

再与信処理が消費者の残高不足が原因で失敗し消費者アプリに支払い要求を送信した場合の支払い有効期限を指定します。(YYYYMMDDhhmmss 形式)

リクエスト日時の 10 分後～48 時間後の範囲で指定可能です。

※nsfRecoveryFlag="true"の場合に指定可能なパラメータです。

※nsfRecoveryFlag="true"で未指定の場合は、リクエスト日時の 6 時間後を設定します。

pushUrl
string <= 1024 characters

プッシュ先URL

結果通知のプッシュ URL を指定（クエリパラメータ指定可）

※未指定の場合は、管理画面(MAP)により設定した値を使用

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

取消

詳細は ID決済 PayPay インターフェース詳細 5.1.3 取消 PaypayCancelRequestDto をご確認ください

【都度決済】

決済を取消（キャンセル）します。

売上前の取引に対してのみ実行でき、与信（オーソリ）の取消となります。

【随時決済】

再与信を行い消費者に支払い要求をしている最中にそのリクエストを取消します。

Request Body schema: application/json
required
required
object

PaypayCancelRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

「orderId（取引ID）について」参照

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online": オンライン決済

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

詳細は ID決済 PayPay インターフェース詳細 5.1.4 売上 PaypayCaptureRequestDto をご確認ください

申込済み取引の売上確定を要求します。

Request Body schema: application/json
required
required
object

PaypayCaptureRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

「orderId（取引ID）について」参照

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online": オンライン決済

amount
string <= 7 characters ^[0-9]{1,7}$

決済金額

売上金額を指定

※未指定の場合は、与信金額の全額売上となります。

orderDescription
string <= 255 characters

注文の説明

ユーザの明細に表示される注文の説明を指定します。

説明は与信金額未満を指定した部分売上の場合のみユーザの明細に表示されます。

全額売上の場合は指定しても説明自体が表示されません。

※詳細は「6-2 PayPay（オンライン決済） 文字制限に関する補足」を参照して下さい。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金

詳細は ID決済 PayPay インターフェース詳細 5.1.5 返金 PaypayRefundRequestDto をご確認ください

売上確定済みの取引に対し返金します。

Request Body schema: application/json
required
required
object

PaypayRefundRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

※随時決済取引の場合は再与信を行った取引 ID を指定します

「orderId（取引ID）について」参照

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online": オンライン決済

amount
string <= 7 characters ^[0-9]{1,7}$

返金金額

返金金額を指定

※未指定の場合は、返金処理実行時点での売上額全額となります

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

解約

詳細は ID決済 PayPay インターフェース詳細 5.1.6 解約 PaypayTerminateRequestDto をご確認ください

随時決済の解約を要求します。

消費者を介する解約（3者間）もしくは加盟店による強制解約(2者間)のいずれかの要求が可能です。

Request Body schema: application/json
required
required
object

PaypayTerminateRequest

orderId
required
string <= 100 characters

取引ID

店舗側で採番した取引IDを指定

「orderId（取引ID）について」参照

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online": オンライン決済

force
string
Enum: "true" "false"

強制解約

"true": 加盟店による強制解約 (2 者間)

"false": 消費者を介する解約 (3 者間)

※未指定の場合は、"false"：消費者を介する解約 (3 者間) となります。

successUrl
string <= 1024 characters

解約完了時URL

2者間の場合: 指定できません。

3者間の場合: 解約成功時に、店舗側サイトに画面遷移を戻すための URL を指定（クエリパラメータ指定可）

※未指定の場合は、申込時に入力した値、または MAP（Merchant Administration Portal）により設定した値を使用

cancelUrl
string <= 1024 characters

解約キャンセル時URL

2者間の場合: 指定できません。

3者間の場合: 解約キャンセル時に、店舗側サイトに画面遷移を戻すための URL を指定（クエリパラメータ指定可）

※未指定の場合は、申込時に入力した値、または MAP（Merchant Administration Portal）により設定した値を使用

errorUrl
string <= 1024 characters

解約エラー時URL

2者間の場合: 指定できません。

3者間の場合: 解約エラー時に、店舗側サイトに画面遷移を戻すための URL を指定（クエリパラメータ指定可）

※未指定の場合は、申込時に入力した値、または MAP（Merchant Administration Portal）により設定した値を使用

pushUrl
string <= 256 characters

プッシュ先URL

2者間の場合: 指定できません。

3者間の場合: 結果通知のプッシュ URL を指定（クエリパラメータ指定可）

※未指定の場合は、申込時に入力した値、または MAP（Merchant Administration Portal）により設定した値を使用

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {},
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

LINE Pay

申込

申込 与信/与信+売上

詳細は ID決済 LINE Pay インターフェース詳細 5.1.1 申込 LinepayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

LinepayAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額(合計金額)を指定

withCapture
string
Enum: "true" "false"

売上フラグ

true : 与信同時売上

false : 与信のみ (デフォルト値)

※指定が無い場合は、与信のみとなります。

itemId
string <= 64 characters ^[a-zA-Z0-9]{1,64}$

商品ID

店舗側で発番する、商品またはサービスの管理用番号を指定

・LINE Pay システムには連携されません。

itemName
required
string <= 4000 characters

商品名

全角半角 4000byte以内

商品名を指定

※LINE が提供する消費者向けの画面やメール本文に表示されます。

itemImageUrl
string <= 256 characters

商品画像URL

URLに使用可能な半角文字256桁以内

決済画面に表示される商品画像のURLを指定。

サイズ:84x84

checkUseBrowser
string
Default: "false"
Enum: "true" "false"

使用ブラウザ判定

true : 決済を要請したbrowser とLINE アプリから遷移するbrowser が異なる場合、LINE Payで決済を要請したbrowser に戻るよう案内ページを提供する。

false : LINE Pay で決済を要請したbrowser とLINEアプリから遷移するbrowser の確認をしない

※指定がない場合は、"false"となります。

※詳しくは、「6.3.3checkUseBrowser の利用方法」を参照してください。

appUrlScheme
string <= 256 characters

アプリ起動URLスキーム

URLに使用可能な半角文字256桁以内

LINEPay アプリが起動するブラウザまたは独自アプリケーションを起動するためのURL スキーム。

スマートフォン用のサイトまたはスマートフォン上で動作する独自アプリケーションからLINE Pay を利用する際には指定して下さい。

LINE Pay アプリで決済後に決済サーバーに遷移するためのURLを、決済サーバー側で付与するためのプレースホルダ""を埋め込んだURL スキームを指定して下さい。

※詳しくは、「6.3.1appUrlScheme の指定方法」を参照してください。

useOriginalApp
string <= 1 characters
Enum: "1" "0"

独自アプリ起動時のオプション指定

0 : オプション指定なし(デフォルト値)

1 : をURL エンコーディングする

このオプションを指定した場合は、appUrlScheme に指定したプレースホルダに決済サーバー側でURL エンコーディングしたURL 文字列をセットします。

mid
string <= 50 characters ^[a-zA-Z0-9]{1,50}$
Deprecated

LINEmemberID

LINEユーザを特定する固有ID。

※現在は使用できません。

packageName
string <= 4000 characters ^[a-zA-Z0-9]{1,4000}$

packageName

Androidでアプリ起動時に指定するpackageName。

※詳しくは、「6.3.1appUrlScheme の指定方法」を参照してください。

successUrl
string <= 256 characters

決済完了時URL

URLに使用可能な半角文字256桁以内

決済成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelUrl
string <= 256 characters

決済キャンセル時URL

URLに使用可能な半角文字256桁以内

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

errorUrl
string <= 256 characters

決済エラー時URL

URLに使用可能な半角文字256桁以内

決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

pushUrl
string <= 256 characters

結果通知受信URL

URLに使用可能な半角文字256桁以内

結果通知のプッシュURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administration Portal)により設定した値を使用

oneTimeKey
string <= 19 characters ^[a-zA-Z0-9]{1,19}$

ワンタイムキー

店舗レジなどでQRコードもしくはバーコード読み取りによる決済を実行する場合に指定します。

LINE Pay アプリで提供するQR/BarCode を取得し、その値を指定してください。

この値の有効期間は5分間で、有効期間内に申込みをしなければなりません。

また、決済成立後に同じ値を設定した場合や、不正な値を設定した場合には、IG08を返却します。

QR/BarCode はLINE5.1バージョンからサポートされます。

※この項目を指定する場合、paymentConfirmType は、1 : サーバ間通信を指定してください。

paymentConfirmType
string <= 1 characters
Enum: "1" "0"

決済確認方法

決済確認の方式を指定します。

0 : ブラウザを介する通信(デフォルト値)

1 : サーバ間通信

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {}
}

売上

売上

詳細は ID決済 LINE Pay インターフェース詳細 5.1.3 売上 LinepayCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object

LinepayCaptureRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

売上対象の取引IDを指定

amount
string <= 7 characters ^[0-9]{1,7}$

売上金額

売上金額を指定。

※未指定時は全額売上となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は ID決済 LINE Pay インターフェース詳細 5.1.4 キャンセル LinepayCancelRequestDto をご確認ください

Request Body schema: application/json
required
object

LinepayCancelRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId(取引ID)について」参照

amount
string <= 7 characters ^[0-9]{1,7}$

減額金額

減額する金額を指定。

※未指定時は全額取消となります。

※売上が未成立の取引の場合は、全額のみ指定可です。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

楽天ペイ

与信

申込 与信/与信+売上

詳細は ID決済 楽天ペイ インターフェース詳細 5.1.1 申込 RakutenAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
都度決済 (object) or 随時決済 (object)
One of
orderId
required
string (RakutenAuthorizeRequestDtoCommon_components-schemas-orderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

payType
required
string (payType) <= 1 characters
Value: "2"

決済種別

2 : オンライン決済(V2)固定。

accountingType
any (accountingType)
Enum: "0" "1"

課金種別

半角数字

利用する決済方法の課金種別を指定

0 : 都度（デフォルト値）

1 : 随時

※未指定の場合、0都度になります。

amount
required
string (components-schemas-amount) <= 8 characters ^[0-9]{1,7}$

決済金額

決済金額(合計金額)を指定

※楽天のレギュレーション上、最小金額は100円となっています。

100円未満の決済が起こりうる場合には、必ず事前に楽天ペイメント株式会社にご相談ください。

(ただし、その場合も2円未満は指定できません。)

withCapture
string (components-schemas-withCapture)
Enum: "true" "false"

売上フラグ

true : 与信＋売上

false : 与信のみ (デフォルト値)

※ 指定がない場合は、与信のみとなります。

※ 物品販売の場合、true は許可しません。

itemId
string (itemId) <= 64 characters ^[a-zA-Z0-9]{1,64}$

商品ID

店舗側で発番する商品またはサービスの管理用番号を指定

itemName
string (itemName) <= 300 characters

商品名

商品名を指定

都度決済の場合は、300文字以内。

随時決済の場合は、200文字以内。

※楽天の管理画面に表示されます。

※都度の場合は、楽天の項目「description」にあたります。不正注文対策として購入商品情報を楽天指定のフォーマットでセットしてください。詳細は楽天ペイメント株式会社が規定するレギュレーションをご参照ください。

※随時の場合は、楽天の項目「name」にあたります。サービス/商品名が変更された場合でも、値の修正は後から行えませんのでご承知おきください。

successUrl
string (components-schemas-successUrl) <= 256 characters

決済完了時URL

URLに使用可能な半角文字256桁以内

決済成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用

errorUrl
string (components-schemas-errorUrl) <= 256 characters

決済エラー時URL

URLに使用可能な半角文字256桁以内

決済エラー/保留時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(MerchantAdministrator Portal)から登録申請した値を使用

※決済保留(mstatus=pending)時は、対象取引が成功である可能性があるため、消費者への表示や通知の内容はご注意ください。
pushUrl
string (components-schemas-pushUrl) <= 256 characters

プッシュURL

URLに使用可能な半角文字256桁以内

プッシュURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
Example
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

再与信

再与信 与信/与信+売上

詳細は ID決済 楽天ペイ インターフェース詳細 5.1.3 再与信 RakutenReAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
object

RakutenReAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId（取引ID）について」参照

originalOrderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

元取引ID

随時決済の決済申込時に指定した取引IDを指定

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額(合計金額)を指定

※楽天のレギュレーション上、最小金額は100円となっています。

100円未満の決済が起こりうる場合には、必ず事前に楽天ペイメント株式会社にご相談ください。

(ただし、その場合も2円未満は指定できません。)

withCapture
string
Enum: "true" "false"

売上フラグ

true : 与信＋売上

false : 与信のみ (デフォルト値)

※未指定の場合は、与信のみとなります。

itemId
string <= 64 characters ^[a-zA-Z0-9]{1,64}$

商品ID

店舗側で発番する商品またはサービスの管理用番号を指定

itemName
string <= 300 characters

商品名

商品名を指定

※楽天の管理画面に表示されます。

※楽天の項目「description」にあたります。不正注文対策として購入商品情報を楽天指定のフォーマットでセットしてください。詳細は楽天ペイメント株式会社が規定するレギュレーションをご参照ください。

※未指定の場合は、随時決済の決済申込時に指定した取引の「itemName」を設定します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

与信変更

与信変更

詳細は ID決済 楽天ペイ インターフェース詳細 5.1.4 与信変更 RakutenUpdateAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
object

RakutenUpdateAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

与信変更対象の取引IDを指定

※随時決済取引の場合は再与信を行った取引IDを指定します。

amount
string^[0-9]{1,7}$

変更金額

変更する金額を指定。

※未指定時は金額変更を行いません。

authExtensionFlag
string
Enum: "true" "false"

与信延長フラグ

true : 行う

false : 行わない

※指定がない場合は、「行わない」となります。

与信期限を延長する場合はtrueとしてください

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細は ID決済 楽天ペイ インターフェース詳細 5.1.5 売上 RakutenCaptureRequestDto をご確認ください

Request Body schema: application/json
required
object

RakutenCaptureRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

売上対象の取引IDを指定

※随時決済取引の場合は再与信を行った取引IDを指定します。

amount
string^[0-9]{1,7}$

売上金額

売上金額を指定。

※未指定時は全額売上となります。

※楽天のレギュレーション上、最小金額は100円となっています。100円未満の決済が起こりうる場合には、必ず事前に楽天ペイメント株式会社にご相談ください。

（ただし、その場合も2円未満は指定できません。）

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

取消

取消

詳細は ID決済 楽天ペイ インターフェース詳細 5.1.6 取消 RakutenCancelRequestDto をご確認ください

Request Body schema: application/json
required
object

RakutenCancelRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

取消対象の取引IDを指定

※随時決済取引の場合は再与信を行った取引IDを指定します。

amount
string^[0-9]{1,7}$

減額金額

減額する金額を指定。

※未指定時は全額取消となります。

※売上前の場合は全額以外を指定できません。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

メルペイ

申込

申込 与信/与信+売上/承諾

詳細は ID決済 メルペイ インターフェース詳細 5.1.1 申込 MerpayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online"：オンライン決済

amount
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額を指定

1～1000000の間で指定できます。

※以下の場合、未設定または0のみ許容します。

課金種別が"1:随時"かつ承諾時決済タイプが"0:承諾のみ"

accountingType
string
Default: "0"
Enum: "1" "0"

課金種別

利用する決済方法の課金種別を指定

0 : 都度(デフォルト値)

1 : 随時

※未指定の場合、"0"都度になります。

consentAuthType
string
Default: "0"
Enum: "1" "0"

承諾時決済タイプ

0 : 承諾のみ(デフォルト値)

1 : 承諾同時決済

※課金種別が"1:随時"以外の場合、当項目は設定不可(null)となります。

※未設定の場合は"0:承諾のみ"になります。

withCapture
string
Default: "false"
Enum: "true" "false"

与信同時売上フラグ

true : 与信同時売上

false : 与信のみ(デフォルト値)

※未指定の場合、"false:与信のみ"になります。

※以下の場合、当項目は設定不可(null)となります。

課金種別が"1:随時" かつ承諾時決済タイプが"0:承諾のみ"

successUrl
string <= 256 characters

決済成功URL

半角英数字記号 256桁以内

決済成功時の戻り先となるURL

cancelUrl
string <= 256 characters

決済キャンセルURL

半角英数字記号 256桁以内

決済キャンセル時の戻り先となるURL

pushUrl
string <= 256 characters

PUSH通知URL

半角英数字記号 256桁以内

決済結果を応答するPush通知先URL

useDeliveryAddress
string
Default: "false"
Enum: "true" "false"

配送先情報フラグ

true : メルペイより配送先情報必要

false : メルペイより配送先情報不要

※未指定の場合、「false : メルペイより配送先情報不要」になります。

※配送先情報の詳細は6.3.1個人情報(配送先情報・購入者情報)の要求についてを参照

useBuyerInfo
string
Enum: "true" "false"

購入者情報フラグ

true : メルペイより購入者情報必要

false : メルペイより購入者情報不要

※未指定の場合、「false : メルペイより購入者情報不要」になります。

購入者情報の詳細は6.3.1個人情報(配送先情報・購入者情報)の要求についてを参照

preapprovedServiceName
string <= 20 characters

提供サービス名

全半角かな英数字記号 20桁以内

提供サービス名を指定

※課金種別が0 : 都度の場合設定不可

課金種別が1 : 随時"の場合設定必須

preapprovedServiceDescription
string <= 120 characters

提供サービス説明

全半角かな英数字記号120桁以内

提供サービス説明を指定

※課金種別が0 : 都度の場合設定不可

課金種別が"1 : 随時の場合設定必須

userAgent
string <= 1000 characters

ユーザエージェント

半角英数字記号 1000桁以内

決済を行うユーザの端末のUserAgentを指定。

※指定していない場合、決済処理開始時と完了時でのブラウザの違いが発生する可能性があります。

name
string <= 40 characters

商品名

全半角かな英数字記号 40桁以内

商品の名称

  • 課金種別="0"（都度決済）でのみ指定可能
description
string <= 1000 characters

商品説明

全半角かな英数字記号 1000桁以内

商品に対する説明文

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl1
string <= 2000 characters

商品画像URL1

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl2
string <= 2000 characters

商品画像URL2

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl3
string <= 2000 characters

商品画像URL3

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl4
string <= 2000 characters

商品画像URL4

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl5
string <= 2000 characters

商品画像URL5

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl6
string <= 2000 characters

商品画像URL6

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl7
string <= 2000 characters

商品画像URL7

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl8
string <= 2000 characters

商品画像URL8

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
imageUrl9
string <= 2000 characters

商品画像URL9

半角英数字記号 2000桁以内

商品の画像URL

  • 課金種別="0"（都度決済）でのみ指定可能
category
string <= 40 characters

カテゴリ名

全半角かな英数字記号 40桁以内

商品のカテゴリ名

  • 課金種別="0"（都度決済）でのみ指定可能
size
string <= 20 characters

サイズ

全半角かな英数字記号 20桁以内

商品のサイズ

  • 課金種別="0"（都度決済）でのみ指定可能
brand
string <= 40 characters

ブランド名

全半角かな英数字記号 40桁以内

商品のブランド

  • 課金種別="0"（都度決済）でのみ指定可能
color
string <= 32 characters

色

全半角かな英数字記号 32桁以内

商品の色

  • 課金種別="0"（都度決済）でのみ指定可能
listPrice
string <= 7 characters ^[0-9]{1,7}$

定価

商品の定価

1～1000000の間で指定できます。

  • 課金種別="0"（都度決済）でのみ指定可能
unitPrice
string <= 7 characters ^[0-9]{1,7}$

購入時価格

商品購入時に値引きなどが入った場合、値引き後の商品価格です。

1～1000000の間で指定できます。

  • 課金種別="0"（都度決済）でのみ指定可能
quantity
string <= 7 characters ^[0-9]{1,7}$

購入数

購入された商品の総数

1～1000000の間で指定できます。

  • 課金種別="0"（都度決済）でのみ指定可能
itemCode
string <= 128 characters

製品管理コード(SKU)

半角英数字記号 128桁以内

JAN コードを発行している製品はJANコードを入れてください。

JAN コードがない場合は内部で製品を管理する際に利用されている製品管理コードの送付となります。

  • 課金種別="0"（都度決済）でのみ指定可能
janCode
string <= 13 characters ^[a-zA-Z0-9]{1,13}$

JANコード

半角英数字 13桁以内

JANコードがある場合、製品管理コードと同様のJAN コード

  • 課金種別="0"（都度決済）でのみ指定可能
categoryId
required
string <= 4 characters ^[a-zA-Z0-9]{1,4}$

商品カテゴリID

商品カテゴリを示すＩＤ

詳細は6.3.2商品カテゴリID 一覧を参照

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

取消

取消

詳細は ID決済 メルペイ インターフェース詳細 5.1.3 取消 MerpayCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

都度決済 : 決済申込時の取引IDを指定

随時決済 : 決済申込時、または再与信時の取引ID を指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online"：オンライン決済

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細は ID決済 メルペイ インターフェース詳細 5.1.4 売上 MerpayCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

都度決済 : 決済申込時の取引IDを指定

随時決済 : 決済申込時、または再与信時の取引ID を指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online"：オンライン決済

amount
required
string <= 7 characters ^[0-9]{1,7}$

売上金額

売上金額を指定

1～1000000の間で指定できます。

売上時に金額を指定することで決済全額の一部での売上確定(部分売上)が可能です

※未設定の場合、全額売上となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金

返金

詳細は ID決済 メルペイ インターフェース詳細 5.1.5 返金 MerpayRefundRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

都度決済 : 決済申込時の取引IDを指定

随時決済 : 決済申込時、または再与信時の取引ID を指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online"：オンライン決済

amount
string <= 7 characters ^[0-9]{1,7}$

返金金額

返金金額を指定

1～1000000の間で指定できます。

返金時に金額を指定することで決済全額の一部を返金(部分返金)が可能です。

※未設定の場合、全額返金となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

再与信

再与信

詳細は ID決済 メルペイ インターフェース詳細 5.1.6 再与信 MerpayReAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId(取引ID)について」参照

originalOrderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

元取引ID

随時決済の決済申込時に指定した取引ID を指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online"：オンライン決済

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額を指定

1～1000000の間で指定できます。

withCapture
string
Default: "false"
Enum: "true" "false"

与信同時売上フラグ

true : 与信同時売上

false : 与信のみ(デフォルト値)

※未指定の場合、「"false":与信のみ」になります。

categoryId
required
string <= 4 characters ^[a-zA-Z0-9]{1,4}$

商品カテゴリID

商品カテゴリを示すＩＤ

詳細は6.3.2商品カテゴリID 一覧を参照

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

解約

解約

詳細は ID決済 メルペイ インターフェース詳細 5.1.7 解約 MerpayTerminateRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

随時決済の決済申込時に指定した取引IDを指定

serviceOptionType
required
string
Value: "online"

サービスオプションタイプ

利用する決済方法のタイプを指定

"online"：オンライン決済

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

ファミペイ

申込

申込

詳細は ID決済 ファミペイ インターフェース詳細 5.1.1 申込 CvspayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
object
orderId
required
string <= 27 characters ^[a-zA-Z0-9]{1,27}$

取引ID

店舗側で採番した取引IDを指定

※決済事業者にこの項目を連携するため、他決済サービスと異なる「書式・制限」になります。

serviceOptionType
required
string
Value: "famipay"

サービスオプションタイプ

利用するサービスオプションタイプを指定

famipay : ファミペイ

amount
required
string <= 8 characters ^[0-9]{1,8}$

決済金額

決済金額(合計金額)を指定

withCapture
string
Default: "true"
Value: "true"

売上フラグ

true : 与信同時売上

※指定が無い場合は、与信同時売上となります。

payType
string <= 1 characters
Default: "0"
Value: "0"

決済種別

決済種別を指定

0 : オンライン決済

※指定が無い場合は、オンライン決済となります。

successUrl
string <= 256 characters

決済完了時URL

URLに使用可能な半角文字256桁以内

決済成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant AdministratorPortal)から登録申請した値を使用。

cancelUrl
string <= 256 characters

決済キャンセル時URL

URLに使用可能な半角文字256桁以内

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant AdministratorPortal)から登録申請した値を使用。

errorUrl
string <= 256 characters

決済エラー時URL

URLに使用可能な半角文字256桁以内

決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant AdministratorPortal)から登録申請した値を使用。

pushUrl
string <= 256 characters

プッシュURL

URLに使用可能な半角文字256桁以内

「ダミー取引」時の決済申込完了通知を受信するURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant AdministratorPortal)から登録申請した値を使用。

※本パラメータは店舗側システムの開発時にのみ利用されることを想定しており、ダミー取引で指定可能です。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {},
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

取消

取消

詳細は ID決済 ファミペイ インターフェース詳細 5.1.3 取消 CvspayCancelRequestDto をご確認ください

Request Body schema: application/json
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId(取引ID)について」を参照

serviceOptionType
required
string
Value: "famipay"

サービスオプションタイプ

利用するサービスオプションタイプを指定

famipay : ファミペイ

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

Amazon Pay

与信

申込

詳細はインターフェース詳細(Amazone Pay) AmazonpayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

上記「orderId(取引ID)について」参照　

accountingType
string <= 1 characters
Default: "0"
Enum: "1" "0"

課金種別

0 : 都度決済

1 : 随時決済

※未指定の場合は、"0"：都度決済となります。

consentAuthType
string <= 1 characters
Enum: "1" "0"

承諾時決済タイプ

0 : 承諾のみ

1 : 与信＋承諾

※課金種別が都度決済の場合は指定できません。

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

amount
required
string <= 8 characters ^[0-9]{1,8}$

決済金額

決済金額を指定

  • 都度決済 : 1～10000000の間

  • 随時決済 : 1～100000の間

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

true : 与信同時売上

false : 与信のみ

※未指定の場合は、"false"：与信のみとなります。

suppressShippingAddressView
string
Enum: "true" "false"

配送先表示抑止フラグ

消費者がAmazon Pay の提供する画面上で配送先を選択するかどうかを制御します。

true : 配送先非表示

false : 配送先表示

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

noteToBuyer
string <= 255 characters

注文説明

文字列255byte以内

購入者のメールに表示される注文の説明

successUrl
string <= 256 characters

完了時URL

URLに使用可能な半角文字256桁以内

決済申込成功時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelUrl
string <= 256 characters

キャンセル時URL

URLに使用可能な半角文字256桁以内

決済申込を消費者がキャンセルした時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

※本番取引の場合、HTTPS プロトコルを設定する必要があります。

errorUrl
string <= 256 characters

エラー時URL

URLに使用可能な半角文字256桁以内

決済申込エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

authorizePushUrl
string <= 256 characters

与信時プッシュ先URL

URLに使用可能な半角文字256桁以内

※localhostを含むURLは指定不可

決済申込、再与信要求および与信変更要求が成立(成功または失敗)した時に、結果通知電文をプッシュする先のURL を指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

capturePushUrl
string <= 256 characters

売上時プッシュ先URL

URLに使用可能な半角文字256桁以内

※localhostを含むURLは指定不可

売上要求の処理結果が確定(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelPushUrl
string <= 256 characters

キャンセル時プッシュ先URL

URLに使用可能な半角文字256桁以内

※localhostを含むURLは指定不可

キャンセル要求、返金要求および解約要求の処理結果が確定(成功または失敗)した時と、Amazon Payから抹消通知を受信した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

frequencyUnit
string
Enum: "Year" "Month" "Week" "Day"

頻度(単位)

随時決済の頻度の単位(例:2週間毎であれば、単位はWeek、値は2)

Year : 年

Month : 月

Week : 週

Day : 日

※課金種別が都度決済の場合は指定できません。

※課金種別が随時決済の場合は指定必須です。

※6-4をご参照の上ご利用ください。

frequencyValue
string <= 3 characters ^[0-9]{1,3}$

頻度(値)

随時決済の頻度の値(例：2週間毎であれば、単位はWeek、値は2)

  • 頻度(単位)毎に設定できる範囲が異なります。

Year : 1のみ

Month : 1～12

Week : 1～52

Day : 1～365

※課金種別が都度決済の場合は指定できません。

※課金種別が随時決済の場合は指定必須です。

※6-4をご参照の上ご利用ください。

addressRestrictions
string <= 4000 characters

配送先制限リスト

文字列4,000字以内

配送先を制限するための許可リストまたは禁止リスト。

  • リストには下記内容をJSON形式で指定する必要があります。
{
    "type": "【Allowed】",
    "restrictions": {
        "【countryCode】": {
            "statesOrRegions": [
                "【AA】"
            ],
            "zipCodes": [
                "【999-9999】",
                "【999-9999】"
            ]
        },
        "【countryCode】": {
            "statesOrRegions": [
                "【AA】"
            ],
            "zipCodes": [
                "【999-9999】",
                "【999-9999】"
            ]
        }
    }
}

※【】で括られた部分は下記に従い適切な値を設定

"type" : Allowed(許可) NotAllowed(禁止)

"countryCode" : 国名コード(日本:JP,アメリカ:US 等のISO3166準拠コード)

"statesOrRegions" : 都道府県等の地域名、アメリカは2桁の州略号(WA, CA, IL...)

"zipCodes" : 郵便番号、日本の場合は 999-9999

例：東京都および東京以外の特定の郵便番号の地域のみ配送可能とする場合

{
    "type": "Allowed",
    "restrictions": {
        "JP": {
            "statesOrRegions": [
                "東京都"
            ],
            "zipCodes": [
                "260-8667"
            ]
        }
    }
}

※配送先の都道府県には通常"千葉県","東京都"といった値が設定されますが、

消費者の入力次第で「東京」「Tokyo-to」などの文字が設定されることもあります。

上記の例では「東京」「Tokyo-to」といった"東京都"以外の表記は許可されなくなりますのでご注意ください。

payConfirmScreenType
string <= 1 characters
Enum: "1" "0"

決済確認画面種別

0 : 決済サーバー決済確認画面利用

1 : 加盟店決済確認画面利用

※未指定の場合は、"0"：決済サーバー決済確認画面利用となります。

payConfirmScreenUrl
string <= 256 characters

決済確認画面URL

URLに使用可能な半角文字256桁以内

決済確認画面への遷移時に、店舗側サイトに画面遷移を戻すためのURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用。

※未指定かつMAP(Merchant Administrator Portal)から登録申請した値が存在しない場合はエラーとなります。

※決済確認画面種別が"1"：加盟店決済確認画面利用の場合のみ、指定可能。

※本番取引の場合、HTTPS プロトコルを設定する必要があります。

extendExpiration
string
Default: "false"
Enum: "true" "false"

与信期限延長フラグ

課金種別が都度決済の場合に、ChargePermissionの有効期限を180日から13ヶ月に延長するか指定

true : 延長する

false : 延長しない

※未指定の場合は、"false"：延長しないとなります。

※オーソリの有効期限30日を延長するわけではありません。

「与信変更」コマンドを行える期間が180日から13ヶ月に延長されることとなります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細はインターフェース詳細(Amazone Pay) AmazonpayCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayCaptureRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

都度決済：決済申込時の取引IDを指定

随時決済：決済申込時、または再与信時の取引ID を指定

amount
string <= 8 characters ^[0-9]{1,8}$

売上金額

与信時に設定した決済金額以下を指定

1～決済金額の間で指定できます。

※未指定の場合は、与信時に設定した決済金額が売上金額となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

申込キャンセル

申込キャンセル

詳細はインターフェース詳細(Amazone Pay) AmazonpayCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayCancelRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

  • 都度決済 : 決済申込時の取引IDを指定

  • 随時決済 : 決済申込時、または再与信時の取引ID を指定

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金

返金

詳細はインターフェース詳細(Amazone Pay) AmazonpayRefundRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayRefundRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

  • 都度決済 : 決済申込時の取引IDを指定

  • 随時決済 : 決済申込時、または再与信時の取引ID を指定

amount
string <= 8 characters ^[0-9]{1,8}$

返金金額

返金金額を指定。

※未指定時は、返金可能金額全額

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

住所情報取得

住所情報取得

詳細はインターフェース詳細(Amazone Pay) AmazonpayGetAddressRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayGetAddressRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

  • 都度決済 : 決済申込時の取引IDを指定

  • 随時決済 : 決済申込時、または再与信時の取引ID を指定

addInfoRespFlag
string <= 1 characters
Default: "0"
Enum: "1" "0"

追加情報応答フラグ

応答電文に追加情報を含めるかどうかのフラグ

0 : 含めない

1 : 含める

※未指定の場合、"0": 含めないを設定する

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

再与信

再与信

詳細はインターフェース詳細(Amazone Pay) AmazonpayReAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayReAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

上記「orderId(取引ID)について」参照　

originalOrderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

元取引ID

随時決済の決済申込時の取引ID

amount
string <= 6 characters ^[0-9]{1,6}$

決済金額

決済金額を指定

1～100000の間で指定できます。

withCapture
string <= 0 characters
Default: "false"
Enum: "true" "false"

売上フラグ

true : 与信同時売上

false : 与信のみ

※未指定の場合は、false：与信のみとなります。

noteToBuyer
string <= 255 characters

注文説明

文字列255byte以内

購入者のメールに表示される注文の説明

※未指定の場合、元取引で設定された値が使用されます。

authorizePushUrl
string <= 256 characters

与信時プッシュ先URL

URLに使用可能な半角文字256桁以内

※localhostを含むURLは指定不可

再与信要求が成立(成功または失敗)した時に、結果通知電文をプッシュする先のURL を指定(クエリパラメータ指定可)

※未指定の場合は、元取引の与信時プッシュ先URL を使用。

元取引側も未指定の場合はMAP(Merchant Administrator Portal)から登録申請した値を使用。

capturePushUrl
string <= 256 characters

売上時プッシュ先URL

URLに使用可能な半角文字256桁以内

※localhostを含むURLは指定不可

売上要求の処理結果が確定(成功または失敗)した時に、結果通知電文をプッシュする先のURLを指定(クエリパラメータ指定可)

※未指定の場合は、元取引の売上時プッシュ先URL を使用。

元取引側も未指定の場合はMAP(Merchant Administrator Portal)から登録申請した値を使用。

cancelPushUrl
string <= 256 characters

キャンセル時プッシュ先URL

URLに使用可能な半角文字256桁以内

※localhostを含むURLは指定不可

キャンセル要求、返金要求の処理結果が確定(成功または失敗)した時に、結果通知電文をプッシュする先のURL を指定(クエリパラメータ指定可)

※未指定の場合は、元取引のキャンセル時プッシュ先URL を使用。

元取引側も未指定の場合はMAP(Merchant Administrator Portal)から登録申請した値を使用。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

解約

解約

詳細はインターフェース詳細(Amazone Pay) AmazonpayTerminateRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayTerminateRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

随時決済の決済申込時の取引IDを指定

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

承諾情報更新

承諾情報更新

詳細はインターフェース詳細(Amazone Pay) AmazonpayUpdateConsentRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayUpdateConsentRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

随時決済の決済申込時の取引IDを指定

amount
string <= 6 characters ^[0-9]{1,8}$

決済金額

変更後の決済金額を指定

1～100000の間で指定できます。

※未指定の場合、更新されません。

frequencyUnit
string
Enum: "Year" "Month" "Week" "Day"

頻度(単位)

変更後の随時決済の頻度の単位(例：2週間毎であ

れば、単位はWeek、値は2)

Year : 年

Month : 月

Week : 週

Day : 日

※頻度(値)を設定した場合は設定が必須となります。

frequencyValue
string <= 3 characters ^[0-9]{1,3}$

頻度(値)

変更後の随時決済の頻度の値(例:2週間毎であれば、単位はWeek、値は2)

  • 頻度(単位)毎に設定できる範囲が異なります。

Year : 1のみ

Month : 1～12

Week : 1～52

Day : 1～365

※頻度(単位)を設定した場合は設定が必須となります。

noteToBuyer
string <= 255 characters

注文説明

文字列255byte以内

変更後の購入者のメールに表示される注文の説明

再与信要求時に未指定だった場合のデフォルト値が、随時決済の決済申込時に設定した値から指定した値に更新されます。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

与信変更

与信変更

詳細はインターフェース詳細(Amazone Pay) AmazonpayUpdateAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

AmazonpayUpdateAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

都度決済の決済申込時の取引IDを指定

amount
string <= 8 characters ^[0-9]{1,8}$

決済金額

変更後の決済金額を指定

指定できる金額の上限は、「70000円か最初の与信時の金額の900%のうち高い方-現在の与信金額」となります。

(最大で10000000円が上限となります)

例：

最初に100円で与信した場合70000-100=69900円

最初に10000円で与信した場合90000-10000=80000円

※未指定の場合、現在の決済金額で与信の取り直しを行います。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

PayPal

申込

与信

詳細は ID決済 PayPal インターフェース詳細 2.2.1 与信 PaypalAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
actionがsetの場合 (object) or actionがgetの場合 (object) or actionがdoの場合 (object)
One of
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「orderId(取引ID)について」参照

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額

日本円

※日本円で1,000,000円を上限とした金額を指定します。

action
required
string
Value: "set"

アクションタイプ

set : 与信請求処理

returnUrl
required
string <= 1024 characters

戻り先URL

消費者がPayPal 上での操作が完了したときの遷移する店舗サイトのURL を指定

URL として使用できる文字も使用可能です。

cancelUrl
required
string <= 1024 characters

取消URL

消費者がPayPal 上で支払いをキャンセルした場合に遷移する店舗サイトのURL を指定

URL として使用できる文字も使用可能です。

headerImageUrl
string <= 127 characters

ヘッダーイメージURL

PayPal画面のヘッダーに表示する画像のURLを指定

画像サイズは最大750pixel×90pixelです。

URL として使用できる文字も使用可能です。

orderDescription
string <= 127 characters

オーダー説明

文字列127バイト以内

商品の説明を指定

※文字コードは"UTF-8"です。

shippingFlag
required
string <= 1 characters
Enum: "0" "1" "2"

配送先フラグ

要求電文(PaypalAuthorizeRequestDto)の配送先情報(※1)をPayPalへ連携するか否かを指定

また、配送先情報を連携しない場合は、消費者のPayPal アカウントに登録されている自宅住所等の情報を利用するか否かを指定します。

shippingFlag:配送先情報の連携について

shippingFlag 配送先情報の連携について
"0" 「配送先の設定を連携しない」
要求電文(PaypalAuthorizeRequestDto)の配送先情報(※1)はPayPal へ連携されません。
消費者がPayPal アカウントを保持している場合、消費者のPayPal アカウントに設定されている自宅住所等の情報がPayPal チェックアウト画面に表示されます。
"1" 「配送先の設定を連携する」
要求電文(PaypalAuthorizeRequestDto)の配送先情報(※1)がPayPal へ連携されます。
本フラグに"1"を指定した場合、配送先情報(※1)の設定が必須となります。(任意項目を除く)
PayPal へ連携された配送先情報がPayPal チェックアウト画面に表示されます。
"2" 「配送先の設定を連携・表示しない」
要求電文(PaypalAuthorizeRequestDto)の配送先情報(※1)はPayPal へ連携されません。
消費者がPayPal アカウントを保持している場合でも、消費者のPayPal アカウントに設定されている自宅住所等の情報はPayPal チェックアウト画面に表示されません。

※1:要求電文(PaypalAuthorizeRequestDto)の配送先情報

配送先氏名(shipName)、配送先住所１(shipStreet1)、配送先住所２(shipStreet2)、配送先市区町村名(shipCity)、配送先州名(shipState)、配送先国コード(shipCountry)、配送先郵便番号(shipPostalCode)、配送先電話番号(shipPhone)

shipName
string <= 32 characters

配送先氏名

文字列32バイト以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipStreet1
string <= 100 characters

配送先住所１

文字列100バイト以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipStreet2
string <= 100 characters

配送先住所２

文字列100バイト以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は任意項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipCity
string <= 40 characters

配送先市区町村名

文字列40バイト以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipState
string <= 40 characters

配送先州名

文字列40バイト以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipCountry
string <= 2 characters ^[a-zA-Z0-9]{1,2}$

配送先国コード

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipPostalCode
string <= 20 characters ^[0-9a-zA-Z\-]{1,20}$

配送先郵便番号

半角英数字のほかに、"-"(ハイフン)も使用可能

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipPhone
string <= 20 characters ^[0-9a-zA-Z\-]{1,20}$

配送先電話番号

半角英数字のほかに、"-"(ハイフン)も使用可能

※shippingFlag="1"の場合は任意項目

※ShippingFlag="0"または"2"の場合は設定不可項目

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
Example
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細は ID決済 PayPal インターフェース詳細 2.3.1 売上 PaypalCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
actionがsetの場合 (object) or actionがgetの場合 (object) or actionがdoの場合 (object) or actionがcaptureの場合 (object)
One of
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、予信完了時に採番した取引ID を指定

amount
required
string <= 7 characters ^[0-9]{1,7}$

取引金額

日本円

※日本円で1,000,000円を上限とした金額を指定します。

action
required
string <= 0 characters
Value: "set"

アクションタイプ

set : 売上請求処理

returnUrl
required
string <= 1024 characters

戻り先URL

消費者がPayPal 上での操作が完了したときの遷移する店舗サイトのURL を指定

URL として使用できる文字も使用可能です。

cancelUrl
required
string <= 1024 characters

取消URL

消費者がPayPal 上で支払いをキャンセルした場合に遷移する店舗サイトのURL を指定

URL として使用できる文字も使用可能です。

headerImageUrl
string <= 127 characters

ヘッダーイメージURL

PayPal 画面のヘッダーに表示する画像のURL を指定

画像サイズは最大750pixel×90pixel です。

URL として使用できる文字も使用可能です。

orderDescription
string <= 127 characters

オーダー説明

文字列127Byte以内

商品の説明を指定

※文字コードは"UTF-8"です。

shippingFlag
required
string <= 1 characters
Enum: "0" "1" "2"

配送先フラグ

要求電文(PaypalCaptureRequestDto)の配送先情報(※1)をPayPal へ連携するか否かを指定

また、配送先情報を連携しない場合は、消費者のPayPal アカウントに登録されている自宅住所等の情報を利用するか否かを指定します。

shippingFlag 配送先情報の連携について
"0" 「配送先の設定を連携しない」
要求電文(PaypalCaptureRequestDto)の配送先情報(※1)はPayPal へ連携されません。
消費者がPayPal アカウントを保持している場合、消費者のPayPal アカウントに設定されている自宅住所等の情報がPayPal チェックアウト画面に表示されます。
"1" 「配送先の設定を連携する」
要求電文(PaypalCaptureRequestDto)の配送先情報(※1)がPayPal へ連携されます。
本フラグに"1"を指定した場合、配送先情報(※1)の設定が必須となります。
PayPal へ連携された配送先情報がPayPal チェックアウト画面に表示されます。
"2" 「配送先の設定を連携・表示しない」
要求電文(PaypalCaptureRequestDto)の配送先情報(※1)はPayPal へ連携されません。
消費者がPayPal アカウントを保持している場合でも、消費者のPayPal アカウントに設定されている自宅住所等の情報はPayPal チェックアウト画面に表示されません。

※1:要求電文(PaypalCaptureRequestDto)の配送先情報

配送先氏名(shipName)、配送先住所１(shipStreet1)、配送先住所２(shipStreet2)、配送先市区町村名(shipCity)、配送先州名(shipState)、配送先国コード(shipCountry)、配送先郵便番号(shipPostalCode)、配送先電話番号(shipPhone)

shipName
string <= 32 characters

配送先氏名

文字列32Byte以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipStreet1
string <= 100 characters

配送先住所１

文字列100Byte 以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipStreet2
string <= 100 characters

配送先住所２

文字列100Byte 以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は任意項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipCity
string <= 40 characters

配送先市区町村名

文字列40Byte以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipState
string <= 40 characters

配送先州名

文字列40Byte以内

※文字コードは"UTF-8"

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipCountry
string <= 2 characters ^[a-zA-Z0-9]{1,2}$

配送先国コード

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipPostalCode
string <= 20 characters ^[0-9a-zA-Z\-]{1,20}$

配送先郵便番号

全角文字を除く文字列を設定

※shippingFlag="1"の場合は必須項目

※ShippingFlag="0"または"2"の場合は設定不可項目

shipPhone
string <= 20 characters ^[0-9a-zA-Z\-]{1,20}$

配送先電話番号

全角文字を除く文字列を設定

※shippingFlag="1"の場合は任意項目

※ShippingFlag="0"または"2"の場合は設定不可項目

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
Example
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は ID決済 PayPal インターフェース詳細 2.5.1 キャンセル PaypalCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object

PaypalCancelRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、与信完了時に採番した取引ID

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金

返金

詳細は ID決済 PayPal インターフェース詳細 2.6.1 返金 PaypalRefundRequestDto をご確認ください

Request Body schema: application/json
required
required
object

PaypalRefundRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、与信完了時に採番した取引ID

amount
required
string <= 7 characters ^[0-9]{1,7}$

取引金額

返金する金額を指定 ※一部キャンセルも可能

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

エポスかんたん決済

与信

決済申込 与信/与信+売上

詳細はインターフェース詳細(エポスかんたん決済) EposAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗側で採番した取引IDを指定

amount
required
string <= 8 characters ^[0-9]{1,8}$

決済金額

決済金額(合計金額)を指定

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

true : 与信・売上

false : 与信のみ (デフォルト値)

※ 指定が無い場合は、与信のみとなります。

customerId
required
string <= 32 characters ^[0-9a-zA-Z\\.\\-\_\%\/\=\&\?\:\,\#]{1,32}$

加盟店顧客ID

店舗側サイトにて該当顧客を一意に識別するID。

以下の記号が使用可能です。

"."(ピリオド)、","(カンマ)、"/"(スラッシュ)、":"(コロン)、

"_"(アンダースコア)、"?"(疑問符)、"&"(アンパサンド)、

"#"(シャープ)、"%"(パーセント)、"="(イコール)、"-"(ハイフン)

successUrl
string <= 256 characters

決済完了時URL

URLに使用可能な半角文字 256桁以内

決済成功時に、店舗側サイトに画面遷移を戻すためのURLを指定

(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用

※本パラメータ、もしくはMAP からの登録が必須となります。

cancelUrl
string <= 256 characters

決済キャンセル時URL

URLに使用可能な半角文字 256桁以内

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定

(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用

※本パラメータ、もしくはMAP からの登録が必須となります。

errorUrl
string <= 256 characters

決済エラー時URL

URLに使用可能な半角文字 256桁以内

決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定

(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用

※本パラメータ、もしくはMAP からの登録が必須となります。

pushUrl
string <= 256 characters

プッシュURL

URLに使用可能な半角文字 256桁以内

プッシュURLを指定(クエリパラメータ指定可)

※未指定の場合は、MAP(Merchant Administrator Portal)から登録申請した値を使用

※本パラメータ、もしくはMAP からの登録が必須となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {},
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細はインターフェース詳細(エポスかんたん決済) EposCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

売上対象の取引IDを指定

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細はインターフェース詳細(エポスかんたん決済) EposCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId(取引ID)について」参照　

amount
string <= 8 characters ^[0-9]{1,8}$

減額金額

減額する金額を指定。

※売上(与信同時売上)実施後の場合、指定できる金額は"消費者がエポスの画面で入力したクレジット利用額"まで、もしくは全額になります。

※未指定時は全額キャンセルとなります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

銀聯(UPOP)

与信

与信

詳細は ID決済 銀聯(UPOP) インターフェース詳細 2.2.1 与信 UpopAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

UpopAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId(取引ID)について」参照

amount
required
string <= 12 characters ^[0-9]{1,12}$

決済金額

決済金額(日本円)

1以上999,999,999,999以下

withCapture
string
Default: "false"
Enum: "true" "false"

売上フラグ

true : 与信・売上

false : 与信のみ

※ 指定が無い場合は、デフォルト値(与信のみ)が指定されます。

termUrl
required
string <= 256 characters

決済結果戻り先URL

URLに使える文字256桁以内

決済完了後に、店舗側へ遷移を戻すためのURL を指定

customerIp
required
string <= 40 characters ^((\d{1,3}\.){3}\d{1,3}|([0-9a-fA-F]{1,4}\:){...

消費者IPアドレス

消費者側のIP アドレスを指定(例:111.111.111.111)

※IPV6の形式も対応しています。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細は ID決済 銀聯(UPOP) インターフェース詳細 2.4.1 売上 UpopCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object

UpopCaptureRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、与信完了時に採番した取引ID

amount
required
string <= 12 characters ^[0-9]{1,12}$

決済金額

決済金額(日本円)

与信時に設定した金額以下、かつ1以上999,999,999,999以下

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は ID決済 銀聯(UPOP) インターフェース詳細 2.5.1 キャンセル UpopCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object

UpopCancelRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、与信・売上完了時に採番した取引ID

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金

返金

詳細は ID決済 銀聯(UPOP) インターフェース詳細 2.6.1 返金 UpopRefundRequestDto をご確認ください

Request Body schema: application/json
required
required
object

UpopRefundRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、売上完了時に採番した取引ID

amount
required
string <= 12 characters ^[0-9]{1,12}$

決済金額

返金金額(日本円)

※一部キャンセルも可能

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

Alipay

与信同時売上

与信同時売上

詳細は ID決済 Alipay インターフェース詳細 2.2.1 与信同時売上 AlipayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
オンライン決済 (object)
One of
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1 共通」の 「orderId(取引ID)について」を参照

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額を日本円または中国元で指定。

ただし、中国元(CNY)換算で上限金額は

オンライン決済の場合 : 300,000元

バーコード決済の場合 : 300,000元

また、通貨に中国元を指定する場合、amount には取引金額を100倍した値を指定します。(amount=決済金額×100)

(例 日本円:1円の場合は1を指定します。

中国元:1.99元の場合は199を指定します。)

currency
required
string
Enum: "JPY" "CNY"

通貨

JPY : 日本円

CNY : 中国元(オンライン決済のみ)

successUrl
required
string <= 256 characters

決済完了後戻りURL

URLに使える文字256桁以内

決済が成功した場合に、店舗側へ遷移を戻す為のURL を指定

errorUrl
required
string <= 256 characters

決済エラー時戻りURL

URLに使える文字256桁以内

決済が失敗した場合に、店舗側へ遷移を戻す為のURL を指定

commodityName
required
string <= 100 characters

商品名

文字列100桁以内

商品名を指定

この情報はオンライン決済ではAlipay の決済ページに表示され、バーコード決済(店舗スキャン型／消費者スキャン型)では購入履歴に表示されます。

commodityDescription
string <= 200 characters

商品詳細

文字列200桁以内

商品の詳細を指定

この情報はAlipay の決済ページに表示されます。

※バーコード決済(消費者スキャン型)で、この項目を指定する場合は、「商品ID(commodityId)」の指定が必須となります。

withCapture
string
Default: "true"
Value: "true"

売上フラグ

true : 与信・売上(設定可能な値はtrueのみです)

※設定しない場合のデフォルト値は"true"です。

payType
string
Default: "0"
Value: "0"

決済種別

決済種別を指定

0 : オンライン決済

※未指定の場合は、"0"：オンライン決済

deviceType
string <= 1 characters
Default: "0"
Enum: "0" "1"

デバイスタイプ

デバイスタイプを指定

0 : PC

1 : スマートフォン

※payType が"0":オンライン決済の場合に有効

※未指定の場合は、0 : PC

※このパラメータを指定することで消費者の利用環境に応じて画面表示を変更することが可能となります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金申込

返金申込

詳細は ID決済 Alipay インターフェース詳細 2.4.1 返金申込 AlipayRefundRequestDto をご確認ください

Request Body schema: application/json
required
required
オンライン決済 (object)
One of
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求、与信完了時に採番した取引IDを指定

amount
required
string <= 7 characters ^[0-9]{1,7}$

取引金額

返金する金額を指定

※一部キャンセルも可能

返金における通貨は、与信同時売上の時に指定した通貨と同じものを指定します。

※中国元の場合に指定する値は、与信同時売上時と同様、取引金額を100倍した値を指定してください。

※バーコード決済の場合は、返金時に中国元は指定できません。

※返金時の為替レートは、購入時のレートが適用されます。

reason
required
string <= 80 characters

理由

文字列80桁以内

返金の理由を指定

返金理由は、Alipay が提供している消費者向けの管理画面に表示されます。

返金理由は、中国語または英語での指定を推奨します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャリア決済

申込

申込

詳細は キャリア決済 インターフェース詳細 2.1.1 申込 CarrierAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
d払い (object) or auかんたん決済 (object) or ソフトバンクまとめて支払い(B) (object) or ソフトバンクまとめて支払い(A) (object) or フレッツまとめて支払い (object)
One of
orderId
required
string (schemas-orderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1共通」の「orderId(取引ID)について」を参照

serviceOptionType
required
string
Value: "docomo"

サービスオプションタイプ

利用するキャリア決済のタイプを指定

docomo : d払い

amount
string (amount) <= 12 characters ^[0-9]{1,12}$

決済金額

キャリア毎に上限金額が規定されています。

詳細は『キャリア決済サービス 補足資料』を参照下さい。

  • 都度決済 : 指定必須
  • 継続課金 : 「ソフトバンクまとめて支払い（A）」の場合は、キャリアへのサービス申請時に設定した金額のみ指定可能
  • 随時決済 : 指定できません。
terminalKind
required
string (terminalKind_012)
Enum: "0" "1" "2"

端末種別

消費者が使用している端末の種別を指定

0: PC

1: スマートフォン

2: フィーチャーフォン ※都度決済と継続課金のみ利用可能

itemType
string (itemType_012)
Enum: "0" "1" "2"

商品タイプ

商品の種別を指定

※未指定の場合は、マーチャント登録申請時に設定した値を使用

0: デジタルコンテンツ

1: 物販

2: 役務

accountingType
required
string (accountingType_014)
Enum: "0" "1" "4"

都度/継続区分

都度決済、継続課金の種別を指定

0 : 都度決済

1 : 継続課金

4 : 随時決済

withCapture
string (withCapture)
Enum: "true" "false"

与信同時売上フラグ

  • 都度決済 : 売上フラグを指定
    • ※未指定の場合は、 "false"
      • true:与信同時売上
      • false:与信のみ
  • 継続課金 : 指定できません。
  • 随時決済 : 指定できません。
mpFirstDate
string (mpFirstDate) <= 8 characters ^[0-9]{8}$

初回課金年月日

  • 都度決済 : 指定できません。

  • 継続課金 : 初回課金の年月日を指定 YYYYMMDDの形式

    • 当日、または未来日付を指定可能(当日≦mpFirstDate≦180日後)

  • 随時決済 : 指定できません。

mpDay
string (mpDay) <= 2 characters ^[0-9]{1,2}$

継続課金日

  • 都度決済 : 指定できません。

  • 継続課金 : 初回課金年月日の翌月以降の毎月の課金日を"1"～"28"で指定

    • ※課金日が1桁の場合、先頭に0を付与するのも可(例"01")

    • ※月末(29日、30日、31日)を指定する場合は99を指定

  • 随時決済 : 指定できません。

itemId
string <= 15 characters ^[a-zA-Z0-9]{1,15}$

商品番号

商品またはサービスの管理用番号を指定

  • 都度決済 : 任意の値を指定
    • 半角英数字15バイト以下
  • 継続課金 : 任意の値を指定
    • 半角英数字15バイト以下
  • 随時決済 : 任意の値を指定
    • 半角英数字15バイト以下
itemInfo
string

商品情報

全角 ※機種依存文字は利用できません。

商品またはサービスの情報を指定

※機種依存文字については、「3.1.2機種依存文字について」を参照してください。

  • キャリアが提供する消費者向けコンテンツに表示される商品情報を指定して下さい。

    • 決済時の内容確認画面

    • ご利用明細画面

    • 購入 完了通知メール(レシートメール)

  • 最大20文字

successUrl
string (successUrl) <= 1024 characters

決済完了時URL

URLに使用可能な半角文字

1024桁以内

決済完了後に、店舗側サイトに画面遷移を戻すためのURLを指定

※未指定の場合は、マーチャント登録申請 時に設定 した値を使用

cancelUrl
string (cancelUrl) <= 1024 characters

決済キャンセル時URL

URLに使用可能な半角文字

1024桁以内

決済キャンセル時に、店舗側サイトに画面遷移を戻すためのURLを指定

※未指定の場合は、マーチャント登録 申請 時に設定した値を使用

errorUrl
string (errorUrl) <= 1024 characters

決済エラー時URL

URLに使用可能な半角文字

1024桁以内

決済エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定

※未指定の場合は、マーチャント登録 申請 時に設定した値を使用

pushUrl
string (pushUrl) <= 1024 characters

プッシュURL

URLに使用可能な半角文字

1024桁以内

プッシュ URLを指定

※未指定の場合は、マーチャント登録申請 時に設定した値を使用

※ダミー取引と都度決済、随時決済の本番取引で指定可能です(継続課金/随時決済の本番取引は指定不可) 。

openId
string (openId_DO) <= 256 characters ^[a-zA-Z0-9]{1,256}$

OpenID

キャリアより発行された消費者を識別するOpenIDを指定

OpenIDは、決済申込完了通知により決済サーバーから店舗側システムに連携します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上

売上

詳細は キャリア決済 インターフェース詳細 2.3.1 売上 CarrierCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
d払い (object) or au かんたん決済 (object) or ソフトバンクまとめて支払い(B) (object) or フレッツまとめて支払い (object)
One of
orderId
required
string (components-schemas-orderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

  • 都度決済 : 決済申込時に採番した取引ID

  • 継続課金 : 決済申込時に採番した取引ID

  • 随時決済 : 再与信時に採番した取引ID

serviceOptionType
required
string
Value: "docomo"

サービスオプションタイプ

利用するキャリア決済のタイプを指定

docomo : d 払い

captureMonth
string (captureMonth) <= 6 characters ^[0-9]{6}$

課金売上月

  • 都度決済 : 指定できません。

  • 継続課金 : 売上に失敗している過去の課金月か当月を指定

    YYYYMM形式

  • 随時決済：指定できません。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は キャリア決済 インターフェース詳細 2.4.1 キャンセル CarrierCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
d払い (object) or auかんたん決済 (object) or ソフトバンクまとめて支払い(B) (object) or フレッツまとめて支払い (object)
One of
orderId
required
string (components-schemas-orderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

  • 都度決済 : 決済申込時に採番した取引ID

  • 継続課金 : 決済申込時に採番した取引ID

  • 随時決済 : 再与信時に採番した取引ID

serviceOptionType
required
string
Value: "docomo"

サービスオプションタイプ

利用するキャリア決済のタイプを指定

docomo : d払い

cancelMonth
string (cancelMonth) <= 6 characters ^[0-9]{6}$

課金取消月

  • 都度決済 : 指定できません 。
  • 継続課金 : すでに処理済みの過去の課金月か、当月を指定 YYYYMM形式
  • 随時決済 : 指定できません。
amount
string (amount_do) <= 12 characters ^[0-9]{1,12}$

返金金額

  • 都度決済 : 返金する金額を指定。(決済申込時に設定した金額以下)
    • ※未指定時は全額取消となります。
    • ※売上が未成立の取引の場合は、全額のみ指定可です。
  • 継続課金 : 指定できません。
  • 随時決済 : 指定できません。
object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

継続課金終了

継続課金終了

詳細は キャリア決済 インターフェース詳細 2.5.1 継続課金終了 CarrierTerminateRequestDto をご確認ください

Request Body schema: application/json
required
required
d払い (object) or auかんたん決済 (object) or ソフトバンクまとめて支払い(B) (object) or ソフトバンクまとめて支払い(A) (object) or フレッツまとめて支払い (object)
One of
orderId
required
string (CarrierTerminateRequest_Common_components-schemas-orderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

  • 継続課金：決済申込時に採番した取引 IDを設定

  • 随時決済：決済申込時に採番した取引 IDを設定

serviceOptionType
required
string
Value: "docomo"

サービスオプションタイプ

利用するキャリア決済のタイプを指定

docomo : d払い

force
string
Default: false
Enum: "true" "false"

強制終了

  • 継続課金 継続課金の終了方式(3者間 または2者間 )を指定

    true : 強制終了(2者間)

    false : 消費者を介する継続課金終了(3者間/デフォルト)

  • 随時決済: 指定できません。

terminalKind
string
Enum: "0" "1" "2"

端末種別

  • 継続課金

    • 3者間:※3者間の 継続課金 終了 の場合に指定可能なパラメータ

      消費者が使用している端末の種別を指定

      0 : PC

      1 : スマートフォン

      2 : フィーチャーフォン

    • 2者間 : 指定できません。

  • 随時決済: 指定できません。

successUrl
string (schemas-successUrl) <= 1024 characters

継続課金終了完了時URL

URLに使用可能な半角文字1024桁以内

  • 3者間 : ※3者間の継続課金終了の場合に指定可能なパラメータ

    継続課金終了完了後に、店舗側サイトに画面遷移を戻すためのURLを指定

    ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録申請時に設定した値を使用

  • 2者間 : 指定できません。

cancelUrl
string (schemas-cancelUrl) <= 1024 characters

継続課金終了キャンセル時URL

URLに使用可能な半角文字1024桁以内

  • 3者間 : ※3者間の継続課金終了の場合に指定可能なパラメータ

    継続課金終了キャンセル後に、店舗側サイトに画面遷移を戻すためのURLを指定

    ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録申請時に設定した値を使用

  • 2者間 : 指定できません。

errorUrl
string (schemas-errorUrl) <= 1024 characters

継続課金終了エラー時URL

URLに使用可能な半角文字1024桁以内

  • 3者間 : ※3者間の継続課金終了の場合に指定可能なパラメータ

    継続課金終了エラー時に、店舗側 サイトに画面 遷移を戻すための URL を指定

    ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録申請時に設定した値を使用

  • 2者間 : 指定できません。

pushUrl
string (schemas-pushUrl) <= 1024 characters

プッシュURL

URLに使用可能な半角文字1024桁以内

  • 3者間 : ※3者間の 継続課金 終了の場合に指定可能なパラメータ

    「ダミー取引」時のプッシュURLを指定

    本パラメータは開発時にのみ利用されることを想定しており、ダミー取引で指定可能です。

    ※未指定の場合は、Authorize時に指定された値、またはマーチャント登録申請時にDBに設定された値を使用

  • 2者間 : 指定できません。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {},
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

再与信

再与信

詳細は キャリア決済 インターフェース詳細 2.6.1 再与信 CarrierReAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
d払い (object) or auかんたん決済 (object)
One of
orderId
required
string (CarrierReAuthorizeRequest_Common_components-schemas-orderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

新たに与信を取得するために新規採番した取引ID

serviceOptionType
required
string
Value: "docomo"

サービスオプションタイプ

利用するキャリア決済のタイプを指定

docomo : d払い

originalOrderId
required
string (originalOrderId) <= 100 characters ^[a-zA-Z0-9]{1,100}$

元取引ID

決済申込時に指定し、随時決済の利用承諾を取得した取引ID

withCapture
string (schemas-withCapture)
Enum: "true" "false"

与信同時売上フラグ

売上フラグを指定

※未指定の場合は、"false"

ただし、与信同時売上のみを許可するキャリアの場合は"true"とみなす。

true : 与信同時売上

false : 与信のみ

amount
required
string (schemas-amount) <= 12 characters ^[0-9]{1,12}$

決済金額

キャリア毎に上限金額が規定されています。

詳細は 『キャリア決済サービス 補足資料』を参照下さい。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

コンビニ決済

申込

申込

詳細は コンビニ決済 インターフェース詳細 CvsAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

CvsAuthorizeRequest

serviceOptionType
required
string
Enum: "sej" "other" "famima" "lawson" "econ"

サービスオプションタイプ（コンビニタイプ）

sej : セブン－イレブン

other : デイリーヤマザキ、ヤマザキデイリーストア

※上記以外のコンビニは、加盟店様のご契約内容により以下の2つのパターンに分かれます。

（パターン１） ファミリーマートとの接続形態が「直接接続」の場合

famima : ファミリーマート

lawson : ローソン(ローソン、ミニストップ、セイコーマート)

（パターン２） ファミリーマートとの接続形態が「イーコンテクスト経由接続」の場合

econ : イーコン（ローソン、ファミリーマート、ミニストップ、セイコーマート）

どちらのパターンを利用できるかは、MAPのダッシュボードの「サービス利用情報」より確認できます。 「3.2 利用可能なコンビニタイプの確認方法」に説明していますのでご確認ください。

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1 共通」 に記載の「orderId（取引ID）について」を参照

amount
required
string <= 6 characters ^[0-9]{1,6}$

決済金額

1 以上299,999 以下。

※0円、または30万円以上の金額を設定した場合、エラーが発生するか、コンビニ店舗で支払受付を拒否される可能性があります。

name1
required
string <= 20 characters

氏名1

全角20バイト以内

顧客姓

文字列のサイズは、全角1文字を2バイトとみなした数値です。20バイトの場合は全角文字10桁となります。

※詳細は「3.1 コンビニ決済 使用可能文字一覧」参照。

name2
required
string <= 20 characters

氏名2

全角20バイト以内

顧客名

文字列のサイズは、全角1文字を2バイトとみなした数値です。20バイトの場合は全角文字10桁となります。

※詳細は「3.1 コンビニ決済 使用可能文字一覧」参照。

telNo
required
string <= 13 characters ^[0-9\-]{5,13}$

電話番号

半角数字13桁以内

顧客電話番号

数字のみは11桁以内、ハイフン含みは13桁以内

例） 0311112222、03-1111-2222、09011112222、090-1111-2222

※econ, lawsonの場合は、電話番号8桁未満は指定不可。

※famima, sej, otherの場合は、5桁未満は指定不可。

※電話番号は固定値としないでください。

※電話番号でなくても規定の桁数の数字であれば問題はありません。電話番号の設定が難しい場合は、固定値ではない数字の文字列を設定してください。

payLimit
required
string^\d{4}/\d{2}/\d{2}$

支払期限

YYYY/MM/DD の形式

sej : 当日～150日後を指定可能

famima : 当日～60日後を指定可能

lawson : 当日～60日後を指定可能

econ : 当日～60日後を指定可能

other : 当日～365日後を指定可能

payLimitHhmm
string^\d{2}:\d{2}$
Default: "23:59"

支払期限時分

HHMMまたはHH:MMの形式

※未指定の場合の期限は、期限日当日の23:59までとなります。

pushUrl
string <= 256 characters

プッシュURL

URLに使用可能な半角文字256桁以内

入金通知先URLを指定

※未指定の場合は、MAPの「各種設定変更」で設定した入金通知URLに通知されます。

paymentType
required
string
Value: "0"

支払区分

"0"固定

※現在はリザーブパラメーターのため無条件に "0" を設定

free1
string

備考1

文字列

備考欄（商品詳細などに利用する）

sej : 使用不可

famima : 任意（38バイト）

lawson : 任意（50バイト）

econ : 任意（50バイト）

other : 任意（32バイト）

free2
string

備考2

文字列

備考欄（商品詳細などに利用する）

sej : 使用不可

famima : 任意（38バイト）

lawson : 使用不可

econ : 使用不可

other : 任意（32バイト）

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は コンビニ決済 インターフェース詳細 CvsCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object

CvsCancelRequest コンビニ決済では、支払い前の申込に対するキャンセルが可能です。 消費者がコンビニエンスストアで支払いを行った後のキャンセルはできませんのでご注意ください。

serviceOptionType
required
string
Enum: "sej" "other" "famima" "lawson" "econ"

決済サービスオプションタイプ 要求電文を送信した決済サービスタイプ

orderId
required
string <= 100 characters ^[0-9a-zA-Z]{1,100}$

取引ID 決済請求時に採番した取引ID

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

BankPay

決済申込

決済申込

詳細は BankPay インターフェース詳細 5-1-1 決済申込 BankPayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayAuthorizeRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

上記「orderId（取引ID）について」参照

amount
required
string <= 7 characters ^[0-9]{1,7}$

決済金額

決済金額を指定

  • 1 以上かつ 9999999(7桁) 以下
memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

会員登録を行った店舗側で会員を一意に表す会員IDを指定します。

accountId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

口座ID

会員IDに紐づく口座IDを指定します。

accountingType
required
string
Enum: "0" "1" "2" "3" "4"

課金種別

0：都度決済

1：随時決済

2：チャージ（オープン）

3：チャージ（ハウス）

4：チャージ（資金移動）

terminalId
required
string <= 13 characters ^[0-9]{13}$

端末機識別番号

店舗POSなどの決済端末を識別する値を指定

チャージのみの利用の場合は、一意な値を設定して問題ございません。

流通決済事業者コードを設定可能な場合は先頭5桁に設定することをお勧めします。

流通事業者コード：

https://www.dsri.jp/code/credit/

storeId
string <= 5 characters ^[a-zA-Z0-9]{5}$

店舗ID

任意の店舗IDを指定

storeName
string <= 50 characters

店舗名

利用者アプリ表示用の店舗名

使用可能文字については「7-2 使用可能文字」を参照してください。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金

返金

詳細は BankPay インターフェース詳細 5-1-2 返金 BankPayRefundRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayRefundRequest

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済申し込み時に指定した値を設定します。

amount
string <= 7 characters ^[0-9]{1,7}$

返金金額

返金金額を指定。

※全額返金のみ可能。

※未指定時は、返金可能金額全額。

terminalId
string <= 13 characters ^[0-9]{13}$

端末機識別番号

店舗POSなどの決済端末を識別する値を指定

チャージのみの利用の場合は、一意な値を設定して問題ございません。

流通決済事業者コードを設定可能な場合は先頭5桁に設定することをお勧めします。

流通事業者コード：

https://www.dsri.jp/code/credit/

※未指定時は決済申込で指定した値を使用

storeId
string <= 5 characters ^[a-zA-Z0-9]{1,5}$

店舗ID

任意の店舗IDを指定

storeName
string <= 50 characters

店舗名

利用者アプリ表示用の店舗名

使用可能文字については「7-2 使用可能文字」を参照してください。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員登録

会員登録

詳細は BankPay インターフェース詳細 5-1-3 会員登録 BankPayMemberAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayMemberAddRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9_-]{1,100}$

会員ID

加盟店側で会員を一意に表す顧客IDを指定します。

"-"（ハイフン）、"_"（アンダースコア）も使用可能です。

userTerminalId
required
string <= 32 characters ^[a-zA-Z0-9_-]{32}$

利用者端末識別ID

利用者の端末を識別するIDを指定します。

スマホなどのデバイスを識別するためのUUIDなどの情報を指定してください。

EC利用などの場合は一意なランダムな値を指定してください。

userName
string <= 20 characters

氏名

会員の氏名を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

userNameKana
string <= 40 characters

カナ氏名

会員のカナ名を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

birthDate
string <= 8 characters ^[0-9]{8}$

生年月日

会員の生年月日を入力します。

書式はYYYYMMDD。

例)20220531

gender
string
Enum: "M" "F"

性別

会員の性別を入力します。

  • M :男
  • F :女
zipcode
string <= 8 characters ^[0-9-]{1,8}$

郵便番号

会員の郵便番号を入力します。

"-"（ハイフン）有でも無でも指定可能です。

address
string <= 60 characters

住所

会員の住所を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

telNumber
string <= 16 characters ^[0-9-]{1,16}$

電話番号

会員の電話番号を入力します。

"-"（ハイフン）有でも無でも指定可能です。

mobileNumber
string <= 16 characters ^[0-9-]{1,16}$

携帯番号

会員の携帯番号を入力します。

"-"（ハイフン）有でも無でも指定可能です。

emailAddress
string <= 300 characters

メールアドレス

半角英数字記号

会員のメールアドレスを入力します。

emailAddress2
string <= 300 characters

メールアドレス2

半角英数字記号

会員のメールアドレスが2つある場合2つ目を入力します。

remarks
string <= 100 characters

摘要

会員についての備考項目を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員情報更新

会員情報更新

詳細は BankPay インターフェース詳細 5-1-4 会員情報更新 BankPayMemberUpdateRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayMemberUpdateRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

会員登録で指定した値を設定します。

userTerminalId
string <= 32 characters ^[a-zA-Z0-9]{32}$

利用者端末識別ID

利用者の端末を識別するIDを指定します。

スマホなどのデバイスを識別するためのUUIDなどの情報を指定してください。EC利用などの場合は一意なランダムな値を指定してください。

userName
string <= 20 characters

氏名

文字列 20桁以内

会員の氏名を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

userNameKana
string <= 40 characters

カナ氏名

文字列 40桁以内

会員のカナ名を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

birthDate
string <= 8 characters ^[0-9]{8}$

生年月日

会員の生年月日を入力します。

書式はYYYYMMDD。

例)20220531

gender
string
Enum: "M" "F"

性別

会員の性別を入力します。

M ：男

F ：女

zipcode
string <= 8 characters ^[0-9\-]{1,8}$

郵便番号

会員の郵便番号を入力します。

"-"（ハイフン）有でも無でも指定可能です。

address
string <= 60 characters

住所

会員の住所を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

telNumber
string <= 16 characters ^[0-9\-]{1,16}$

電話番号

会員の電話番号を入力します。

"-"（ハイフン）有でも無でも指定可能です。

mobileNumber
string <= 16 characters ^[0-9\-]{1,16}$

携帯番号

会員の携帯番号を入力します。

"-"（ハイフン）有でも無でも指定可能です。

emailAddress
string <= 300 characters

メールアドレス

半角英数字記号 300桁以内

会員のメールアドレスを入力します。

emailAddress2
string <= 300 characters

メールアドレス2

半角英数字記号 300桁以内

会員のメールアドレスが2つある場合2つ目を入力します。

remarks
string <= 100 characters

摘要

文字列 100桁以内

会員についての備考項目を入力します。

使用可能文字については「7-2 使用可能文字」を参照してください。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

会員削除

会員削除

詳細は BankPay インターフェース詳細 5-1-5 会員削除 BankPayMemberDeleteRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayMemberDeleteRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

会員登録で指定した値を設定します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

口座入力情報取得

口座入力情報取得

詳細は BankPay インターフェース詳細 5-1-6 口座入力情報取得 BankPayPrepareAccountAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayPrepareAccountAddRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

会員登録で指定した値を設定します。

accountId
required
string <= 100 characters ^[a-zA-Z0-9-_]{1,100}$

口座ID

会員IDに対して口座を一意に表す口座IDを指定します。

"-"（ハイフン）、"_"（アンダースコア）も使用可能です。

bankCode
required
string <= 4 characters ^[0-9]{4}$

銀行コード

登録口座の銀行コードを入力します。

successUrl
string <= 256 characters

決済完了時URL

URLに使用可能な半角文字 256桁以内

口座登録完了後に、店舗側サイトに画面遷移を戻すためのURLを指定します。

※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

※MAPで未登録かつ本パラメータ未設定の場合はエラーを返戻します。

errorUrl
string <= 256 characters

決済エラー時URL

URLに使用可能な半角文字 256桁以内

口座登録エラー時に、店舗側サイトに画面遷移を戻すためのURLを指定します。

※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

※MAPで未登録かつ本パラメータ未設定の場合はエラーを返戻します。

pushUrl
string <= 256 characters

プッシュ先URL

URLに使用可能な半角文字 256桁以内

プッシュURLを指定します。

※未指定の場合は、MAP（Merchant Administrator Portal）から登録申請した値を使用。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

口座登録

口座登録

詳細は BankPay インターフェース詳細 5-1-7 口座登録 BankPayAccountAddRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayAccountAddRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

口座入力情報取得で指定した値を設定します。

accountId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

口座ID

口座入力情報取得で指定した値を設定します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

口座削除

口座削除

詳細は BankPay インターフェース詳細 5-1-9 口座削除 BankPayAccountDeleteRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayAccountDeleteRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

口座登録で指定した値を設定します。

accountId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

口座ID

口座登録で指定した値を設定します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

口座照会

口座照会

詳細は BankPay インターフェース詳細 5-1-10 口座照会 BankPayAccountGetRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankPayAccountGetRequest

memberId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

会員ID

照会対象の会員IDを指定します。

accountId
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

口座ID

照会対象の口座IDを指定します。

未指定の場合は、会員IDに紐づくすべての口座の情報を取得します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

銀行決済

申込

申込

詳細は 銀行決済 インターフェース詳細 2.2 申込 BankAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object

BankAuthorizeRequest

serviceOptionType
required
string
Enum: "atm" "netbank-pc"

決済サービスオプション

atm：番号通知方式(ATM決済)

netbank-pc：銀行リンク方式(ネットバンク決済)

※スマートフォンの場合は、"netbank-pc"を設定してください。

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1共通」の「orderId(取引ID)について」参照

amount
required
string <= 10 characters ^(?:[1-9]|[1-9][0-9]{0,8}|[1-9][0-9]{9})$

決済金額

1以上 9,999,999,999以下

name1
required
string <= 10 characters

顧客名1

全角10文字以内

購入者名

※詳細は「3-3 使用可能文字一覧」を参照してください。

name2
string <= 10 characters

顧客名2

全角10文字以内

購入者名(予備)

※詳細は「3-3 使用可能文字一覧」を参照してください。

kana1
required
string <= 10 characters

顧客名カナ1

全角10文字以内

購入者名(カナ)

※詳細は「3-3 使用可能文字一覧」を参照してください。

kana2
string <= 10 characters

顧客名カナ2

全角10文字以内

購入者名(カナ)(予備)

※詳細は「3-3 使用可能文字一覧」を参照してください。

payLimit
required
string <= 8 characters ^[0-9]{1,8}$

支払期限

支払期限(YYYYMMDD 形式)

当日～60日後を支払期限に指定可能。

pushUrl
string <= 256 characters ^[\w\-\.\~\%\/\=\&\?]{1,256}$

プッシュURL

入金通知先URL を指定

※未指定の場合は、MAP の「各種設定変更」で設定した入金通知URL に通知されます。

contents
required
string <= 12 characters

請求内容(漢字)

全角12文字以内

インフォメーションとしてATM 等に表示

contentsKana
required
string <= 24 characters

請求内容(カナ)

全角24文字以内

インフォメーションとしてATM 等に表示

payCsv
string <= 4 characters ^[0-9]{1,4}$

決済機関コード

支払を行う金融機関を固定する場合に金融機関コードを指定

金融機関コードはhttps://www.veritrans.co.jp/payment/bank/list.htmlを参照

termUrl
string <= 128 characters ^[\w\-\.\~\%\/\=\&\?]{1,128}$

決済結果戻り先URL

決済完了後に店舗側サイトへ遷移を戻すためのURL

決済サービスオプションが銀行リンク方式(ネットバンク決済)かつ決済期間コードを指定しない場合のみ設定可能です

pushExpantionFlag
any

結果通知パラメータ追加フラグ

1： 結果通知に追加のパラメータを設定する

0： 結果通知に追加のパラメータを設定しない

※ 未指定の場合は、MAPの「各種設定変更」の「入金通知パラメータを追加する」に設定された状態に従います。

※ 追加パラメータの詳細は、「2-3 結果通知」を参照してください。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

電子マネー決済

申込

申込

詳細は以下をご確認ください

電子マネー決済 インタフェース詳細 2.2 申込(楽天Edy)

電子マネー決済 インタフェース詳細 2.5 申込(Suica)

電子マネー決済 インタフェース詳細 2.8 申込(WAON)

電子マネー決済 インタフェース詳細 2.11 申込(nanako)

Request Body schema: application/json
required
required
楽天Edy (object) or Suica (object) or WAON (object) or nanaco (object)
One of
serviceOptionType
required
string
Enum: "edy-mobile" "edy-pc" "edy-direct"

決済サービスオプション

edy-mobile : モバイルEdy(EMB)

edy-pc : サイバーEdy(EPC)

edy-direct : Edy ダイレクト(EDC)

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1共通」の「orderId(取引ID)について」参照

amount
required
string <= 5 characters ^[0-9]{1,5}$

決済金額

1以上50,000以下

settlementLimit
string <= 14 characters ^[0-9]{14}$

決済期限

支払期限(YYYYMMDDhhmmss)

※決済期限のチェックは決済サーバーの電文受信時のシステム日時を基準とします。

EMB : 当日～90日後を決済期限に指定可能

EPC : 10日固定(設定不可)

EDC : 10日固定(設定不可)

mailAddr
string <= 256 characters ^[A-Za-z0-9@_\-.,]{1,256}$

メールアドレス

決済依頼メールを送付する消費者の携帯電話メールアドレス

楽天Edy 利用可能なおサイフケータイにおいて、初期設定・サービス登録が必要です。ドメイン指定受信を設定してい

る場合は@bitwallet.co.jp を許可ドメインに加える必要があります。

forwardMailFlag
string
Enum: "0" "1" ""

転送メール送信要否

楽天Edy から消費者に通知する決済依頼メール、決済完了メールのコピーメール又はBCC メールを貴社受信用メー

ルアドレス(merchantMailAddr)に送信するか否かを設定

EMB:

0 : 送信不要

1 : 送信要

EPC:設定不可

EDC:設定不可

merchantMailAddr
string <= 256 characters ^[A-Za-z0-9@_\-.,]{1,256}$

マーチャントメールアドレス

楽天Edy から消費者に通知する決済依頼メール、決済完了メールのコピーメール又はBCC メールを受信するメール

アドレス

以下の文字も使用できます。

"." (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク)

複数指定時は","区切り指定して下さい。

EMB:

転送メール送信要否(forwardMailFlag)に"1": 送信要を設定した場合に設定必須

EPC : 設定不可

EDC : 設定不可

requestMailAddInfo
string <= 256 characters

依頼メール送信付加情報

文字列256バイト以内

決済依頼メールに追加される文字列(商品情報等)

EMB : 詳細は「3.1.1Mobile Edy」の「Mobile Edy 決済開始メール」参照

EPC : 設定不可

EDC : 設定不可

completeMailAddInfo
string <= 300 characters

完了メール付加情報

文字列300バイト以内

決済完了メールに追加される文字列(遷移先URL 等)

EMB : 詳細は「3.1.1Mobile Edy」の「Mobile Edy 決済完了メール」参照

EPC : 設定不可

EDC : 設定不可

shopName
string <= 48 characters

ショップ名

文字列48バイト以内

決済依頼メール、決済完了メールで使用する店舗名

EMB : 詳細は「3.1.1Mobile Edy」の「Mobile Edy 決済開始メール」および「Mobile Edy 決済完了メール」参照

EPC : 設定不可

EDC : 任意

completeNoticeUrl
string <= 256 characters ^[a-zA-Z0-9\-._~:/?#@!$&'()*+,;=%]{1,256}$

決済完了通知URL

支払いを完了した後に遷移するURL

※設定しない場合は無遷移

EMB : 設定不可

EPC : 任意

EDC : 任意

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
Example
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

再決済申込

再決済申込

詳細は以下をご確認ください

電子マネー決済 インタフェース詳細 2.12 再決済申込(nanaco)

Request Body schema: application/json
required
required
object

EmReAuthorizeRequestDto

serviceOptionType
required
string
Value: "tcc-redirect"

決済サービスオプション

tcc-redirect : nanaco 決済

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済申込時の取引ID を指定

reAuthorizeRedirectionUrl
required
string <= 256 characters ^[a-zA-Z0-9\-._~:/?#@!$&'()*+,;=%]{1,256}$

復旧リダイレクションURL

復旧処理後のリダイレクト先URL

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は以下をご確認ください

電子マネー決済 インタフェース詳細 2.6 キャンセル(Suica)

電子マネー決済 インタフェース詳細 2.13 キャンセル(nanaco)

Request Body schema: application/json
required
required
Suica (object) or nanaco (object)
One of
serviceOptionType
required
string
Enum: "suica-mobile-mail" "suica-mobile-app"

決済サービスオプション

キャンセル対象の取引の、決済した方式を指定

suica-mobile-mail : モバイルSuica(メール決済)

suica-mobile-app : モバイルSuica(アプリ決済)

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

決済請求時に採番した取引ID

orderKind
required
string
Enum: "authorize" "refund"

オーダー種別

キャンセル対象のオーダー種別を指定

authorize : 決済申込

refund : 返金申込

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
Example
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

返金申込

返金申込

詳細は以下をご確認ください

電子マネー決済 インタフェース詳細 2.4 返金申込(楽天Edy)

電子マネー決済 インタフェース詳細 2.7 返金申込(Suica)

電子マネー決済 インタフェース詳細 2.10 返金申込(WAON)

Request Body schema: application/json
required
required
楽天Edy (object) or Suica (object) or WAON (object)
One of
serviceOptionType
required
string
Enum: "edy-mobile" "edy-pc" "edy-direct"

決済サービスオプション

edy-mobile : モバイルEdy(EMB)

edy-pc : サイバーEdy(EPC)

edy-direct : Edy ダイレクト(EDC)

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1共通」の「orderId(取引ID)について」参照

amount
required
string <= 5 characters ^[0-9]{1,5}$

返金金額

返金金額。返金は一回のみ可能。

1以上50,000以下、かつ決済申込時の金額以下

orderKind
required
string
Value: "refund"

オーダー種別

refund : 返金 を指定

refundOrderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

返金対象取引ID

決済請求時に採番した取引ID

edyGiftName
string <= 32 characters

返金名義

文字列32バイト以内

(全角16文字、半角32文字)

返金用に用いられるEdy ギフトの取得画面で表示される個別返金名義を設定したい場合に指定

未指定 : 『Edy 決済返金』

指定 : 『Edy 決済返金』＋指定名義

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
Example
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

カード情報削除

カード情報削除

詳細は以下をご確認ください

電子マネー決済 インタフェース詳細 2.15 カード情報削除(nanaco)

Request Body schema: application/json
required
required
object

EmRemoveRequestDto

serviceOptionType
required
string
Value: "tcc-redirect"

決済サービスオプション

tcc-redirect : nanaco 決済

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

「2-1共通」の「orderId(取引ID)について」参照

userId
required
string <= 64 characters ^[A-Za-z0-9!@#$%^&*()_+,\.-:;=?<>|~`{}\[\]\\\...

ユーザID

決済申込時のユーザID を指定

※決済申込時に「かざしてお支払」を利用し、電子マネーカード情報とユーザID が紐づけられている必要があります。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

後払い

与信 注文情報登録

与信 注文情報登録

詳細は 後払い インタフェース詳細 ScoreatpayAuthorizeRequestDto をご確認ください

Request Body schema: application/json
required
required
object (ScoreatpayAuthorizeRequestDto)

ScoreatpayAuthorizeRequestDto

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗様にて採番した取引ID

※注文情報修正時は、登録時に設定した取引IDを設定してください。

amount
required
string <= 6 characters ^[0-9]{1,6}$

決済金額

決済金額(合計金額)

※5-3金額に関する注意事項参照

shopOrderDate
required
string <= 10 characters ^\d{4}/\d{2}/\d{2}$

注文日

注文日

"YYYY/MM/DD"の10桁固定

required
object (ScoreatpayContactDto)

購入者情報

連絡先オブジェクト

ここに入力された住所、氏名に払込用紙が発送されます。

paymentType
required
string <= 1 characters
Enum: "2" "3"

決済種別

2 : 請求書別送

3 : 請求書同梱※購入者住所情報と配送先住所情報が完全に一致する場合のみ使用可能です。

required
object (ScoreatpayDeliveryDto)

配送先情報

配送先情報オブジェクトを設定

object (ScoreatpayDeliveryDto2)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto3)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto4)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto5)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto6)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto7)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto8)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto9)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

与信 注文情報修正

与信 注文情報修正

詳細は 後払い インタフェース詳細 ScoreatpayCorrectAuthRequestDto をご確認ください

Request Body schema: application/json
required
required
object (ScoreatpayCorrectAuthRequestDto)

ScoreatpayCorrectAuthRequestDto

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

店舗様にて採番した取引ID

※注文情報修正時は、登録時に設定した取引IDを設定してください。

amount
required
string <= 6 characters ^[0-9]{1,6}$

決済金額

決済金額(合計金額)

※5-3金額に関する注意事項参照

shopOrderDate
required
string <= 10 characters ^\d{4}/\d{2}/\d{2}$

注文日

注文日

"YYYY/MM/DD"の10桁固定

required
object (ScoreatpayContactDto)

購入者情報

連絡先オブジェクト

ここに入力された住所、氏名に払込用紙が発送されます。

paymentType
required
string <= 1 characters
Enum: "2" "3"

決済種別

2 : 請求書別送

3 : 請求書同梱※購入者住所情報と配送先住所情報が完全に一致する場合のみ使用可能です。

required
object (ScoreatpayDeliveryDto)

配送先情報

配送先情報オブジェクトを設定

object (ScoreatpayDeliveryDto2)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto3)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto4)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto5)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto6)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto7)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto8)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (ScoreatpayDeliveryDto9)

配送先情報[n]

配送先情報オブジェクトを設定

※配送先が2つ以上ある場合に設定します。

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

売上 発送情報登録

売上 発送情報登録

詳細は 後払い インタフェース詳細 ScoreatpayCaptureRequestDto をご確認ください

Request Body schema: application/json
required
required
object

ScoreatpayCaptureRequestDto

orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

処理対象の取引ID

pdCompanyCode
required
string <= 2 characters
Enum: "11" "12" "13" "14" "15" "16" "17" "18" "20" "21" "23" "26" "27" "28" "29" "99"

運送会社コード

運送会社に該当する2桁の数字

11:佐川急便

12:ヤマト運輸・クロネコメール便

13:日本通運

14:西濃運輸

15:郵便書留

16:ゆうパック

17:セイノースーパーエクスプレス

18:福山通運

20:新潟運輸

21:名鉄運輸

23:信州名鉄運輸

26:トールエクスプレスジャパン

27:エコ配

28:翌朝10時郵便

29:トナミ運輸

99:その他(どの運送会社にも該当しない場合使用)

slipNo
required
string <= 20 characters ^[0-9-]{1,20}$

配送伝票番号

配送伝票番号

deliveryId
required
string <= 25 characters ^[a-zA-Z0-9]{1,25}$

配送先ID

与信時に「配送先情報」(4-1参照)に設定した、

配送先情報オブジェクト(ScoreatpayDeliveryDto)の配送先IDを設定

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

キャンセル

キャンセル

詳細は 後払い インタフェース詳細 ScoreatpayCancelRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

処理対象の取引ID

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

与信結果確認

与信結果確認

詳細は 後払い インタフェース詳細 ScoreatpayConfirmRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

処理対象の取引ID

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

請求書印字データ取得

請求書印字データ取得

詳細は 後払い インタフェース詳細 ScoreatpayGetInvoiceDataRequestDto をご確認ください

Request Body schema: application/json
required
required
object
orderId
required
string <= 100 characters ^[a-zA-Z0-9]{1,100}$

取引ID

処理対象の取引ID

object (schemas-payNowIdParam)

PayNowIdParam

会員 ID とクレジットカード番号の紐付けなど、会員管理で使用するパラメータを格納するオブジェクト

詳細はクレジットカード決済実行時の会員ID管理と決済機能を参照してください

txnVersion
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

dummyRequest
string (dummyRequest)
Enum: "0" "1"

ダミー要求フラグ

0 : 通常要求

1 : ダミー要求

※指定しない場合は、本番リクエストとなります。

※「"1":ダミーリクエスト」と「"0":本番リクエスト」にて、接続先URL が異なりますので、ご注意ください。

※「"1":ダミーリクエスト」の場合、接続先 URL を検証環境へ変更 する必要があります。

※ダミーリクエストの場合、要求は VeriTrans4G にて折り返され、各 決済センターへは送信されません。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "payNowIdResponse": {
    },
  • "result": {
    }
}

検索機能(Search)

検索

詳細は 検索機能(Search) インターフェース詳細 2.2 検索 SearchRequestDto をご確認ください

検索機能で使用する電文（Dto）について説明します。以下に記載されているフィールドは、店舗様にて利用可能なフィールドです。

各電文（Dto）には、以下に記載されていないフィールドが定義されている場合がありますが、以下に記載されていないフィールドは店舗様では使用することはできません。

  • ワイルドカードは値の一部と""を組み合わせて検索します。""のみの指定はできません。

    例:exparam.searchParameters.common.orderId=123*

  • FROM～TOの指定を行った際の検索はfromで指定した値以上、toで指定した値未満となります。

    例:paidDatetime.from <=入金日時 < paidDatetime.to

(重要) 検索条件は、決済サービス毎に様々な条件を指定可能ですが、原則として必ず「取引ID」を条件に含めた検索を行って頂きますようお願いします。取引IDを条件に含まない検索を実施された場合、データ量によってはレスポンス遅延や、想定外の結果が返戻される場合がございます。取引IDを含まない、複雑な条件での検索を実施される場合は、事前にテクニカルサポートまでご相談下さい。

Request Body schema: application/json
required
required
object

検索要求電文

requestId
string <= 128 characters

リクエストID

リクエストIDを指定します。指定した場合は、それ以外のパラメータは指定できません。

  • 複数指定: 不可
  • ワイルドカード : 不可
serviceTypeCd
Array of strings
Items Enum: "card" "mpi" "cvs" "bankpay" "bank" "em" "carrier" "rakuten" "paypay" "linepay" "cvspay" "amazonpay" "epos" "merpay" "paypal" "upop" "alipay" "scoreatpay"

決済サービスタイプ

検索対象の決済を指定

未指定の場合は、全決済が検索対象です。

card: カード決済

mpi: 本人認証

cvs: コンビニ決済

bankpay: BankPay

bank：銀行決済

em: 電子マネー決済

carrier: キャリア決済

rakuten: 楽天ペイ

paypay: PayPay

linepay: LINE Pay

cvspay: ファミペイ

amazonpay: Amazon Pay

epos: エポスかんたん決済

merpay: メルペイ

paypal: PayPal決済

upop: 銀聯ネット決済（UPOP）

alipay:Alipay決済

scoreatpay: 後払い

  • 複数指定: 可
  • ワイルドカード : 不可
newerFlag
string
Default: "false"
Enum: "true" "false"

最新トランザクションフラグ

成功、失敗に関係なく、最新トランザクションのみを検索する場合に使用

true: 1取引内の最新トランザクションのみ検索

false: 全てのトランザクションを検索

※指定しない場合は"false"になります。

  • 複数指定: 不可
  • ワイルドカード : 不可
containDummyFlag
string
Default: "false"
Enum: "true" "false"

ダミー決済対象フラグ

ダミー取引も検索する場合に使用

true: ダミー取引も検索する

false: ダミー取引は検索しない

※指定しない場合は"false"になります。

  • 複数指定: 不可
  • ワイルドカード : 不可
maxCount
string^[0-9]{1,4}$

検索最大件数

1〜1000

取得したい検索結果の最大件数

未指定の場合、最大値となります。

※短時間で大量の検索を繰り返すような処理はサーバに負荷が掛かりますのでご遠慮頂けますようお願いします。

  • 複数指定: 不可
  • ワイルドカード : 不可
object
txnVersion
required
string (txnVersion) <= 5 characters ^[a-zA-Z0-9.]{1,5}$

決済要求電文のバージョン。x.x.x 形式

※ 接続 API 利用時は、2.0.0 を指定してください。

merchantCcid
required
string (merchantCcid)

マーチャントCCID

ベリトランスより通知された店舗様用のマーチャント CCID 文字列

authHash
required
string (authHash) [0-9a-f]{64}

認証ハッシュ

VeriTrans4G にて認証に使用されるハッシュ

authHashの生成を参照してください

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "authHash": "7dab70d5b9e2e184204249eedb57d89696af57ab7bc3609918df441cf3be5f3a"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

MDK(SDK)インターフェースとAPIエンドポイントの対応表

以下にMDKでの各インターフェース(DTO)とAPIエンドポイントの対応を示します。

クレジットカード

MDKインターフェース(要求電文名) APIエンドポイント
CardAuthorizeRequestDto /Authorize/card 与信(CardAuthorize)
CardReAuthorizeRequestDto /ReAuthorize/card 再取引(CardReAuthorize)
CardCaptureRequestDto /Capture/card 売上(CardCapture)
CardCancelRequestDto /Cancel/card キャンセル(CardCancel)

3Dセキュア(3DS2.0) (MPI本人認証)

MDKインターフェース(要求電文名) APIエンドポイント
MpiAuthorizeRequestDto /Authorize/mpi 認可(MpiAuthorize)
MpiReAuthorizeRequestDto /ReAuthorize/mpi 再取引(MpiReAuthorize)
MpiGetResultRequestDto /GetResult/mpi 本人認証結果確認(MpiGetResult)

ワンクリック継続課金

MDKインターフェース(要求電文名) APIエンドポイント
AccountAddRequestDto /Add/account 会員情報追加(AccountAdd)
AccountUpdateRequestDto /Add/account 会員情報変更(AccountUpdate)
AccountDeleteRequestDto /Add/account 会員情報削除(AccountDelete)
AccountRestoreRequestDto /Add/account 会員情報復元(AccountRestore)
AccountLinkRequestDto /Add/account 会員情報紐付(AccountLink)
AccountCopyRequestDto /Add/account 会員情報複製(AccountCopy)
RecurringAddRequestDto /Add/recurring 継続課金管理追加(RecurringAdd)
RecurringUpdateRequestDto /Add/recurring 継続課金管理変更(RecurringUpdate)
RecurringDeleteRequestDto /Add/recurring 継続課金管理削除(RecurringDelete)
RecurringGetRequestDto /Add/recurring 継続課金管理取得(RecurringGet)
CardInfoAddRequestDto /Add/cardinfo 登録カード管理追加(CardInfoAdd)
CardInfoUpdateRequestDto /Add/cardinfo 登録カード管理変更(CardInfoUpdate)
CardInfoDeleteRequestDto /Add/cardinfo 登録カード管理削除(CardInfoDelete)
CardInfoGetRequestDto /Add/cardinfo 登録カード管理取得(CardInfoGet)
BankAccountAddRequestDto /Add/bankAccount 登録口座管理追加(BankAccountAdd)
BankAccountDeleteRequestDto /Add/bankAccount 登録口座管理削除(BankAccountDelete)

PayPay

MDKインターフェース(要求電文名) APIエンドポイント
PaypayAuthorizeRequestDto /Authorize/paypay 申込(PaypayAuthorize)
PaypayReAuthorizeRequestDto /ReAuthorize/paypay 再与信(PaypayReAuthorize)
PaypayCancelRequestDto /Cancel/paypay 取消(PaypayCancel)
PaypayCaptureRequestDto /Capture/paypay 売上(PaypayCapture)
PaypayRefundRequestDto /Refund/paypay 返金(PaypayRefund)
PaypayTerminateRequestDto /Terminate/paypay 解約(PaypayTerminate)

Line Pay

MDKインターフェース(要求電文名) APIエンドポイント
LinepayAuthorizeRequestDto /Authorize/linepay 申込(LinepayAuthorize)
LinepayCaptureRequestDto /Capture/linepay 売上(LinepayCapture)
LinepayCancelRequestDto /Cancel/linepay キャンセル(LinepayCancel)

楽天ペイ

MDKインターフェース(要求電文名) APIエンドポイント
RakutenAuthorizeRequestDto /Authorize/rakuten 申込(RakutenAuthorize)
RakutenReAuthorizeRequestDto /ReAuthorize/rakuten 再与信(RakutenReAuthorize)
RakutenUpdateAuthorizeRequestDto /UpdateAuthorize/rakuten 与信変更(RakutenUpdateAuthorize)
RakutenCaptureRequestDto /Capture/rakuten 売上(RakutenCapture)
RakutenCancelRequestDto /Cancel/rakuten 取消(RakutenCancel)

メルペイ

MDKインターフェース(要求電文名) APIエンドポイント
MerpayAuthorizeRequestDto /Authorize/merpay 申込(MerpayAuthorize)
MerpayCancelRequestDto /Cancel/merpay 取消(MerpayCancel)
MerpayCaptureRequestDto /Capture/merpay 売上(MerpayCapture)
MerpayRefundRequestDto /Refund/merpay 返金(MerpayRefund)
MerpayReAuthorizeRequestDto /ReAuthorize/merpay 再与信(MerpayReAuthorize)
MerpayTerminateRequestDto /Terminate/merpay 解約(MerpayTerminate)

ファミペイ

MDKインターフェース(要求電文名) APIエンドポイント
CvspayAuthorizeRequestDto /Authorize/cvspay 申込(CvspayAuthorize)
CvspayCaptureRequestDto /Cancel/cvspay 取消(CvspayCancel)

Amazon Pay

MDKインターフェース(要求電文名) APIエンドポイント
AmazonpayAuthorizeRequestDto /Authorize/amazonpay 申込(AmazonpayAuthorize)
AmazonpayCaptureRequestDto /Capture/amazonpay 売上(AmazonpayCapture)
AmazonpayCancelRequestDto /Cancel/amazonpay キャンセル(AmazonpayCancel)
AmazonpayRefundRequestDto /Refund/amazonpay 返金(AmazonpayRefund)
AmazonpayGetAddressRequestDto /GetAddress/amazonpay 注文情報取得(AmazonpayGetAddress)
AmazonpayReAuthorizeRequestDto /ReAuthorize/amazonpay 再与信(AmazonpayReAuthorize)
AmazonpayTerminateRequestDto /Terminate/amazonpay 解約(AmazonpayTerminate)
AmazonpayUpdateConsentRequestDto /UpdateConsent/amazonpay 承諾情報更新(AmazonpayUpdateConsent)
AmazonpayUpdateAuthorizeRequestDto /UpdateAuthorize/amazonpay 与信変更(AmazonpayUpdateAuthorize)

PayPal

MDKインターフェース(要求電文名) APIエンドポイント
PaypalAuthorizeRequestDto /Authorize/paypal 申込(PaypalAuthorize)
PaypalCaptureRequestDto /Capture/paypal 売上(PaypalCapture)
PaypalCancelRequestDto /Cancel/paypal キャンセル(PaypalCancel)
PaypalRefundRequestDto /Refund/paypal 返金(PaypalRefund)

エポスかんたん決済

MDKインターフェース(要求電文名) APIエンドポイント
EposAuthorizeRequestDto /Authorize/epos 決済申込(EposAuthorize)
EposCaptureRequestDto /Capture/epos 売上(EposCapture)
EposCancelRequestDto /Cancel/epos キャンセル(EposCancel)

銀聯(UPOP)

MDKインターフェース(要求電文名) APIエンドポイント
UpopAuthorizeRequestDto /Authorize/upop 申込(UpopAuthorize)
UpopCaptureRequestDto /Capture/upop 売上(UpopCapture)
UpopCancelRequestDto /Cancel/upop キャンセル(UpopCancel)
UpopRefundRequestDto /Refund/upop 返金(UpopRefund)

Alipay

MDKインターフェース(要求電文名) APIエンドポイント
AlipayAuthorizeRequestDto /Authorize/alipay 与信同時売上(AlipayAuthorize)
AlipayRefundRequestDto /Refund/alipay 返金申込(AlipayRefund)
AlipayConfirmRequestDto /Confirm/alipay 確認(AlipayConfirm)
AlipayCreateIdentityCodeRequestDto /CreateIdentityCode/alipay QRコード生成(AlipayCreateIdentifyCode

キャリア決済

MDKインターフェース(要求電文名) APIエンドポイント
CarrierAuthorizeRequestDto /Authorize/carrier 申込(CarrierAuthorize)
CarrierCaptureRequestDto /Capture/carrier 売上(CarrierCapture)
CarrierCancelRequestDto /Cancel/carrier キャンセル(CarrierCancel)
CarrierTerminateRequestDto /Terminate/carrier 継続課金終了(CarrierTerminate)
CarrierReAuthorizeRequestDto /ReAuthorize/carrier 再与信(CarrierReAuthorize)

コンビニ決済

MDKインターフェース(要求電文名) APIエンドポイント
CvsAuthorizeRequestDto /Authorize/cvs 申込(CvsAuthorize)
CvsCancelRequestDto /Cancel/cvs キャンセル(CvsCancel)

BankPay

MDKインターフェース(要求電文名) APIエンドポイント
BankpayAuthorizeRequestDto /Authorize/bankpay 決済申込(BankpayAuthorize)
BankpayRefundRequestDto /Refund/bankpay 返金(BankpayRefund)
BankPayMemberAddRequestDto /MemberAdd/bankpay 会員登録(BankPayMemberAdd)
BankPayMemberUpdateRequestDto /MemberUpdate/bankpay 会員情報更新(BankPayMemberUpdate)
BankPayMemberDeleteRequestDto /MemberDelete/bankpay 会員削除(BankPayMemberDelete)
BankPayPrepareAccountAddRequestDto /PrepareAccountAdd/bankpay 口座入力情報取得(BankPayPrepareAccountAdd)
BankPayAccountAddRequestDto /AccountAdd/bankpay 口座登録(BankPayAccountAdd)
BankPayAccountDeleteRequestDto /AccountDelete/bankpay 口座削除(BankPayAccountDelete)
BankPayAccountGetRequestDto /AccountGet/bankpay 口座照会(BankPayAccountGet)

銀行決済

MDKインターフェース(要求電文名) APIエンドポイント
BankAuthorizeRequestDto /Authorize/bank 申込(BankAuthorize)

電子マネー決済

MDKインターフェース(要求電文名) APIエンドポイント
EmAuthorizeRequestDto (楽天Edy) /Authorize/em 申込(EmAuthorize)
EmRefundRequestDto (楽天Edy) /Refund/em 返金申込(EmRefund)
EmAuthorizeRequestDto (Suica) /Authorize/em 申込(EmAuthorize)
EmCancelRequestDto (Suica) /Cancel/em キャンセル(EmCancel)
EmRefundRequestDto (Suica) /Refund/em 返金申込(EmRefund)
EmAuthorizeRequestDto (WAON) /Authorize/em 申込(EmAuthorize)
EmRefundRequestDto (WAON) /Refund/em 返金申込(EmRefund)
EmAuthorizeRequestDto (nanaco) /Authorize/em 申込(EmAuthorize)
EmReAuthorizeRequestDto (nanaco) /ReAuthorize/em 再決済申込(EmReAuthorize)
EmCancelRequestDto (nanaco) /Cancel/em キャンセル(EmCancel)
EmRemoveRequestDto (nanaco) /Remove/em カード情報削除(EmRemove)

後払い

MDKインターフェース(要求電文名) APIエンドポイント
ScoreatpayAuthorizeRequestDto /Authorize/scoreatpay 与信 注文情報登録(ScoreatpayAuthorize)
ScoreatpayCorrectAuthRequestDto /CorrectAuth/scoreatpay 与信 注文情報修正(ScoreatpayCorrectAuth)
ScoreatpayCaptureRequestDto /Capture/scoreatpay 売上 発送情報登録(ScoreatpayCapture)
ScoreatpayCancelRequestDto /Cancel/scoreatpay キャンセル(ScoreatpayCancel)
ScoreatpayConfirmRequestDto /Confirm/scoreatpay 与信結果確認(ScoreatpayConfirm)
ScoreatpayGetInvoiceDataRequestDto /GetInvoiceData/scoreatpay 請求書印字データ取得(ScoreatpayGetInvoiceData)

検索機能(Search)

MDKインターフェース(要求電文名) APIエンドポイント
SearchRequestDto /Search/search 検索(Search)

更新履歴

日付 変更の内容 バージョン
2023/10/25 初版 1.0.0
2023/10/30 一部リンク切れを修正 1.0.1
2023/12/18 決済手段追加 1.1.0
2024/05/02 楽天ペイに随時決済を追加、その他修正 1.2.0
2024/08/26 接続先ドメイン変更に伴う修正
Alipay: バーコード決済に関する記載を削除
キャリア決済: auかんたん決済(随時決済)を追加、一部パラメータの桁数変更
銀行決済: 申込のamountの上限を変更、その他説明を修正
クレジットカード決済: 一部パラメータの追加
3Dセキュア: 一部パラメータの必須化及び説明を修正、一部パラメータの削除
BankPay: depositTypeの説明を追加
各レスポンスでのcardInfoスキーマを修正		 1.3.0
2025/04/30 payNowIdParamを以下の項目から削除
クレジットカード決済:再与信,売上,キャンセル
3Dセキュア(3DS2.0):再取引		 1.3.1