導入

DASGATEWAY API 統合マニュアルへようこそ。

API は REST アーキテクチャスタイルに基づいて設計されています。第三者ソフトウェアとDASGATEWAY間の相互作用を促進するために一組のHTTPペイロードを提供することです。互換性を確保するために、API は多数のHTTPクライアントによって理解されるHTTP認証、HTTP動詞またはHTTPレスポンスコードのようなビルトインHTTP特徴を働かせる資源を指向するURLを提供します。

    APIは以下のベースURLでhttpsを通してアクセスできます。
    LIVEライブ URL (https://api.paymentoptions.com)

API リファレンスの使用

API リファレンスはペイロードに並べられています。さまざまなペイロードの説明といくつかの例が提供されています。例はいくつかの開発言語に限れていますが、HTTP クライアントにアクセスできるすべての言語に同じ原則を適用できます。

認証

APIキー

API キーは、承認と認証に使用されます。API キーによるAPI がリクエストを実行するかどうかを決定します。各加盟店は、秘密鍵と暗号化された鍵のペアにアクセスできます。各ライブAPIキーとTEST APIキーは DasGateway Merchant Access 経由でアクセスできます。.

API は HTTP 基本認証を使用し、 API キーは認可ヘッダーの資格情報として使用されます。.

Note HTTP 基本認証では、資格情報が base64 でエンコード必要があることに注意してください。

APIヘッダー

API ヘッダーは各 API の追加の情報源です。 API ヘッダーは、API リクエストとレスポンスに関連付けられたメタデータを表します。

ヘッダー	説明
x-api-key	資格情報とともに提供
Authorization	DasGatewayの加盟店詳細からライブ API キー
Content-Type	全てのレスポンス属性はjsonオブジェクト設定になります。(application/json)

決済ページリンク作成

方法: POST

URL : /api/v1/hpp/generate/link

このペイロードにより、ホストされた決済ページを開いてトランザクションを取得するためのリンクを生成できます

リクエスト属性

{
 "return_url": {
 "webhook_url": "",
 "success_url": "",
 "decline_url": "",
 "cancel_url": ""
 },
 "amount": null,
 "currency": null,
 "merchant_id": "<DASMID>",
 "merchant_email": "<merchant email>",
 "merchant_txn_ref": "<ref>",
 "payment_method":
 {
 "type":"scheme",
 "store_payment_method":true
},
 "billing_address":
 {
 "country": "JP",
 "email": "<email>",
 "phone": "<phone number>",
 "address1": "<address line 1>",
 "city": "<city>",
 "state": "<state>"
 },
 "shipping_address":
 {
 "country": "JP",
 "email": "<email>",
 "phone": "<phone number>",
 "address1": "<address line 1>",
 "city": "<city>",
 "state": " <state>"
 }
}

属性	タイプ	必須	最大桁数	説明
return_url	object	はい		リターン URL を含むJSONオブジェクト
webhook_url	string	はい	255	Webhook URL リンク
success_url	string	はい	255	決済が成功したURLリンクをリダイレクトします
decline_url	string	はい	255	決済が失敗したURLリンクをリダイレクトします
cancel_url	string	はい	255	決済がキャンセルされた後のキャンセルURLリンク
amount	float/string/int	はい	銀行側が決まった金額	取引金額。表示されていない場合はカード所有者が決済ページに入力が必要です。
currency	string	はい	3	処理通貨の略称（例：日本円：JPY）
merchant_id	string	はい	128	(DASMID)加盟店のID
merchant_email	string	はい	45	加盟店のメールアドレス
merchant_txn_ref	string	はい	45	加盟店取引参照ID
payment_method	object	いいえ		支払方法を含む JSON オブジェクト
type	string	はい	128	カードスキーム（VISA、MASTERCARD）
store_payment_method	boolean	はい	5	トークンを生成する場合は True、生成しない場合は False
billing_address	object	はい		カード所有者の請求先住所を含む JSON オブジェクト
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ phone	string	はい	15	カード所有者の請求先電話番号
∟ address1	string	はい	199	カード所有者の請求先住所
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
shipping_address	object	no		カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ phone	string	はい	20	カード所有者の請求先電話番号
∟ address1	string	はい	199	カード所有者の請求先住所
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県

レスポンス属性

Note 注意: 支払いが完了すると、ユーザーはsuccess_urlまたはdecline_urlにリダイレクトされます。transaction_referenceはURLのクエリパラメータとして含まれます。

{
 "id": "8099279b-e499-464d-ad50-57eed0e4b309",
 "url": "<Generated HPP Link>",
 "amount": "",
 "currency": "",
 "merchant_txn_ref": "<ref>",
 "merchant_id": "<DASMID>",
 "merchant_email": "<merchant email>",
 "return_url": {
 "webhook_url": "",
 "success_url": "",
 "decline_url": "",
 "cancel_url": null
 },
 "billing_address": {
 "city": "<city>",
 "email": "<email>",
 "phone": "<phone number>",
 "state": "<state>",
 "country": "<country code>",
 "address1": "<address line 1>"
 },
 "shipping_address": {
 "city": "<city>",
 "email": "<email>",
 "phone": "<phone number>",
 "state": "<state>",
 "country": "<country code>",
 "address1": "<address line 1>"
 }
}

属性	説明
id	取引参照ID
url	生成された決済ページリンクのURL
amount	取引金額
currency	取引の処理通貨
merchant_txn_ref	加盟店取引参照ID
merchant_id	実行された取引のDASマーチャントID
merchant_email	加盟店のメールアドレス
return_url	リターンURLを含むJSONオブジェクト
webhook_url	Webhook URLリンク
success_url	決済が成功した場合のリダイレクトURLリンク
decline_url	決済が失敗した場合のリダイレクトURLリンク
cancel_url	キャンセルページのURLリンク
billing_address	カード所有者の請求先住所を含むJSONオブジェクト
∟ city	カード所有者の請求先の都市
∟ email	カード所有者の請求先メールアドレス
∟ phone	カード所有者の請求先電話番号
∟ state	カード所有者の請求先都道府県
∟ country	カード所有者の請求先国
∟ address1	カード所有者の請求先住所
shipping_address	カード所有者の配送先住所を含むJSONオブジェクト
∟ city	カード所有者の配送先の都市
∟ email	カード所有者の配送先メールアドレス
∟ phone	カード所有者の配送先電話番号
∟ state	カード所有者の配送先都道府県
∟ country	カード所有者の配送国
∟ address1	カード所有者の配送先住所

認可

Method: 方法

URL : /api/v1/server-to-server-interface/authorization

このペイロードにより、承認トランザクションを実行できます。

リクエスト属性

{
 "amount":"<amount>",
 "currency": null,
 "card": {
 "cvc": "<cvv>",
 "expiry_month": "<month>",
 "expiry_year": "<year>",
 "name": "<name>",
 "number": "<card number>"
 },
 "merchant_txn_ref" :"<ref>",
 "customer_ip" : "<ip>",
 "merchant_id" : "<DASMID>",
 "return_url":{
 "webhook_url": "",
 "success_url": "",
 "decline_url": ""
 },
 "billing_address":{
 "country": "JP",
 "email": "<email>",
 "address1": "<address 1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 },
 "shipping_address":{
 "country": "JP",
 "email": "<email>",
 "address1": "<address 1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 },
 "time_zone": "Asia/Kuala_Lumpur"
}

属性	タイプ	必須	最大桁数	説明
amount	float/string/int	はい	as per Bank	取引金額。銀行が定めた限度額
currency	string	はい	3	処理通貨の略称（例：日本円：JPY）
card	object	はい	カードの詳細を含む JSON オブジェクト
cvc	string	はい	4	カードのセキュリティコード（3桁、AMEXの場合は４桁）
expiry_month	string	はい	2	カードの満了月
expiry_year	string	はい	2	カードの満了年
name	string	はい	255	カードに記載されているカード所有者の名前
number	string	はい	16	カード番号
merchant_txn_ref	string	はい	45	加盟店取引参照ID
customer_ip	string	はい	45	カード所有者のIPアドレス
merchant_id	string	はい	128	加盟店ID
return_url	object	はい	リターン URL を含む JSON オブジェクト
webhook_url	string	はい	255	Webhook URL リンク
success_url	string	はい	255	決済が成功したURLリンクをリダイレクトします
decline_url	string	はい	255	決済が失敗したURLリンクをリダイレクトします
billing_address	object	はい	カード所有者の請求先住所を含む JSON オブジェクト
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ address1	string	はい	199	カード所有者の請求先住所
∟ phone_number	string	はい	20	カード所有者の請求先電話番号
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
∟ postal_code	string	はい	45	カード所有者の郵便番号
shipping_address	object	いいえ	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ phone	string	はい	20	カード所有者の請求先電話番号
∟ address1	string	はい	199	カード所有者の請求先住所
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
∟ postal_code	string	いいえ	45	カード所有者配送先の郵便番号
∟ time_zone	string	はい	128	取引国のタイムゾーン

レスポンス属性

{
 "success": true,
 "status_code": 201,
 "is_live": false,
 "transaction_type": "PRE_AUTH",
 "gateway_response": {
 "version": "1",
 "type": "INFO",
 "message": "Payment Successful.",
 "code": "INFO0000"
 },
 "merchant_details": {
 "legal_name": "<Merchant Legal Name>",
 "mid": "<DASMID>",
 "merchant_txn_ref": "<transaction ref>",
 "billing_details": {
 "billing_address": {
 "country": "<country code>",
 "email": "<email address>",
 "address1": "<address1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 },
 "shipping_address": {
 "country": "<country code>",
 "email": "<email address>",
 "address1": "<address1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 }
 },
 "device_details": {
 "visited_ip": "<ip address>",
 "customer_ip": "<ip address>",
 }
 },
 "payment_details": {
 "amount": "<amount>",
 "response_code": 0,
 "auth_code": "<auth code>",
 "currency": "<USD>",
 "payment_method": "<payment method>",
 "scheme": "<card scheme>",
 "card": {
 "name": "<card holder name>",
 "number": "<card number>",
 "exp_month": "<expiry month>",
 "exp_year": "<expiry year>"
 }
 },
 "transaction_details": {
 "id": "bdd7e008-93e5-4777-a4f7-6eb2343cce4d",
 "ref": "<ref>",
 "timestamp": "<date and time>",
 "merchant_txn_ref": "<transaction ref>"
 },
 "risk-details": {
 "risk_score": null
 }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ: 認可取引の場合は PRE_AUTH
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID (DASMID)
∟ merchant_txn_ref	加盟店取引参照
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
device_details	デバイスの詳細を含む JSON オブジェクト
∟ visited_ip	決済ページのIPアドレス
∟ customer_ip	カード所有者のIPアドレス
∟ payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の処理通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド (VISA、MASTERCARD、AMEX)
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月 (例: 12 は 12 月)
∟ exp_year	カードの満了年 (例: 24 は 2024 年)
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	加盟店取引参照ID
∟ stored_payment_method_id	保存されている支払方法 ID (トークン)
risk-details	リスクの詳細を含む JSON オブジェクト
∟ risk_score	リスクスコア

購入

Method: 方法

URL : /api/v1/server-to-server-interface/payment

このペイロードにより、購入取引を実行できます

リクエスト属性

{
 "amount":"<amount>",
 "currency": null,
 "card": {
 "cvc": "<cvv>",
 "expiry_month": "<month>",
 "expiry_year": "<year>",
 "name": "<name>",
 "number": "<card number>"
 },
 "merchant_txn_ref" :"<ref>",
 "customer_ip" : "<ip>",
 "merchant_id" : "<DASMID>",
 "return_url":{
 "webhook_url": "",
 "success_url": "",
 "decline_url": ""
 },
 "billing_address":{
 "country": "JP",
 "email": "<email>",
 "address1": "<address 1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 },
 "shipping_address":{
 "country": "JP",
 "email": "<email>",
 "address1": "<address 1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 },
 "time_zone": "Asia/Kuala_Lumpur"
}

属性	タイプ	必須	最大桁数	説明
amount	float/string/int	はい	as per Bank	取引金額。銀行が定めた限度額
currency	string	はい	3	処理通貨の略称（例：日本円：JPY）
card	object	はい	カードの詳細を含む JSON オブジェクト
cvc	string	はい	4	カードのセキュリティコード（3桁、AMEXの場合は４桁）
expiry_month	string	はい	2	カードの満了月
expiry_year	string	はい	2	カードの満了年
name	string	はい	255	カードに記載されているカード所有者の名前
number	string	はい	16	カード番号
merchant_txn_ref	string	はい	45	加盟店取引参照ID
customer_ip	string	はい	45	カード所有者のIPアドレス
merchant_id	string	はい	128	加盟店ID
return_url	object	はい	リターン URL を含む JSON オブジェクト
webhook_url	string	はい	255	Webhook URL リンク
success_url	string	はい	255	決済が成功したURLリンクをリダイレクトします
decline_url	string	はい	255	決済が失敗したURLリンクをリダイレクトします
billing_address	object	はい	カード所有者の請求先住所を含む JSON オブジェクト
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ address1	string	はい	199	カード所有者の請求先住所
∟ phone_number	string	はい	20	カード所有者の請求先電話番号
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
∟ postal_code	string	はい	45	カード所有者の郵便番号
shipping_address	object	いいえ	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ phone	string	はい	20	カード所有者の請求先電話番号
∟ address1	string	はい	199	カード所有者の請求先住所
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
∟ postal_code	string	いいえ	45	カード所有者配送先の郵便番号
∟ time_zone	string	はい	128	取引国のタイムゾーン

レスポンス属性

{
 "success": true,
 "status_code": 201,
 "is_live": false,
 "transaction_type": "CAPTURE",
 "gateway_response": {
 "version": "1",
 "type": "INFO",
 "message": "Payment Successful.",
 "code": "INFO0000"
 },
 "merchant_details": {
 "legal_name": "<Merchant Legal Name>",
 "mid": "<DASMID>",
 "merchant_txn_ref": "<transaction ref>",
 "billing_details": {
 "billing_address": {
 "country": "<country code>",
 "email": "<email address>",
 "address1": "<address1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 },
 "shipping_address": {
 "country": "<country code>",
 "email": "<email address>",
 "address1": "<address1>",
 "phone_number": "<phone number>",
 "city": "<city>",
 "state": "<state>",
 "postal_code": "<postcode>"
 }
 },
 "device_details": {
 "visited_ip": "<ip address>",
 "customer_ip": "<ip address>",
 }
 },
 "payment_details": {
 "amount": "<amount>",
 "response_code": 0,
 "auth_code": "<auth code>",
 "currency": null,
 "payment_method": "<payment method>",
 "scheme": "<card scheme>",
 "card": {
 "name": "<card holder name>",
 "number": "<card number>",
 "exp_month": "<expiry month>",
 "exp_year": "<expiry year>"
 }
 },
 "transaction_details": {
 "id": "bdd7e008-93e5-4777-a4f7-6eb2343cce4d",
 "ref": "<ref>",
 "timestamp": "<date and time>",
 "merchant_txn_ref": "<transaction ref>"
 },
 "risk-details": {
 "risk_score": null
 }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ: 購入取引の場合は CAPTURE
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID (DASMID)
∟ merchant_txn_ref	加盟店取引参照
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
device_details	デバイスの詳細を含む JSON オブジェクト
∟ visited_ip	決済ページのIPアドレス
∟ customer_ip	カード所有者のIPアドレス
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド (VISA、MASTERCARD、AMEX)
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月 (例: 12 は 12 月)
∟ exp_year	カードの満了年 (例: 24 は 2024 年)
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	取引の参照
∟ stored_payment_method_id	保存されている支払方法 ID (トークン)
risk-details	リスクの詳細を含む JSON オブジェクト
∟ risk_score	リスクスコア

キャプチャー

Method: 方法

URL : /api/v1/server-to-server-interface/capture

このペイロードにより、Capture 取引を実行できます。

リクエスト属性

{
 "transactionId": "<transaction id>",
 "amount": "<amount>",
 "merchant_id": "<DASMID>",
 "notes": "<reference>"
}

属性	タイプ	必須	最大桁数	説明
transactionId	string	はい	36	承認済み取引の元ID
amount	Int/String	はい	銀行側が決まった金額	キャプチャーする金額。これは承認された金額を超えてはなりません。金額は銀行側決める
merchant_id	string	はい	10	加盟店ID
notes	string	いいえ	128	取得取引の参照 (オプション)

レスポンス属性

{
 "success": true,
 "status_code": 201,
 "is_live": false,
 "transaction_type": "CAPTURE",
 "gateway_response": {
 "version": "1",
 "type": "INFO",
 "message": "Amount successfully captured.",
 "code": "INFO0001"
 },
 "merchant_details": {
 "legal_name": "<Company Legal Name>",
 "mid": "<DASMID>",
 "merchant_txn_ref": "<transaction ref>"
 },
 "payment_details": {
 "amount": "<amount>",
 "response_code": 0,
 "auth_code": "<auth code>",
 "currency": null,
 "payment_method": "<payment method>",
 "scheme": "<card scheme>",
 "card": {
 "name": "<card holder name>",
 "number": "<card number>",
 "exp_month": "<expiry month>",
 "exp_year": "<expiry year>"
 }
 },
 "transaction_details": {
 "id": "3c7a5eed-1f18-4cf0-8efe-ca0b948073e4",
 "ref": "<ref>",
 "timestamp": "<date and time>",
 "merchant_txn_ref": "<transaction ref>"
 }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ: 許可された取引の場合はCAPTURE
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID (DASMID)
∟ merchant_txn_ref	取引の参照
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド (VISA、MASTERCARD、AMEX)
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月 (例: 12 は 12 月)
∟ exp_year	カードの満了年 (例: 24 は 2024 年)
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	取引の参照

返金

Method: 方法

URL : /api/v1/server-to-server-interface/refund

このペイロードにより、返金取引を実行できます

リクエスト属性

{
 "transactionId": "<transaction id>",
 "amount": "<amount>",
 "merchant_id": "<DASMID>",
 "notes": "<reference>"
}

属性	タイプ	必須	最大桁数	説明
transactionId	string	はい	36	元の取引IDをキャプチャーされた取引
amount	Int/String	はい	銀行側が決まった金額	返金の金額。これは、キャプチャーされた金額を超えてはなりません。銀行が定めた限度額
merchant_id	string	はい	10	加盟店ID
notes	string	いいえ	128	返金の参照（オプション）

レスポンス属性

{
 "success": true,
 "status_code": 201,
 "is_live": false,
 "transaction_type": "REFUND",
 "gateway_response": {
 "version": "1",
 "type": "INFO",
 "message": "Amount successfully refunded.",
 "code": "INFO0002"
 },
 "merchant_details": {
 "legal_name": "<Company Legal Name>",
 "mid": "<DASMID>",
 "merchant_txn_ref": "<transaction ref>"
 },
 "payment_details": {
 "amount": "<amount>",
 "response_code": 0,
 "auth_code": "<auth code>",
 "currency": null,
 "payment_method": "<payment method>",
 "scheme": "<card scheme>",
 "card": {
 "name": "<card holder name>",
 "number": "<card number>",
 "exp_month": "<expiry month>",
 "exp_year": "<expiry year>"
 }
 },
 "transaction_details": {
 "id": "3c7a5eed-1f18-4cf0-8efe-ca0b948073e4",
 "ref": "<ref>",
 "timestamp": "<date and time>",
 "merchant_txn_ref": "<transaction ref>"
 }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ：返金のため、キャプチャーされた取引
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID (DASMID)
∟ merchant_txn_ref	取引参照
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド (VISA、MASTERCARD、AMEX)
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月 (例: 12 は 12 月)
∟ exp_year	カードの満了年 (例: 24 は 2024 年)
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	取引の参照

ボイド認可

Method: 方法

URL : /api/v1/server-to-server-interface/void

このペイロードにより、ボイド取引を実行できます。

リクエスト属性

{
 "transactionId": "<transaction id>",
 "merchant_id": "<DASMID>"
}

属性	タイプ	必須	最大桁数	説明
transactionId	string	はい	36	承認済み取引の元ID
merchant_id	string	はい	10	加盟店ID

レスポンス属性

{
 "success": true,
 "status_code": 201,
 "is_live": false,
 "transaction_type": "VOID",
 "gateway_response": {
 "version": "1",
 "type": "INFO",
 "message": "Amount Successfully Cancelled.",
 "code": "INFO0003"
 },
 "merchant_details": {
 "legal_name": "<Company Legal Name>",
 "mid": "<DASMID>",
 "merchant_txn_ref": "<transaction ref>"
 },
 "payment_details": {
 "amount": "<amount>",
 "response_code": 0,
 "auth_code": "<auth code>",
 "currency": null,
 "payment_method": "<payment method>",
 "scheme": "<card scheme>",
 "card": {
 "name": "<card holder name>",
 "number": "<card number>",
 "exp_month": "<expiry month>",
 "exp_year": "<expiry year>"
 }
 },
 "transaction_details": {
 "id": "3c7a5eed-1f18-4cf0-8efe-ca0b948073e4",
 "ref": "<ref>",
 "timestamp": "<date and time>",
 "merchant_txn_ref": "<transaction ref>"
 }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ: 許可された取引の場合は VOID
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID (DASMID)
∟ merchant_txn_ref	取引の参照
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド (VISA、MASTERCARD、AMEX)
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月 (例: 12 は 12 月)
∟ exp_year	カードの満了年 (例: 24 は 2024 年)
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の認証コード
∟ timestamp	取引日時
∟ merchant_txn_ref	取引の参照

ハンドラー

レスポンスステータス: 取引成功

レスポンス属性

{
 "success": true,
 "status_code": 201,
 "is_live": false,
 "transaction_type": "CAPTURE",
 "gateway_response": {
 "version": "1",
 "type": "INFO",
 "message": "Payment Successful.",
 "code": "INFO0000"
 },
 "return_url_details": {
 "webhook_url": "",
 "success_url": "",
 "decline_url": ""
 },
 "merchant_details": {
 "legal_name": "<Merchant Legal Name>",
 "mid": "<DASMID>",
 "merchant_txn_ref": "<transaction ref>",
 "billing_details": {
 "billing_address": {
 "country": "<country code>",
 "postal_code": "<postcode>",
 "email": "<email address>",
"phone_number": "<phone number>",
 "address1": "<address1>",
"address2": "<address2>",
 "city": "<city>",
"state": "<state>"
 },
 "shipping_address": {
 "country": "<country code>",
"postal_code": "<postcode>",
 "email": "<email address>",
 "phone_number": "<phone number>",
 "address1": "<address1>",
 "address2": "<address2>",
 "city": "<city>",
"state": "<state>"
 }
 },
 },
 "device_details": {
 "visited_ip": "<ip address>",
 "customer_ip": "<ip address>",
 },
 "payment_details": {
 "amount": "<amount>",
 "response_code": 0,
 "auth_code": "<auth code>",
 "currency": null,
 "payment_method": "<payment method>",
 "scheme": "<card scheme>",
 "card": {
 "name": "<card holder name>",
 "number": "<card number>",
 "exp_month": "<expiry month>",
 "exp_year": "<expiry year>"
 }
 },
 "transaction_details": {
 "id": "bdd7e008-93e5-4777-a4f7-6eb2343cce4d",
 "ref": "<ref>",
 "timestamp": "<date and time>",
 "merchant_txn_ref": "<transaction ref>",
 "stored_payment_method_id": "e9df6c8b-5341-4c74-b6a7-3f05468747cd"
 },
 "risk-details": {
 "risk_score": null
 }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false。
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false。
transaction_type	取引タイプ: キャプチャーは購入取引
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
return_url_details	リターンURL の詳細を含む JSON オブジェクト
webhook_url	Webhook URL リンク
success_url	決済が成功したURLリンクをリダイレクトします
decline_url	決済が失敗したURLリンクをリダイレクトします
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID
∟ merchant_txn_ref	加盟店取引参照
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
device_details	デバイスの詳細を含む JSON オブジェクト
∟ visited_ip	決済ページのIPアドレス
∟ customer_ip	カード所有者のIPアドレス
∟ payment_details	決済詳細の取引を含むJSONオブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の処理通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド（VISA、MASTERCARD、AMEX）
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月
∟ exp_year	カードの満了年
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	加盟店取引参照ID
∟ stored_payment_method_id	保存されている支払方法 ID (トークン)
risk-details	リスクの詳細を含む JSON オブジェクト
∟ risk_score	リスクスコア

取引ステータス

Method: 方法

URL : /api/v1/server-to-server-interface/transaction/status/<Transaction Id>

リクエスト属性

属性	タイプ	必須	最大桁数	説明
transactionId	string	yes	36	事前承認、キャプチャ、返金または無効取引の元ID

レスポンス属性

{
    "success": true,
    "status_code": 200,
    "is_live": false,
    "transaction_type": "PRE_AUTH",
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Payment Successful.",
        "code": "INFO0000"
    },
    "merchant_details": {
        "legal_name": "Intersnack Cashew Company Pte. Ltd.",
        "mid": "JP00000328",
        "merchant_txn_ref": "qwe"
    },
    "payment_details": {
        "amount": 2,
        "response_code": 0,
        "responseDescription": "The transaction was completed successfully.",
        "auth_code": "212496",
        "currency": "JPY",
        "payment_method": "ECMC-SSL",
        "scheme": "MASTERCARD",
        "card": {
            "name": "Sharma",
            "number": "545454******5454",
            "exp_month": "12",
            "exp_year": "25"
        }
    },
    "transaction_details": {
        "id": "b2c120f8-6d34-4f8f-a736-b34943dde2d7",
        "ref": 38922,
        "timestamp": "2023-08-09T09:17:43.000Z",
        "billing_details": {
            "billing_address": {
                "country": "JP",
                "email": "test1.test@gmail.com",
                "address1": "47A123",
                "phone_number": "N/A",
                "city": "ACambridge",
                "state": "Cambridgeshire",
                "postal_code": "CB94BQ"
            },
            "shipping_address": {
                "country": "IN",
                "email": "shiptest@test.com",
                "address1": "adfadfdsf",
                "phone_number": "N/A",
                "city": "ACambridge",
                "state": "Cambridgeshire",
                "postal_code": "3534534"
            }
        }
    },
    "risk_details": {
        "risk_score": null
    }
}

属性	説明
success	取引が成功した場合はtrue、失敗した場合はfalse
status_code	取引のステータスコード
is_live	取引が成功した場合はtrue、失敗した場合はfalse
transaction_type	取引タイプ：購入の場合は CAPTURE、承認の場合は PRE_AUTH
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID
∟ merchant_txn_ref	加盟店取引参照
payment_details	支払の詳細を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ responseDescription	取引状態の説明
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド（VISA、MASTERCARD、AMEX）
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月
∟ exp_year	カードの満了年
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
risk-details	リスクの詳細を含む JSON オブジェクト
∟ risk_score	リスクスコア

カードトークンの生成（購入・承認

Method: 方法

URL : /api/v1/server-to-server-interface/payment

このペイロードにより、購入または承認のためのカードトークン (店舗支払方法) を生成できます。

リクエスト属性

{
  "amount":"<amount>",
  "currency": "JPY",
     "card": {
        "cvc": "<cvv>",
        "expiry_month": "<month>",
        "expiry_year": "<year>",
        "name": "<name>",
        "number": "<card number>"
    },
   "payment_method":{
        "type":"scheme",
        "store_payment_method":true
    },
  "merchant_txn_ref" :"<ref>",
  "customer_ip" : "<ip>",
  "merchant_id" : "<DASMID>",
  "return_url":{
    "webhook_url": "",
    "success_url": "",
    "decline_url": ""
  },
  "billing_address":{
    "country": "JP",
    "email": "<email>",
    "address1": "<address 1>",
    "phone_number": "<phone number>",
    "city": "<city>",
    "state": "<state>",
    "postal_code": "<postcode>"
  },
  "shipping_address":{
    "country": "JP",
    "email": "<email>",
    "address1": "<address 1>",
    "phone_number": "<phone number>",
    "city": "<city>",
    "state": "<state>",
    "postal_code": "<postcode>"
  },
  "time_zone": "Asia/Kuala_Lumpur",
  "cardinal_session_id":""
}

属性	タイプ	必須	最大桁数	説明
amount	float/string/int	はい	銀行側が決まった金額	取引金額。銀行が定めた限度額
currency	string	はい	3	処理通貨の略称（例：日本円：JPY）
card	object	はい		カードの詳細を含む JSON オブジェクト
cvc	string	はい	4	カードのセキュリティコード（3桁、AMEXの場合は４桁）
expiry_month	string	はい	2	カードの満了月
expiry_year	string	はい	2	カードの満了年
name	string	はい	255	カードに記載されているカード所有者の名前
number	string	はい	16	カード番号
payment_method	object	はい		支払方法を含む JSON オブジェクト
type	string	はい	128	カードスキーム（VISA、MASTERCARD）
store_payment_method	boolean	はい	5	トークンを生成する場合は True、生成しない場合は False
merchant_txn_ref	string	はい	45	加盟店取引参照ID
customer_ip	string	はい	45	カード所有者の IP アドレス
merchant_id	string	はい	128	加盟店ID
return_url	object	はい		リターン URL を含む JSON オブジェクト
webhook_url	string	はい	255	Webhook URL リンク
success_url	string	はい	255	決済が成功したURLリンクをリダイレクトします
decline_url	string	はい	255	決済が失敗したURLリンクをリダイレクトします
billing_address	object	はい		カード所有者の請求先住所を含む JSON オブジェクト
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ Address1	string	はい	199	カード所有者の請求先住所
∟ phone_number	string	はい	20	カード所有者の請求先電話番号
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
∟ postal_code	string	はい	45	カード所有者の郵便番号
shipping_address	object	いいえ		カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	string	いいえ	2	カード所有者の配送国コード
∟ email	string	いいえ	45	カード所有者の配送先メールアドレス
∟ address1	string	いいえ	199	カード所有者の配送先住所
∟ phone_number	string	いいえ	20	カード所有者の配送先電話番号
∟ city	string	いいえ	65	カード所有者の配送先の都市
∟ state	string	いいえ	65	カード所有者の配送都道府県
∟ postal_code	string	いいえ	45	カード所有者配送先の郵便番号
∟ time_zone	string	はい	128	取引国のタイムゾーン
∟ cardinal_session_id	string	いいえ	128	カーディナルのID

レスポンス属性

{
    "success": true,
    "status_code": 201,
    "is_live": false,
    "transaction_type": "<transaction type>",
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Payment Successful.",
        "code": "INFO0000"
    },
    "merchant_details": {
        "legal_name": "<Merchant Legal Name>",
        "mid": "<DASMID>",
        "merchant_txn_ref": "<transaction ref>",
        "billing_details": {
            "billing_address": {
                "country": "<country code>",
                "email": "<email address>",
                "address1": "<address1>",
                "phone_number": "<phone number>",
                "city": "<city>",
                "state": "<state>",
                "postal_code": "<postcode>"
            },
            "shipping_address": {
                "country": "<country code>",
                "email": "<email address>",
                "address1": "<address1>",
                "phone_number": "<phone number>",
                "city": "<city>",
                "state": "<state>",
                "postal_code": "<postcode>"
            }
        },
        "device_details": {
            "visited_ip": "<ip address>",
            "customer_ip": "<ip address>"
        }
    },
    "payment_details": {
        "amount": "<amount>",
        "response_code": 0,
        "auth_code": "<auth code>",
        "currency": "JPY",
        "payment_method": "<payment method>",
        "scheme": "<card scheme>",
        "card": {
            "name": "<card holder name>",
            "number": "<card number>",
            "exp_month": "<expiry month>",
            "exp_year": "<expiry year>"
        }
    },
    "transaction_details": {
        "id": "bdd7e008-93e5-4777-a4f7-6eb2343cce4d",
        "ref": "<ref>",
        "timestamp": "<date and time>",
        "merchant_txn_ref": "<transaction ref>",
        "stored_payment_method_id": "e9df6c8b-5341-4c74-b6a7-3f05468747cd"
    },
    "risk-details": {
        "risk_score": null
    }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ：購入の場合は CAPTURE、承認の場合は PRE_AUTH
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID
∟ merchant_txn_ref	加盟店の取引参照
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
device_details	デバイスの詳細を含む JSON オブジェクト
∟ visited_ip	決済ページのIPアドレス
∟ customer_ip	カード所有者のIPアドレス
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド（VISA、MASTERCARD、AMEX）
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月
∟ exp_year	カードの満了年
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	加盟店取引参照ID
∟ stored_payment_method_id	リスクの詳細を含む JSON オブジェクト
risk-details	取引ID
∟ risk_score	リスクスコア

カードトークンの利用（購入・認証）

Method: 方法

URL : /api/v1/server-to-server-interface/payment

このペイロードにより、購入または承認にカードトークン (店舗支払方法) を使用できるようになります。

リクエスト属性

{
  "amount":"<amount>",
  "currency": "JPY"
   "payment_method":{
        "type":"scheme",
        "store_payment_method":true,
        "stored_payment_method_id": "e9df6c8b-5341-4c74-b6a7-3f05468747cd"
    },
  "merchant_txn_ref" :"<ref>",
  "customer_ip" : "<ip>",
  "merchant_id" : "<DASMID>",
  "return_url":{
    "webhook_url": "",
    "success_url": "",
    "decline_url": ""
  },
  "billing_address":{
    "country": "JP",
    "email": "<email>",
    "address1": "<address 1>",
    "phone_number": "<phone number>",
    "city": "<city>",
    "state": "<state>",
    "postal_code": "<postcode>"
  },
  "shipping_address":{
    "country": "JP",
    "email": "<email>",
    "address1": "<address 1>",
    "phone_number": "<phone number>",
    "city": "<city>",
    "state": "<state>",
    "postal_code": "<postcode>"
  },
  "time_zone": "Asia/Kuala_Lumpur",
  "cardinal_session_id":""
}

属性	タイプ	必須	最大桁数	説明
amount	float/string/int	はい	銀行側が決まった金額	取引金額。銀行が定めた限度額
currency	string	はい	3	処理通貨の略称（例：日本円：JPY）
payment_method	object	はい		支払方法を含む JSON オブジェクト
type	string	はい	128	カードスキーム　（VISA, MASTERCARD）
store_payment_method	boolean	はい	5	トークンを生成する場合は True、生成しない場合は False
stored_payment_method_id	string	はい	128	保存されている支払方法 ID (トークン)
merchant_txn_ref	string	はい	45	加盟店取引参照ID
customer_ip	string	はい	45	カード所有者の IP アドレス
merchant_id	string	はい	128	加盟店ID
return_url	object	はい		リターン URL を含むJSONオブジェクト
webhook_url	string	はい	255	Webhook URL リンク
success_url	string	はい	255	決済が成功したURLリンクをリダイレクトします
decline_url	string	はい	255	決済が失敗したURLリンクをリダイレクトします
billing_address	object	はい		カード所有者の請求先住所を含む JSON オブジェクト
∟ country	string	はい	2	カード所有者の請求国コード
∟ email	string	はい	45	カード所有者の請求先メールアドレス
∟ Address1	string	はい	199	カード所有者の請求先住所
∟ phone_number	string	はい	20	カード所有者の請求先電話番号
∟ city	string	はい	65	カード所有者の請求先の都市
∟ state	string	はい	65	カード所有者の請求先都道府県
∟ postal_code	string	はい	45	カード所有者の郵便番号
shipping_address	object	いいえ		カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	string	いいえ	2	カード所有者の配送国コード
∟ email	string	いいえ	45	カード所有者の配送先メールアドレス
∟ address1	string	いいえ	199	カード所有者の配送先住所
∟ phone_number	string	いいえ	20	カード所有者の配送先電話番号
∟ city	string	いいえ	65	カード所有者の配送先の都市
∟ state	string	いいえ	65	カード所有者の配送都道府県
∟ postal_code	string	いいえ	45	カード所有者配送先の郵便番号
∟ time_zone	string	はい	128	取引国のタイムゾーン
∟ cardinal_session_id	string	いいえ	128	カーディナルのID

レスポンス属性

{
    "success": true,
    "status_code": 201,
    "is_live": false,
    "transaction_type": "<transaction type>",
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Payment Successful.",
        "code": "INFO0000"
    },
    "merchant_details": {
        "legal_name": "<Merchant Legal Name>",
        "mid": "<DASMID>",
        "merchant_txn_ref": "<transaction ref>",
        "billing_details": {
            "billing_address": {
                "country": "<country code>",
                "email": "<email address>",
                "address1": "<address1>",
                "phone_number": "<phone number>",
                "city": "<city>",
                "state": "<state>",
                "postal_code": "<postcode>"
            },
            "shipping_address": {
                "country": "<country code>",
                "email": "<email address>",
                "address1": "<address1>",
                "phone_number": "<phone number>",
                "city": "<city>",
                "state": "<state>",
                "postal_code": "<postcode>"
            }
        },
        "device_details": {
            "visited_ip": "<ip address>",
            "customer_ip": "<ip address>"
        }
    },
    "payment_details": {
        "amount": "<amount>",
        "response_code": 0,
        "auth_code": "<auth code>",
        "currency": "JPY",
        "payment_method": "<payment method>",
        "scheme": "<card scheme>",
        "card": {
            "name": "<card holder name>",
            "number": "<card number>",
            "exp_month": "<expiry month>",
            "exp_year": "<expiry year>"
        }
    },
    "transaction_details": {
        "id": "bdd7e008-93e5-4777-a4f7-6eb2343cce4d",
        "ref": "<ref>",
        "timestamp": "<date and time>",
        "merchant_txn_ref": "<transaction ref>",
        "stored_payment_method_id": "e9df6c8b-5341-4c74-b6a7-3f05468747cd"
    },
    "risk-details": {
        "risk_score": null
    }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false。
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false。
transaction_type	取引タイプ：購入の場合は CAPTURE、承認の場合は PRE_AUTH
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID
∟ merchant_txn_ref	加盟店取引参照
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
∟ device_details	デバイスの詳細を含む JSON オブジェクト
∟ visited_ip	決済ページのIPアドレス
∟ customer_ip	カード所有者のIPアドレス
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド（VISA、MASTERCARD、AMEX）
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月
∟ exp_year	カードの満了年
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	加盟店取引参照ID
∟ stored_payment_method_id	保存されている支払方法 ID (トークン)
risk-details	リスクの詳細を含む JSON オブジェクト
∟ risk_score	リスクスコア

サブスクリプションの作成

Method: 方法

URL : /api/v1/server-to-server-interface/subscription/payment

このペイロードにより、サブスクリプション取引を実行できます。

リクエスト属性

{
  "amount":"<amount>",
  "currency": "JPY",
     "card": {
        "cvc": "<cvv>",
        "expiry_month": "<month>",
        "expiry_year": "<year>",
        "name": "<name>",
        "number": "<card number>"
    },
  "merchant_txn_ref" :"<ref>",
  "customer_ip" : "<ip>",
  "merchant_id" : "<DASMID>",
  "return_url":{
    "webhook_url": "",
    "success_url": "",
    "decline_url": ""
  },
  "billing_address":{
    "country": "JP",
    "email": "<email>",
    "address1": "<address 1>",
    "phone_number": "<phone number>",
    "city": "<city>",
    "state": "<state>",
    "postal_code": "<postcode>"
  },
  "shipping_address":{
    "country": "JP",
    "email": "<email>",
    "address1": "<address 1>",
    "phone_number": "<phone number>",
    "city": "<city>",
    "state": "<state>",
    "postal_code": "<postcode>"
  },
  "time_zone": "Asia/Kuala_Lumpur",
  "cardinal_session_id":"0_c7baff9e-d91a-4215-93e2-0b5fb8d41512",
    "subscription": {
        "plan_name": "Two day plan",
        "plan_desc": "Two day plan",
        "cycle_type": "DAYS",
        "subscription_end_type": "CYCLE",
        "cycle_interval": 1,
        "max_cycle_count": 2,
        "has_trial_period": false,
        "trial_period_duration_type": "DAYS",
        "trial_period_duration": 10,
        "has_discount": true,
        "discount_percentage": 10,
        "discount_duration": 1
    }

}

属性	タイプ	必須	最大桁数	説明
amount	float/string/int	はい	銀行側が決まった金額	取引金額。銀行が定めた限度額。
currency	string	はい	3	処理通貨の略称（例：日本円：JPY）。
card	object	はい		カードの詳細を含む JSON オブジェクト。
cvc	string	はい	4	カードのセキュリティコード（3桁、AMEXの場合は４桁）。
expiry_month	string	はい	2	カードの有効期限月。
expiry_year	string	はい	2	カードの有効期限年。
name	string	はい	255	カードに記載されているカード所有者の名前。
number	string	はい	16	カード番号。
merchant_txn_ref	string	はい	45	加盟店取引参照ID。
customer_ip	string	はい	45	カード所有者の IP アドレス。
merchant_id	string	はい	128	加盟店ID。
return_url	object	はい		リターン URL を含む JSON オブジェクト。
webhook_url	string	はい	255	Webhook URL リンク。
success_url	string	はい	255	決済が成功したURLリンクをリダイレクトします。
decline_url	string	はい	255	決済が失敗したURLリンクをリダイレクトします。
billing_address	object	はい		カード所有者の請求先住所を含む JSON オブジェクト。
∟ country	string	はい	2	カード所有者の請求国コード。
∟ email	string	はい	45	カード所有者の請求先メールアドレス。
∟ Address1	string	はい	199	カード所有者の請求先住所。
∟ phone_number	string	はい	20	カード所有者の請求先電話番号。
∟ city	string	はい	65	カード所有者の請求先の都市。
∟ state	string	はい	65	カード所有者の請求先都道府県。
∟ postal_code	string	はい	45	カード所有者の郵便番号。
shipping_address	object	いいえ		カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	string	いいえ	2	カード所有者の配送国コード。
∟ email	string	いいえ	45	カード所有者の配送先メールアドレス。
∟ address1	string	いいえ	199	カード所有者の配送先住所。
∟ phone_number	string	いいえ	20	カード所有者の配送先電話番号。
∟ city	string	いいえ	65	カード所有者の配送先の都市。
∟ state	string	いいえ	65	カード所有者の配送都道府県。
∟ postal_code	string	いいえ	45	カード所有者配送先の郵便番号。
∟ time_zone	string	はい	128	取引国のタイムゾーン。
∟ cardinal_session_id	string	はい	128	カーディナルのID（３D取引）（３DS取引だけが必須）。
∟ subscription	object	はい		サブスクリプションを含む JSON オブジェクト。
∟ plan_name	string	はい	100	プラン名。
∟ plan_desc	string	はい	200	プランの説明。
∟ cycle_type	string	はい	Constant	サイクルタイプ（日・月）。
∟ subscription_end_type	string	はい	Constant	サブスクリプションタイプ（サイクル：サイクル数を定義する場合）それ以外の場合は無限になります。
∟ cycle_interval	int	はい	9999	サイクル間隔の数がある場合 (サブスクリプションタイプ: CYCLE)が必須。
∟ max_cycle_count	int	はい	9999	サブスクリプションのサイクル数 (サブスクリプションタイプ: CYCLE)が必須。
∟ has_trial_period	boolean	はい	5	サブスクリプションに試用期間がある場合は True。
∟ trial_period_duration_type	string	はい	Constant	試用期間のタイプがある場合 (DAYS、MONTHS) (has_trial_period: True)が必須。
∟ trial_period_duration	int	はい	9999	試用期間の期間がある場合(has_trial_period: True)が必須。
∟ has_discount	boolean	はい	5	サブスクリプションに割引がある場合は True。
∟ discount_percentage	int/float	はい	100%	割引率がある場合(has_discount: True)が必須。
∟ discount_duration	int	はい	9999	割引期間がある場合 (has_discount: True)が必須。

レスポンス属性

{
    "success": true,
    "status_code": 201,
    "is_live": false,
    "transaction_type": "CAPTURE",
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Payment Successful.",
        "code": "INFO0000"
    },
    "merchant_details": {
        "legal_name": "<Merchant Legal Name>",
        "mid": "<DASMID>",
        "merchant_txn_ref": "<transaction ref>",
        "billing_details": {
            "billing_address": {
                "country": "<country code>",
                "email": "<email address>",
                "address1": "<address1>",
                "phone_number": "<phone number>",
                "city": "<city>",
                "state": "<state>",
                "postal_code": "<postcode>"
            },
            "shipping_address": {
                "country": "<country code>",
                "email": "<email address>",
                "address1": "<address1>",
                "phone_number": "<phone number>",
                "city": "<city>",
                "state": "<state>",
                "postal_code": "<postcode>"
            }
        },
        "device_details": {
            "visited_ip": "<ip address>",
            "customer_ip": "<ip address>"
        }
    },
    "payment_details": {
        "amount": "<amount>",
        "response_code": 0,
        "auth_code": "<auth code>",
        "currency": "JPY",
        "payment_method": "<payment method>",
        "scheme": "<card scheme>",
        "card": {
            "name": "<card holder name>",
            "number": "<card number>",
            "exp_month": "<expiry month>",
            "exp_year": "<expiry year>"
        }
    },
    "transaction_details": {
        "id": "bdd7e008-93e5-4777-a4f7-6eb2343cce4d",
        "ref": "<ref>",
        "timestamp": "<date and time>",
        "merchant_txn_ref": "<transaction ref>",
        "stored_payment_method_id": null
    },
    "risk-details": {
        "risk_score": null
    },
    "subscription_details": {
        "id": "da39cae4-cf29-4e64-9438-1a7d0a76d4c3",
        "type": "CYCLE",
        "max_cycle_count": 2,
        "status": "ACTIVE",
        "completed_payment_cycle": 1,
        "next_payment_date": "2023-08-29T05:25:24.094Z",
        "next_payment_cycle": 2,
        "subscription_plan_details": {
            "name": "Two day plan",
            "desc": "Two day plan",
            "billing_cycle_type": "DAYS",
            "billing_cycle_interval": 1,
            "amount": 1000,
            "ccy": "JPY",
            "trial_period_duration": "",
            "trial_period_duration_type": "NONE",
            "plan_discount_percentage": 10,
            "plan_discount_duration": 1
        }
    }
}

属性	説明
success	成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
transaction_type	取引タイプ：購入取引はCAPTURE
gateway_response	ゲートウェイからのレスポンスを含む JSON オブジェクト
version	ゲートウェイのバージョン
type	レスポンスのタイプ、INFOは情報参照
message	ゲートウェイからのメッセージレスポンス
code	レスポンスのメッセージコード
merchant_details	加盟店の詳細を含む JSON オブジェクト
∟ legal_name	加盟店の正式名称
∟ mid	加盟店ID
∟ merchant_txn_ref	加盟店取引参照
billing_details	請求の詳細を含む JSON オブジェクト
∟ billing_address	請求先住所を含む JSON オブジェクト
∟ country	カード所有者の請求国コード
∟ email	カード所有者の請求先メールアドレス
∟ address1	カード所有者の請求先住所
∟ phone_number	カード所有者の請求先電話番号
∟ city	カード所有者の請求先の都市
∟ state	カード所有者の請求先都道府県
∟ postal_code	カード所有者の郵便番号
∟ shipping_address	カード所有者の配送先住所を含む JSON オブジェクト。このオブジェクトはオプションです。
∟ country	カード所有者の配送国コード
∟ email	カード所有者の配送先メールアドレス
∟ address1	カード所有者の配送先住所
∟ phone_number	カード所有者の配送先電話番号
∟ city	カード所有者の配送先の都市
∟ state	カード所有者の配送都道府県
∟ postal_code	カード所有者配送先の郵便番号
device_details	デバイスの詳細を含む JSON オブジェクト
∟ visited_ip	決済ページのIPアドレス
∟ customer_ip	カード所有者のIPアドレス
payment_details	決済詳細の取引を含む JSON オブジェクト
∟ amount	取引金額
∟ response_code	取得者のレスポンスコード
∟ auth_code	取得者承認コード
∟ currency	取引の通貨
∟ payment_method	支払いカードの種類: クレジットカードまたはデビットカード
∟ scheme	カードブランド（VISA、MASTERCARD、AMEX）
∟ card	カードの詳細を含む JSON オブジェクト
∟ name	カードに記載されているカード所有者の名前
∟ number	カード番号
∟ exp_month	カードの満了月
∟ exp_year	カードの満了年
transaction_details	取引の詳細を含む JSON オブジェクト
∟ id	取引ID
∟ ref	取引の承認コード
∟ timestamp	取引日時
∟ merchant_txn_ref	加盟店取引参照ID
∟ stored_payment_method_id	保存されている支払方法 ID (トークン)
risk-details	リスクの詳細を含む JSON オブジェクト
∟ risk_score	リスクスコア
subscription_details	サブスクリプションの詳細を含む JSON オブジェクト
∟ id	サブスクリプションID
∟ type	サブスクリプションのタイプ (CYCLE または Unlimited)
∟ max_cycle_count	最大サイクル数
∟ status	サブスクリプションのステータス
∟ completed_payment_cycle	完了した支払サイクルの数
∟ next_payment_date	次回のサブスクリプションの支払日
∟ next_payment_cycle	次の支払サイクル番号
subscription_plan_details	サブスクリプションプランの詳細を含む JSON オブジェクト
∟ name	サブスクリプションプランの名前
∟ desc	サブスクリプションプランの説明
∟ billing_cycle_type	サイクルのタイプ（日・月)
∟ billing_cycle_interval	サイクル間隔の数
∟ amount	サブスクリプションプランの支払金額
∟ ccy	サブスクリプション取引の通貨
∟ trial_period_duration	試用期間の期間 (has_trial_period: True の場合)
∟ trial_period_duration_type	試用期間のタイプ (DAYS、MONTHS) (has_trial_period: True の場合)
∟ plan_discount_percentage	割引率 (has_discount: True)
∟ plan_discount_duration	割引期間 (has_discount: True)

サブスクリプションリスト

Method: 方法

URL : /api/v1/server-to-server-interface/subscription/list

この URL には、すべてのサブスクリプション取引のリストが表示されます。

レスポンス属性

{
    "success": true,
    "status_code": 200,
    "is_live": false,
    "subscription_details": [
        {
            "id": "0a0a8fe3-a084-48d2-becf-9926d9dbdaf3",
            "type": "CYCLE",
            "max_cycle_count": 2,
            "status": "ACTIVE",
            "completed_payment_cycle": 1,
            "last_payment_status": "SUCCESSFUL",
            "next_payment_date": "2023-09-23T13:44:18.647Z",
            "next_payment_cycle": 2,
            "subscription_plan_details": {
                "name": "Two day plan",
                "desc": "Two day plan",
                "billing_cycle_type": "MONTHLY",
                "billing_cycle_interval": "",
                "amount": 101,
                "ccy": "JPY",
                "trial_period_duration": "",
                "trial_period_duration_type": "NONE",
                "plan_discount_percentage": "",
                "plan_discount_duration": ""
            },
            "subscription_transcation_details": [
                {
                    "id": "c853f15e-4464-4a4d-b1ea-045c6362684c",
                    "ref": 40453,
                    "cycle": 1,
                    "status": "PENDING",
                    "transaction_date": "2023-08-24T13:44:19.000Z",
                    "amount": 101,
                    "ccy": "JPY",
                    "event": "AUTHORISED"
                }
            ]
        }
    ]
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false。
status_code	取引のステータスコード。
is_live	ライブ取引の場合は true。テスト取引の場合は false。
subscription_details	複数のサブスクリプションを含むことができるサブスクリプション詳細を含む JSON オブジェクト。
∟ id	サブスクリプションID。
∟ type	サブスクリプションのタイプ (CYCLE または Unlimited)。
∟ max_cycle_count	最大サイクル数。
∟ status	サブスクリプションのステータス。
∟ completed_payment_cycle	完了した支払サイクルの数。
∟ next_payment_date	次回のサブスクリプションの支払日。
∟ next_payment_cycle	次の支払サイクル番号。
subscription_plan_details	サブスクリプションプランの詳細を含む JSON オブジェクト。
∟ name	サブスクリプションプランの名前。
∟ desc	サブスクリプションプランの説明。
∟ billing_cycle_type	サイクルのタイプ (DAYS/MONTHS)。
∟ billing_cycle_interval	サイクル間隔の数。
∟ amount	サブスクリプションプランの支払金額。
∟ ccy	サブスクリプション取引の通貨。
∟ trial_period_duration	試用期間の期間 (has_trial_period: True の場合)。
∟ trial_period_duration_type	試用期間のタイプ (DAYS、MONTHS) (has_trial_period: True の場合)。
∟ plan_discount_percentage	割引率 (has_discount: True の場合)。
∟ plan_discount_duration	割引期間 (has_discount: True の場合)。
Subscription_transaction_details	複数のサブスクリプション取引を含むことができるサブスクリプションの詳細を含む JSON オブジェクト。
∟ id	このサブスクリプション取引の取引ID。
∟ ref	サブスクリプション取引の参照。
∟ cycle	サブスクリプションの支払いサイクル数。
∟ status	サブスクリプション取引のステータス。
∟ transaction_date	サブスクリプション取引の日付。
∟ amount	サブスクリプション取引の支払金額。
∟ ccy	サブスクリプション取引の通貨。
∟ event	サブスクリプション取引のイベント。

サブスクリプション詳細

Method: 方法

URL : /api/v1/server-to-server-interface/subscription/<Subscription Id>

この URL には、サブスクリプション ID ごとにサブスクリプション取引の詳細が表示されます。

リクエスト属性

属性	タイプ	必須	最大桁数	説明
Subscription ID	string	はい	36	サブスクリプションID

レスポンス属性

{
    "success": true,
    "status_code": 200,
    "is_live": false,
    "subscription_details": [
        {
            "id": "0a0a8fe3-a084-48d2-becf-9926d9dbdaf3",
            "type": "CYCLE",
            "max_cycle_count": 2,
            "status": "ACTIVE",
            "completed_payment_cycle": 1,
            "last_payment_status": "SUCCESSFUL",
            "next_payment_date": "2023-09-23T13:44:18.647Z",
            "next_payment_cycle": 2,
            "subscription_plan_details": {
                "name": "Two day plan",
                "desc": "Two day plan",
                "billing_cycle_type": "MONTHLY",
                "billing_cycle_interval": "",
                "amount": 101,
                "ccy": "JPY",
                "trial_period_duration": "",
                "trial_period_duration_type": "NONE",
                "plan_discount_percentage": "",
                "plan_discount_duration": ""
            },
            "subscription_transcation_details": [
                {
                    "id": "c853f15e-4464-4a4d-b1ea-045c6362684c",
                    "ref": 40453,
                    "cycle": 1,
                    "status": "PENDING",
                    "transaction_date": "2023-08-24T13:44:19.000Z",
                    "amount": 101,
                    "ccy": "JPY",
                    "event": "AUTHORISED"
                }
            ]
        }
    ]
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
subscription_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプションID
∟ type	サブスクリプションのタイプ (CYCLE または Unlimited)
∟ max_cycle_count	最大サイクル数
∟ status	サブスクリプションのステータス
∟ completed_payment_cycle	完了した支払サイクルの数
∟ next_payment_date	次回のサブスクリプションの支払日
∟ next_payment_cycle	次の支払サイクル番号
subscription_plan_details	サブスクリプションプランの詳細を含む JSON オブジェクト
∟ name	サブスクリプションプランの名前
∟ desc	サブスクリプションプランの説明
∟ billing_cycle_type	サイクルのタイプ（日・月)
∟ billing_cycle_interval	サイクル間隔の数
∟ amount	サブスクリプションプランの支払金額
∟ ccy	サブスクリプション取引の通貨
∟ trial_period_duration	試用期間の期間 (has_trial_period: True の場合)
∟ trial_period_duration_type	試用期間のタイプ (DAYS、MONTHS) (has_trial_period: True の場合)
∟ plan_discount_percentage	割引率 (has_discount: True の場合)
∟ plan_discount_duration	割引期間 (has_discount: True の場合)
subscription_transaction_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプション取引のID
∟ ref	サブスクリプション取引の参照
∟ cycle	サブスクリプションの支払いサイクル数
∟ status	サブスクリプション取引のステータス
∟ transaction_date	サブスクリプション取引の日付
∟ amount	サブスクリプション取引の支払金額
∟ ccy	サブスクリプション取引の通貨
∟ event	サブスクリプション取引イベント

サブスクリプションを一時停止

Method: 方法

URL : /api/v1/server-to-server-interface/subscription/<Subscription ID>/pause

リクエスト属性

属性	タイプ	必須	最大桁数	説明
Subscription ID	string	はい	36	サブスクリプションID

レスポンス属性

{
    "success": true,
    "status_code": 200,
    "is_live": false,
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Subscription Updated.",
        "code": "INFO3000"
    },
    "subscription_details": {
        "id": "da39cae4-cf29-4e64-9438-1a7d0a76d4c3",
        "type": "CYCLE",
        "max_cycle_count": 2,
        "status": "PAUSED",
        "completed_payment_cycle": 1,
        "last_payment_status": "SUCCESSFUL",
        "next_payment_date": "2023-08-29T05:25:24.094Z",
        "next_payment_cycle": 2,
        "subscription_plan_details": {
            "name": "Two day plan",
            "desc": "Two day plan",
            "billing_cycle_type": "DAYS",
            "billing_cycle_interval": 1,
            "amount": 1000,
            "ccy": "JPY",
            "trial_period_duration": "",
            "trial_period_duration_type": "NONE",
            "plan_discount_percentage": 10,
            "plan_discount_duration": 1
        },
        "subscription_transcation_details": [
            {
                "id": "ca72d9a9-ba1a-432b-9c53-b21fac13cea3",
                "ref": 40842,
                "cycle": 1,
                "status": "SUCCESSFUL",
                "transaction_date": "2023-08-28T05:25:24.000Z",
                "amount": 900,
                "ccy": "JPY",
                "event": "CAPTURED"
            }
        ]
    }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
subscription_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプションID
∟ type	サブスクリプションのタイプ (CYCLE または Unlimited)
∟ max_cycle_count	最大サイクル数
∟ status	サブスクリプションのステータス
∟ completed_payment_cycle	完了した支払サイクルの数
∟ next_payment_date	次回のサブスクリプションの支払日
∟ next_payment_cycle	次の支払サイクル番号
subscription_plan_details	サブスクリプションプランの詳細を含む JSON オブジェクト
∟ name	サブスクリプションプランの名前
∟ desc	サブスクリプションプランの説明
∟ billing_cycle_type	サイクルのタイプ（日・月)
∟ billing_cycle_interval	サイクル間隔の数
∟ amount	サブスクリプションプランの支払金額
∟ ccy	サブスクリプション取引の通貨
∟ trial_period_duration	試用期間の期間 (has_trial_period: True の場合)
∟ trial_period_duration_type	試用期間のタイプ (DAYS、MONTHS) (has_trial_period: True の場合)
∟ plan_discount_percentage	割引率 (has_discount: True の場合)
∟ plan_discount_duration	割引期間 (has_discount: True の場合)
subscription_transaction_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプション取引のID
∟ ref	サブスクリプション取引の参照
∟ cycle	サブスクリプションの支払いサイクル数
∟ status	サブスクリプション取引のステータス
∟ transaction_date	サブスクリプション取引の日付
∟ amount	サブスクリプション取引の支払金額
∟ ccy	サブスクリプション取引の通貨
∟ event	サブスクリプション取引イベント

サブスクリプションを再開

Method: 方法

URL : /api/v1/server-to-server-interface/subscription/<Subscription ID>/resume

リクエスト属性

属性	タイプ	必須	最大桁数	説明
Subscription ID	string	はい	36	サブスクリプションID

レスポンス属性

{
    "success": true,
    "status_code": 200,
    "is_live": false,
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Subscription Updated.",
        "code": "INFO3000"
    },
    "subscription_details": {
        "id": "da39cae4-cf29-4e64-9438-1a7d0a76d4c3",
        "type": "CYCLE",
        "max_cycle_count": 2,
        "status": "ACTIVE",
        "completed_payment_cycle": 1,
        "last_payment_status": "SUCCESSFUL",
        "next_payment_date": "2023-08-29T05:25:24.094Z",
        "next_payment_cycle": 2,
        "subscription_plan_details": {
            "name": "Two day plan",
            "desc": "Two day plan",
            "billing_cycle_type": "DAYS",
            "billing_cycle_interval": 1,
            "amount": 1000,
            "ccy": "JPY",
            "trial_period_duration": "",
            "trial_period_duration_type": "NONE",
            "plan_discount_percentage": 10,
            "plan_discount_duration": 1
        },
        "subscription_transcation_details": [
            {
                "id": "ca72d9a9-ba1a-432b-9c53-b21fac13cea3",
                "ref": 40842,
                "cycle": 1,
                "status": "SUCCESSFUL",
                "transaction_date": "2023-08-28T05:25:24.000Z",
                "amount": 900,
                "ccy": "JPY",
                "event": "CAPTURED"
            }
        ]
    }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
subscription_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプションID
∟ type	サブスクリプションのタイプ (CYCLE または Unlimited)
∟ max_cycle_count	最大サイクル数
∟ status	サブスクリプションのステータス
∟ completed_payment_cycle	完了した支払サイクルの数
∟ next_payment_date	次回のサブスクリプションの支払日
∟ next_payment_cycle	次の支払サイクル番号
∟ subscription_plan_details	サブスクリプションプランの詳細を含む JSON オブジェクト
∟ name	サブスクリプションプランの名前
∟ desc	サブスクリプションプランの説明
∟ billing_cycle_type	サイクルのタイプ（日・月)
∟ billing_cycle_interval	サイクル間隔の数
∟ amount	サブスクリプションプランの支払金額
∟ ccy	サブスクリプション取引の通貨
∟ trial_period_duration	試用期間の期間 (has_trial_period: True の場合)
∟ trial_period_duration_type	試用期間のタイプ (DAYS、MONTHS) (has_trial_period: True の場合)
∟ plan_discount_percentage	割引率 (has_discount: True の場合)
∟ plan_discount_duration	割引期間 (has_discount: True の場合)
subscription_transaction_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプション取引のID
∟ ref	サブスクリプション取引の参照
∟ cycle	サブスクリプションの支払いサイクル数
∟ status	サブスクリプション取引のステータス
∟ transaction_date	サブスクリプション取引の日付
∟ amount	サブスクリプション取引の支払金額
∟ ccy	サブスクリプション取引の通貨
∟ event	サブスクリプション取引イベント

サブスクリプションをキャンセル

Method: 方法

URL : /api/v1/server-to-server-interface/subscription/<Subscription ID>/cancel

リクエスト属性

属性	タイプ	必須	最大桁数	説明
Subscription ID	string	はい	36	サブスクリプションID

レスポンス属性

{
    "success": true,
    "status_code": 200,
    "is_live": false,
    "gateway_response": {
        "version": "1",
        "type": "INFO",
        "message": "Subscription Updated.",
        "code": "INFO3000"
    },
    "subscription_details": {
        "id": "da39cae4-cf29-4e64-9438-1a7d0a76d4c3",
        "type": "CYCLE",
        "max_cycle_count": 2,
        "status": "CANCELLED",
        "completed_payment_cycle": 1,
        "last_payment_status": "SUCCESSFUL",
        "next_payment_date": "2023-08-29T05:25:24.094Z",
        "next_payment_cycle": 2,
        "subscription_plan_details": {
            "name": "Two day plan",
            "desc": "Two day plan",
            "billing_cycle_type": "DAYS",
            "billing_cycle_interval": 1,
            "amount": 1000,
            "ccy": "JPY",
            "trial_period_duration": "",
            "trial_period_duration_type": "NONE",
            "plan_discount_percentage": 10,
            "plan_discount_duration": 1
        },
        "subscription_transcation_details": [
            {
                "id": "ca72d9a9-ba1a-432b-9c53-b21fac13cea3",
                "ref": 40842,
                "cycle": 1,
                "status": "SUCCESSFUL",
                "transaction_date": "2023-08-28T05:25:24.000Z",
                "amount": 900,
                "ccy": "JPY",
                "event": "CAPTURED"
            }
        ]
    }
}

属性	説明
success	取引が成功した場合は true。失敗した場合は false
status_code	取引のステータスコード
is_live	ライブ取引の場合は true。テスト取引の場合は false
subscription_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプションID
∟ type	サブスクリプションのタイプ (CYCLE または Unlimited)
∟ max_cycle_count	最大サイクル数
∟ status	サブスクリプションのステータス
∟ completed_payment_cycle	完了した支払サイクルの数
∟ next_payment_date	次回のサブスクリプションの支払日
∟ next_payment_cycle	次の支払サイクル番号
subscription_plan_details	サブスクリプションプランの詳細を含む JSON オブジェクト
∟ name	サブスクリプションプランの名前
∟ desc	サブスクリプションプランの説明
∟ billing_cycle_type	サイクルのタイプ（日・月)
∟ billing_cycle_interval	サイクル間隔の数
∟ amount	サブスクリプションプランの支払金額
∟ ccy	サブスクリプション取引の通貨
∟ trial_period_duration	試用期間の期間 (has_trial_period: True の場合)
∟ trial_period_duration_type	試用期間のタイプ (DAYS、MONTHS) (has_trial_period: True の場合)
∟ plan_discount_percentage	割引率 (has_discount: True の場合)
∟ plan_discount_duration	割引期間 (has_discount: True の場合)
subscription_transaction_details	サブスクリプションの詳細を含む JSON オブジェクト (複数のサブスクリプションを含めることができます)
∟ id	サブスクリプション取引のID
∟ ref	サブスクリプション取引の参照
∟ cycle	サブスクリプションの支払いサイクル数
∟ status	サブスクリプション取引のステータス
∟ transaction_date	サブスクリプション取引の日付
∟ amount	サブスクリプション取引の支払金額
∟ ccy	サブスクリプション取引の通貨
∟ event	サブスクリプション取引イベント

ゲートウエイコード

HTTPレスポンス

ゲートウェイから返された HTTP レスポンスコードで、要求のステータスを示します。

HTTPレスポンス	説明
200	リクエスト成功
201	リソース作成
400	不正なリクエスト
401	無許可
404	見つかりません
406	不可（無効なカード）
412	前提条件が失敗しました
500	サーバーエラー
502	ゲートウェイが悪い
504	Gateway Time-out

レスポンスコード

ゲートウェイから返された、リクエストのステータスを示すレスポンスコード

レスポンスコード	説明
-1	DASゲートウエイエラー
0	支払成功
1	カード発行会社または紹介された通話承認センターに問い合わせてください
2	カード発行会社特約参照
3	無効な加盟店またはサービスプロバイダ
4	カードをキャプチャまたは拒否された保持カード
5	承諾しない、または却下
6	エラー
7	署名の失敗
8	IDで取引を承認します
10	一部承認
12	無効な取引
13	無効な金額 (通貨換算のオーバーフロー)
14	無効なカード番号または無効な口座番号 (番号が存在しません)
15	発行者が無効
19	取引を再入力
20	エラーまたはノーアクション（取り消すことができません）
25	ファイルまたはアカウントでレコードが見つかりません
28	ファイルは一時的に利用できません
30	フォーマットエラーまたはエラー
34	詐欺の疑い
39	クレジット口座なし
41	紛失カードまたはピックアップカード（紛失カード）
43	盗まれたカードまたはピックアップカード (盗まれたカード)
51	資金不足または与信限度額超過
52	当座預金口座なし
53	普通預金口座なし
54	期限切れのカードまたは拒否された期限切れのカード
55	無効な PIN またはエラー
57	発行者/カード所有者に許可されていない取引
58	取得者/端末に許可されていない取引
59	詐欺の疑い（ビザ）
61	出金限度額を超えた
62	制限付きカード (国の除外表内)
63	認証できませんまたはエラー
64	承認できません
65	引き出し回数の制限を超えているか、認証が要求されています
68	タイムアウト
70	カード発行者を連絡ください
71	PIN が変更されていません
75	PIN 試行の許容回数を超えました
76	無効/存在しない
77	無効/存在しない
78	無効または存在しないアカウント（一般）
79	すでに取り消されている (Visa) またはライフサイクル理由 (Mastercard)
80	Visa 取引: クレジット発行会社は利用できません
82	陰性 CAM dCVViCVVまたは CVV の結果 (Visa) またはポリシー (Mastercard)
83	STIP が承認できない (Visa) または不正セキュリティ関連 (Mastercard)
84	無効な認証ライフサイクル
85	拒否されていません。 AVS のみの残高に有効またはリクエストを拒否する理由がない
86	PIN を確認できません
88	承認できません
89	PIN が受け入れられない - 取引が拒否された - 再試行するか、受け取る資格がない
91	認可システムまたは発行者システムが動作不能または認可システムまたは発行者システムが動作不能
92	取引をルーティングできない、またはルーティングの宛先が見つからない
93	法律違反で取引が完了できない
94	重複送信が見つかりました
96	システムエラーまたは認証できない
98	エラー
99	エラー
397	Visaで許可されていない追加料金
398	追加料金には対応していません
442	リクエストメッセージCAFISに登録されていません
443	CAFIS システムエラー。再試行してください
444	取得者システムが忙しいです。再試行してください
445	取得者システムエラー。再試行してください
446	取得者制度は終了しました。再試行してください
447	CAFIS システムエラー。再試行してください
448	再試行してください
449	CAFIS システムエラー。再試行してください
450	CAFIS システムエラー。再試行してください
451	アドバイスメッセージはすでに受け取っています
452	CAFIS は、メッセージを取得者に送信するときにタイムアウトを検出しました。再試行してください
453	CAFIS システムエラー。再試行してください
454	CAFIS システムエラー。再試行してください
455	CAFIS システムエラー。再試行してください
456	CAFIS システムエラー。再試行してください
457	CAFIS システムエラー。再試行してください
458	取得者はサービスをサポートしていません
459	CAFIS システムエラー。再試行してください
460	CAFIS システムエラー。再試行してください
577	カードは使用できません
578	取引は保留中です
579	PIN が正しくありません
580	セキュリティコードが正しくありません
581	暗証番号が設定されていません
582	JIS2 ストライプ情報が無効です
583	カードはその日の上限に達しています。（残高不足）
584	1日の限度額を超えています。（残高不足）
586	カードが無効です。 (MOD10チェック失敗)
587	カードが無効（紛失・盗難）
588	カードが無効です。 (MOD10チェック失敗)
589	の値が無効です (MOD 10 チェックに失敗しました)
590	加盟店タイプの値が無効です
591	取引金額の値が無効です
592	税金と送料の値が無効です
593	ボーナスカウントの値が無効です
594	ボーナス月の値が無効です
595	ボーナス額の値が無効です
596	最初の支払い月の値が無効です
597	分割払い回数の値が無効です
598	分割払い金額の値が無効です
599	最初の支払い額の値が無効です
600	サービスコードビジネスコードとメッセージコードの値が無効です
601	支払区分の値が無効です
602	お問い合わせ区分の値が無効です
603	キャンセル分割の値が無効です
604	元の支払区分の値が無効です
605	カードの有効期限が切れています
606	カードはサービス対象外です
607	取得者サービスが完了しました
608	無効なカード (紛失/盗難) にエラーがあります
609	何らかの理由でリクエストメッセージを処理できません
610	取引がサポートされていないリクエストメッセージを受信した
611	連絡をとらなかったセンターからの要請メッセージ
622	サービスコード設定エラー
623	業務コード設定エラー
624	メッセージコード設定エラー
625	プロセッサーコード設定エラー
626	加盟店コード設定エラー
627	取引識別子設定エラー
628	プロセッサトランザクションの日時設定エラー
629	カードアクセプター端末識別設定エラー
630	暗号方式コード設定エラー
631	鍵暗号鍵インデックス使用設定エラー
632	プロセッサー認証キーインデックス設定エラー
633	暗号鍵設定エラー
634	認証コード設定エラー
635	取得者機関識別コード設定エラー
636	第一口座番号設定エラー
637	有効期限設定エラー
638	Track-2 データ設定エラー
639	PIN データ設定エラー
640	加盟店タイプ設定エラー
641	取引金額設定エラー
642	税金と送料の設定エラー
643	POS データコード設定エラー
645	キャンセル分割設定エラー
646	オリジナル端末加工シリアル番号設定エラー
647	元支払区分設定エラー
658	元のプロセッサ取引の日時設定エラー
659	元の取引識別子の設定エラー
660	フリーフィールド設定エラー
661	端末処理連番設定エラー
662	暗証番号設定エラー
663	電子商取引指標設定エラー
664	XID設定エラー
665	口座名義人認証値設定エラー
666	取引状況設定エラー
667	メッセージバージョン番号設定エラー
668	CAVVアルゴリズム設定エラー
669	再発フラグ設定エラー
670	Element Block(例: 一般取引情報の設定エラー)
671	メッセージの組み合わせサービスコードとメッセージコードの設定が正しくない
672	プロセッサー認証キーインデックス設定エラー
673	元の取引が複数あります。取引を取り消すことができません
674	メッセージの組み合わせプロセッサコードと加盟店コードの設定が正しくありません
675	グローバルギアシステムエラーです。再試行してください
676	グローバルギアシステムエラーです。取引結果が不明です
677	グローバルギアシステムエラーです。取引結果が不明です
678	グローバルギアシステムエラーです。再試行してください
679	グローバルギアシステムエラーです。取引結果が不明です
680	グローバルギアシステムエラーです。取引結果が不明です
681	グローバルギアシステムエラーです。再試行してください
682	グローバルギアシステムエラーです。取引結果が不明です
683	グローバルギアシステムエラーです。取引結果が不明です
694	グローバルギアシステムエラーです。取引結果が不明です
695	グローバルギアシステムエラーです。取引結果が不明です
696	グローバルギアシステムエラーです。取引結果が不明です
697	グローバルギアシステムエラーです。取引結果が不明です
698	グローバルギアシステムエラーです。取引結果が不明です
699	グローバルギアシステムエラーです。取引結果が不明です
700	グローバルギアシステムエラーです。取引結果が不明です
701	グローバルギアシステムエラーです。取引結果が不明です
702	グローバルギアシステムエラーです。取引結果が不明です
703	グローバルギアシステムエラーです。再試行してください
704	グローバルギアシステムエラーです。取引結果が不明です
705	グローバルギアシステムエラーです。再試行してください
828	承認できません
831	キャッシュサービスはご利用いただけません
832	キャッシュバック要求が発行者の制限を超えています
833	最大日数制限を超えた
835	CVV2を拒否
836	事前承認額を超える取引金額
902	請求元情報が無効です
905	承認できません
906	承認できません
937	カード認証失敗
972	支払停止命令
973	認可命令の取消
975	全認可取消命令
1044	承認保留最初のチェック
1045	チェック OK 無変換
1046	無効な RTTN
1047	限度額を超える金額
1048	未払いのアイテムが NEG に失敗しました
1049	チェック番号が重複
1050	MICRエラー
1051	チェックが多すぎる
1198	発行者に転送
1201	発行者に転送
1263	承認できません
1295	不明

ゲートウエイエラーコード

ゲートウェイから返されたエラーコード

エラーコード	対象レベル	リスクのルール	エラーメッセージ
Err3001	Entity Level	Blacklist	"アメリカ発行カードがペイメントオプーションズのブラックリストに入っています"
Err3002	Entity Level	IP Address	"お客IP１１７．２４３．２４７．４１はペイメントオプーションズのブラックリストに入っています"
Err3003	Entity Level	BIN Blocking	"カードBIN５１２３４５はペイメントオプーションズのブラックリストに入っています"
Err3004	Entity Level	PAN Blocking	"PAN4000000000001000はペイメントオプーションズのブラックリストに入っています"
Err3005	Entity Level	Blacklist	"発行カード国「・・・」が発行国のブラックリストに入っています"
Err3006	Product Level	Threshold Amount	"取引額「・・・」が値を超えました"
Err3008	Product Level	PAN Limit	"速度チェック - 過去 10 分間に同じカード番号が 2 回以上使用されました"
Err3012	Product Level	IP Limit	"速度チェック-同じ IP アドレスからの試行が過去 5 分間で 2 回を超えています"
Err3013	Product Level	IP Limit	"速度チェック - 同じ IP アドレスからの試行が過去 60 時間で 1 回を超えています"
Err3015	Product Level	IP Limit	"速度チェック - 同じ IP アドレスからの試行が過去 60 か月で 2 回を超えています"
VAL0035	Product Level		"Invalid card holder name."
ERR0204	Product Level		"You don't have balance amount for refund."

導入

API リファレンスの使用

認証

APIキー

APIヘッダー

決済ページリンク作成

リクエスト属性

レスポンス属性

認可

リクエスト属性

レスポンス属性

購入

リクエスト属性

レスポンス属性

キャプチャー

リクエスト属性

レスポンス属性

返金

リクエスト属性

レスポンス属性

ボイド認可

リクエスト属性

レスポンス属性

ハンドラー

レスポンス属性

取引ステータス

リクエスト属性

レスポンス属性

カードトークンの生成 （購入・承認

リクエスト属性

レスポンス属性

カードトークンの利用（購入・認証）

リクエスト属性

レスポンス属性

サブスクリプションの作成

リクエスト属性

レスポンス属性

サブスクリプションリスト

レスポンス属性

サブスクリプション詳細

リクエスト属性

レスポンス属性

サブスクリプションを一時停止

リクエスト属性

レスポンス属性

サブスクリプションを再開

リクエスト属性

レスポンス属性

サブスクリプションをキャンセル

リクエスト属性

レスポンス属性

ゲートウエイコード

HTTPレスポンス

レスポンスコード

ゲートウエイエラーコード

カードトークンの生成（購入・承認