ペイシス | APIレファレンス (2.0)

Download OpenAPI specification:

ペイシスAPI概要

ペイシスAPIについて

ペイシスAPIでは、お客様のシステムとペイシスの主要な機能を連携してご利用して頂くことが可能になります。

※ご利用の際には事前に、管理画面から「チャンネルID」「チャンネル秘密鍵」を取得しておく必要があります。

※実際に接続を試す場合は、営業担当へご連絡ください。

免責事項

APIのリクエストおよびレスポンスに関する注意点

APIの仕様追加・更新に伴い、リクエストおよびレスポンスのパラメータが変更される場合があります。
これらの変更は、既存のAPIの動作に影響を与えないことを前提としており、事前に通知を行います。
ただし、APIの安定運用のため、やむを得ず予告なく仕様変更を行う場合があることを、あらかじめご了承ください。
APIを実装する際は、パラメータの追加・変更・削除が発生する可能性を考慮した設計をお願いいたします。

情報

ステータスコード一覧

レスポンス	詳細
200 OK	リクエストが正常に処理された場合
400 Bad Request	リクエストが不正な場合
401 Unauthorized	認証エラーの場合
403 Forbidden	アクセス禁止の場合
404 Not Found	チャンネルIDから加盟店が特定できなかった場合
405 Method Not Allowed	メソッドが許可されていない場合
500 Internal Server Error	内部エラー
503 Service Unavailable	メンテナンス実施中

API設定

No.	パラメタ名	桁数	デフォルト	編集可否	備考
1	チャンネルID	128固定		編集不可
2	チャンネル秘密鍵	128固定		編集不可
3	決済結果通知のHTTPバージョン		HTTP1.1	編集可	HTTP1.1とHTTP2を選択いただけます
4	決済結果通知のタイプ		JSON形式	編集可	JSON形式を選択した場合リクエストもレスポンスもJSON形式となります。 FORM形式を選択した場合リクエストもレスポンスもFORM形式となります。
5	通知先（決済結果通知）	128最大		編集可	決済結果通知を利用する場合のみ
6	通知先（会員登録結果通知）	128最大		編集可	会員登録結果通知を利用する場合のみ
7	API接続許可IPアドレス			編集可	「,」コンマ区切りで複数IPアドレスや複数のIPアドレス範囲を入力可能です。
8	請求情報詳細		ON	編集可	OFFを選択した場合、Webhook（決済結果通知）に以下情報を含みません。・都度決済詳細情報(order) ・継続課金決済詳細情報(recurring_payment)

認証

認証フロー

チャンネルIDを使用して加盟店を特定
リクエストヘッダー「X-Paysys-Authorization」と、ペイシスが生成したシグネチャの比較
各種処理

Request Header

項目	設定
Content-Type	application/json
X-Paysys-Channel-Id	ペイシス管理画面「API設定」よりダウンロードより取得。
X-Paysys-Authorization-Nonce	シグネチャ生成にて使用したnonce
X-Paysys-Authorization	シグネチャ生成にて作成したシグネチャ。

サンプルコード

シグネチャ生成（PHP）

// リクエスト
$request = [];
$request['basic_order_parameters'] = [
  "order_name" => "請求SAMPLE",
  "order_price" => 20000,
];
  $request['optional_order_parameters'] = [
  "contractor" => "Test Taro",
];

// HMAC署名を作成に使用するUUID(例：現在日時のマイクロ秒)
$nonce = (string)microtime(TRUE);
$signature = base64_encode(hash_hmac('sha256', $ChannelSecretKey.json_encode($request).$nonce, $ChannelSecretKey , true));

Note

※ 日本語や「スラッシュ(/)」などは変換されないよう、エスケープしてください。

都度決済・継続課金共通

請求URL作成API

都度決済も継続課金もデフォルト値を利用することができます。

都度決済の場合は、請求設定画面を、

継続課金の場合は、継続課金設定を

事前にご確認お願い致します。

Request Body schema: application/json
required

One of

settlement_type required	string (決済タイプ) ■設定 once
	object (基本情報)
	object (追加情報)
	object (特定項目表示)

Responses

Request samples

Payload

Content type

application/json

Example

都度決済

{"settlement_type": "once",
"basic_order_parameters": {"order_name": "請求名テスト",
"order_price": 1000,
"language": "ja",
"delivery_type": "mail",
"use_credit": 1,
"use_convenience": 1,
"use_payeasy": 1,
"use_id_payments": 1,
"use_carrier_payment": 1,
"use_virtual_account": 1,
"use_convenience_invoice_payment": 1,
"name1": "山田",
"name2": "太郎",
"kana1": "ヤマダ",
"kana2": "タロウ",
"mail": "test@example.com",
"tel": "090xxxxxxxx",
"url_expiration_date": "2023-09-11",
"confirmation_type": 1,
"automatic_confirmation_date": "2023-09-11",
"use_lump_sum_payment": 1,
"use_installment_payment": 1,
"use_revolving_payment": 1,
"selectable_incounts": "3,5",
"payment_expiration_date": "2023-09-11",
"transaction_id": "a11111",
"payment_url_password": "aaaa",
"consumption_tax": 1,
"invoice_id": 1,
"invoice_expiration_date": 1,
"invoice_note": 0
},
"optional_order_parameters": {"item_id_1": "a11111",
"item_id_2": ["child_00001",
"child_00002",
"child_00003",
"child_00004"
]
},
"store_transaction_law_items": {"item_1": "１個"
}
}

Response samples

200
400

Content type

application/json

Example

都度決済

{"status": 1,
"order_id": 1,
"payment_url": "https://example.com/p?key=xxxxx",
"transaction_id": "a1111",
"settlement_type": "once",
"order_number": "5810452868276422",
"invoice_download_url": "https://example.com/invoice/xxx.pdf",
"invoice_password": "0501"
}

都度決済

返金要求API

都度決済と継続課金会員登録の返金要求APIです。

返金処理は非同期で行われ、処理完了後に「返金要求結果通知」を呼び出します。

返金可能な決済方法

都度決済
- クレジットカード決済
- ID決済
- キャリア決済
継続課金
- クレジットカード決済

返金期限

クレジットカード決済: 決済後 180日
ID決済: 決済後 180日
キャリア決済: 決済翌月末

Request Body schema: application/json
required

transaction_id

required

string (取引番号) <= 128 characters

■設定
加盟店様の請求管理番号

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "a11111"
}

Response samples

200
400

Content type

application/json

{"status": 1
}

与信取消要求API

都度決済で与信をキャンセルするAPIです。

与信取消処理は非同期で行われ、処理完了後に「与信取消要求結果通知」を呼び出します。

与信取消可能な決済方法

クレジットカード決済
ID決済（LINE Pay のみ）

Request Body schema: application/json
required

transaction_id

required

string (取引番号) <= 128 characters

■設定
加盟店様の請求管理番号

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "a11111"
}

Response samples

200
400

Content type

application/json

{"status": 1
}

確定要求API

都度決済のみ利用可能です。

請求作成時に確定区分に対して「与信のみ」を設定している場合は、本APIにて確定を入れることができます。

Request Body schema: application/json
required

transaction_id

required

string (取引番号) <= 128 characters

■設定
加盟店様の請求管理番号

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "a11111"
}

Response samples

200
400

Content type

application/json

{"status": 1,
"transaction_id": "a1111"
}

金額修正要求API

都度決済の金額修正要求APIです。

金額修正処理は非同期で行われ、処理完了後に「金額修正結果通知」を呼び出します。

処理方法

新しいSIDで新決済を作成し、成功後に元の決済をキャンセルします。

金額修正可能な決済方法

クレジットカード決済のみ

金額修正期限

クレジットカード決済: 決済後 180日

金額修正可能な状態

決済完了済み（確定状態）
与信状態

制限事項

修正後金額: 1円以上 9,999,999円以下
元金額と異なる金額である必要があります
他の処理（返金・キャンセル等）が実行中でないこと
金額修正期限内であること

Request Body schema: application/json
required

transaction_id required	string <= 64 characters 取引番号
new_amount required	integer [ 1 .. 9999999 ] 修正後金額（円）
modified_reason required	string <= 20 characters 変更事由

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "TXN123456789",
"new_amount": 5000,
"modified_reason": "割引適用対象外の為"
}

Response samples

200
400

Content type

application/json

{"status": 1
}

追加請求要求API

都度決済の追加請求要求APIです。

追加請求処理は非同期で行われ、処理完了後に「追加請求結果通知」を呼び出します。

処理方法

決済が完了している請求情報を利用して、追加の決済を行います。

追加請求可能な決済方法

クレジットカード決済のみ

追加請求可能な状態

決済完了済み（確定状態）

制限事項

他の処理（返金・キャンセル等）が実行中でないこと

Request Body schema: application/json
required

target_transaction_id required	string (取引番号) <= 128 characters
new_transaction_id required	string (新取引番号) <= 128 characters
order_name required	string (請求名) <= 50 characters
order_price required	integer (請求金額（円）) [ 1 .. 9999999 ]
consumption_tax	integer (消費税区分) Enum: 0 1 2 ■設定 0: 非課税 1: 標準税率 2: 軽減税率
mail required	string (メールアドレス) <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"target_transaction_id": "TXN123456789",
"new_transaction_id": "TXN12345678911",
"order_name": "追加請求サンプル",
"order_price": 5000,
"consumption_tax": 2,
"mail": "example@example.com"
}

Response samples

200
400

Content type

application/json

{"status": 1
}

継続課金

処理キュー作成API

継続課金の請求データを入れる箱を作成します。

請求データ登録を行うためには、箱の作成が必須です。

Request Body schema: application/json
required

queue_title required	string (タイトル) <= 50 characters
person_name	string (登録者名)
settlement_date required	string (決済予定日) YYYY-MM-DD形式。過去日NG

Responses

Request samples

Payload

Content type

application/json

{"queue_title": "サンプル",
"person_name": "ペイメントフォー",
"settlement_date": "2021-12-25"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"process_key": "aaaaaaaaaaaaaaaa",
"inserted_at": "2021-12-25 10:45:30"
}

処理キュー削除API

未処理の処理キューを削除します。

Request Body schema: application/json
required

process_key

required

string (処理キー) = 16 characters

■設定
ペイシスにて採番した処理キー

Responses

Request samples

Payload

Content type

application/json

{"process_key": "aaaaaaaaaaaaaaaa"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"deleted_at": "2021-12-25 10:45:30"
}

請求リスト取得API

継続課金の請求データを検索することができます。

Request Body schema: application/json
required

customer_number	string (契約番号)
process_key	string (処理キー) = 16 characters ■設定ペイシスにて採番した処理キー
offset	integer (オフセット)

Responses

Request samples

Payload

Content type

application/json

{"customer_number": "a0001",
"process_key": "aaaaaaaaaaaaaaaa",
"offset": 201
}

Response samples

200
400

Content type

application/json

{"status": "success",
"total_count": 500,
"order_ids": [2100,
2101,
3001,
5000
]
}

請求参照API

継続課金の請求データを参照します。

Request Body schema: application/json
required

order_id

required

integer (請求ID)

Responses

Request samples

Payload

Content type

application/json

{"order_id": 21000
}

Response samples

200
400

Content type

application/json

{"status": "success",
"order_id": "290000",
"process_key": "aaaaaaaaaaaaaaaa",
"payment_ip": "THxxxxxxxx",
"payment_sid": "2000000000xxxxxx",
"customer_number": "xxxxxxxx",
"customer_name": "テスト サンプル",
"order_name": "デフォルト請求名",
"order_price": "1,000",
"brand": "TEST_CARD",
"settlement_fee_rate": null,
"settlement_fee": 0,
"calculate_price": "1,000",
"payment_method": "クレジットカード",
"settlement_date": "2021-09-15",
"executed_at": "2021-09-15 10:01:57",
"execute_status": "完了",
"retry_settlement_date": "--",
"retry_executed_at": "--",
"retry_execute_status": "--",
"remarks": "",
"order_detail": ""
}

請求データ登録API

継続課金の請求データを登録します。

請求データ登録を行うためには、処理キュー作成API で箱の作成が必須です。

Request Body schema: application/json
required

process_key required	string (処理キー) = 16 characters ■設定ペイシスにて採番した処理キー
customer_number required	string (契約番号)
order_price required	integer (金額) <= 8 characters ■設定税込み金額で指定指定可能: 0円〜9,999,999円
consumption_tax	integer (消費税) ■条件消費税が「有効」 ■設定入力必須 0: 非課税 1: 標準税率(10%) 2: 軽減税率(8%)
invoice_id	integer (請求書ID) ■条件請求書が「有効」 ■設定請求書設定で登録したPDFのID
invoice_expiration_date	string (請求書支払期限) ■条件請求書IDを指定した時のみ有効 ■設定 YYYY-MM-DD形式
invoice_note	string (請求書備考欄) ■条件請求書IDを指定した時のみ有効 ■設定請求書の備考欄に表示する文字列（改行コード \n で改行可能）
option.item_id	string (オプション項目) ■設定使う場合のみ請求情報用項目のみリクエストする場合はprefixとして「option.」が必要＜金額の場合＞税込み金額で指定指定可能: 0円〜9,999,999円

Responses

Request samples

Payload

Content type

application/json

{"process_key": "aaaaaaaaaaaaaaaa",
"customer_number": "a0001",
"order_price": 20000,
"consumption_tax": 1,
"invoice_id": 1,
"invoice_expiration_date": "2026-01-08",
"invoice_note": "テスト",
"option.item_id": 400
}

Response samples

200
400

Content type

application/json

{"status": "success",
"order_id": 21300,
"inserted_at": "2021-12-25 10:45:30"
}

請求キャンセルAPI

未処理の請求データが決済されないようにします。

Request Body schema: application/json
required

order_id

required

integer (請求ID)

Responses

Request samples

Payload

Content type

application/json

{"order_id": 21000
}

Response samples

200
400

Content type

application/json

{"status": "success",
"disabled_at": "2021-12-25 10:45:30"
}

返金要求API

継続課金処理の返金要求APIです。

返金処理は非同期で行われ、処理完了後に「返金要求結果通知」を呼び出します。

返金可能な決済方法

クレジットカード決済

返金期限

クレジットカード決済: 決済後 180日

Request Body schema: application/json
required

order_id

required

integer (請求ID)

Responses

Request samples

Payload

Content type

application/json

{"order_id": 21000
}

Response samples

200
400

Content type

application/json

{"status": "success"
}

金額修正要求API

継続課金決済の金額修正要求APIです。

決済処理済みの請求に対する金額修正処理は非同期で行われ、処理完了後に「金額修正結果通知」を呼び出します。

決済処理前の請求に対する金額修正処理は同期で行われ、レスポンスの結果が金額修正結果となります。（通知は送信されません）。

金額修正可能な決済方法

クレジットカード決済
Web口座振替

金額修正期限

クレジットカード決済: 決済後 180日
Web口座振替: 決済月の8日まで

金額修正可能な状態

クレジットカード決済

未処理（決済前）
決済完了済み（確定状態）

Web口座振替

未処理（決済前）

制限事項

修正後金額: 1円以上 9,999,999円以下
元金額と異なる金額であること
他の処理（返金・キャンセル等）が実行中でないこと
金額修正期限内であること

Request Body schema: application/json
required

recurring_payment_id required	string <= 64 characters 継続課金ID
new_amount required	integer [ 1 .. 9999999 ] 修正後金額（円）
modified_reason required	string <= 20 characters 変更事由

Responses

Request samples

Payload

Content type

application/json

{"recurring_payment_id": "334533",
"new_amount": 1500,
"modified_reason": "割引適用対象外の為"
}

Response samples

200
400

Content type

application/json

{"status": 1
}

会員解約API

会員様の即時解約時に使用します。

Request Body schema: application/json
required

customer_number

required

string (契約番号)

Responses

Request samples

Payload

Content type

application/json

{"customer_number": "a001"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"cancel_contracted_at": "string"
}

カード変更URL発行API

会員様のカード変更時に使用します。

Request Body schema: application/json
required

customer_number required	string (契約番号)
delivery_type required	string (配信種別) ■設定 mail: ペイシスからメールで案内 sms: ペイシスからSMSで案内 none: URL作成のみ

Responses

Request samples

Payload

Content type

application/json

{"customer_number": "a001",
"delivery_type": "mail"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"created_at": "2021-12-25 10:45:30",
"change_credit_card_url": "https://example.com/recurring/change_credit_card?key=hogefugahogefuga",
"change_credit_card_shot_url": "https://example.com/recurring/c1?key=hogefugahogefuga",
"expiration_date": "2021-12-25 10:45:30"
}

Webhooks

加盟店様はペイシスより通知を受信した際、「200 OK」のレスポンスをお願いします。

正常な応答が得られない場合、初回通知から60分間は５分間隔で、それ以降は30分間隔で上限99回として弊社より再通知を実施します。

上限99回までの想定所要時間
87回 x 30分 + 60分(12回) = 2670分（１日と２０時間３０分）

決済結果通知 Webhook

ペイシスから加盟店様に決済結果通知を送信することができます。

Request Body schema: application/json
required

One of

webhook_seq	integer (webhook通番)
payment_result	string (決済結果) ■設定 OK: 決済完了
payment_result_type	string (決済結果種別) ■設定 confirmation:確定状態 credit:与信状態(クレジットとID決済のみ)
payment_error_messages	string (決済エラーメッセージ) ■設定決済失敗時に利用
order_id	integer (請求ID) ■設定ペイシスの請求ID
transaction_id	string (取引番号) ■設定請求URL作成APIで指定した取引番号
payment_type	string (決済タイプ) ■設定 push_once:都度決済 pull_once:都度決済 add_once:追加請求
payment_method	string (支払い方法) ■設定 credit: クレジットカード convenience: コンビニ payeasy: ペイジー id_payments: ID決済 carrier_payment: キャリア決済 virtual_account: バーチャル口座 convenience_invoice: コンビニ請求書
delivery_type	string (配信種別) ■設定請求URL作成時に指定された配信種別継続課金は使用しない
	object (都度決済詳細情報) 「API設定 - 請求詳細情報」がONの場合、通知します。
SEQ	string (通知番号) ■設定決済センターにおける通知連番通信エラー等で再送する場合、同一番号で通知
DATE	string (入金日) ■設定決済センターで入金が確認された日付 yyyymmdd形式
TIME	string (入金時刻) ■設定決済センターで入金が確認された時間 hhmmss形式
IP	string (IPコード) ■設定決済センターで入金が確認されたIPコード
SID	string (取引コード) ■設定システムと決済センターとの間で使用された一意な取引コード
KINGAKU	integer (金額) ■設定入金が確認された金額
CVS	string (決済方法) ■設定＜クレジットの場合＞ VISA MASTER JCB AMEX DINERS CREDIT TEST_CARD ＜コンビニの場合＞ SEVEN famima Secoma loppi wellnet ＜ペイジーの場合＞ payeasy
SCODE	string (店舗コード) ■設定＜クレジットの場合＞カード番号下４桁 + 有効期限４桁（YYMM） ※クレジットカード、コンビニ、ペイジーの場合のみリクエストに含まれます。
SHONIN	string (承認番号) ■設定承認番号 ※クレジットの場合のみリクエストに含まれます。
HISHIMUKE	string (被仕向先コード) ■設定被仕向先コード ※クレジットの場合のみリクエストに含まれます。
FUKA	string (付加情報) ■設定弊社決済センターで決済に付加された情報
PAYMODE	string (支払区分) ■設定 10:一括 21:ボーナス一括 31:ボーナス併用 61:分割 80:リボルビング ※クレジットの場合のみリクエストに含まれます。
INCOUNT	string (分割回数) ■設定分割回数分割・ボーナス併用以外の場合は空文字 ※クレジットの場合のみリクエストに含まれます。
IP_USER_ID	string (ユーザーID) ■設定決済時に付与したユーザーID ※クレジットの場合のみリクエストに含まれます。

Responses

Request samples

Payload

Content type

application/json

Example

都度決済

{"webhook_seq": 1,
"payment_result": "OK",
"payment_result_type": "confirmation",
"payment_error_messages": "",
"order_id": 1,
"transaction_id": "c5fcb773-1cad-4588-95fc-c056545634d6",
"payment_type": "push_once",
"payment_method": "credit",
"delivery_type": "mail",
"order": {"order_number": "91xxxxxxxxxxxxxx",
"ip": "Axxxxxxxxx",
"sid": "20xxxxxxxxxxxxxxxxx",
"random_object": "U6IV5UTA2XSL",
"order_name": "テスト請求名",
"settlement_type": "ONCE",
"order_type": "PUSH",
"order_transaction_law_items": {"status": 1,
"details": [{"sequence": 1,
"title": "分量",
"content": "1000"
},
{"sequence": 2,
"title": "販売価格・対価",
"content": "2000"
}
]
},
"language": "ja",
"inserted_at": "2023-09-14T10:25:30+09:00",
"name": {"last_name": "山田",
"first_name": "太郎",
"last_name_kana": "ヤマダ",
"first_name_kana": "タロウ"
},
"tel": "09012345678",
"mail": "example@example.com",
"item_answer_detail": ["デフォルト請求名 : 110円",
"システム利用料 : 220円"
],
"payment_status": 1,
"paid_at": "2023-09-14T10:25:30+09:00",
"last_authorization_at": "2023-09-14T10:25:30+09:00",
"payment_method": "credit",
"payment_detail": {"credit": {"cvs": "VISA",
"card_expiration_date": "2030-12",
"card_number": "**** **** **** 1234",
"card_name": "TARO YAMADA",
"paymode": 10,
"incount": 3,
"memo": "クレジットの取引履歴"
},
"convenience": {"convenience_store_type": 1,
"payment_number": "×××××-×××××××××××"
},
"payeasy": {"memo": "ペイジーの取引履歴",
"payment_number": "×××××-××××××××××××××××-×××××××"
},
"id_payments": {"memo": "ID決済の取引履歴"
},
"carrier_payment": {"memo": "キャリア決済の取引履歴"
}
},
"total_price": 10000,
"consumption_tax_rate": 0.1,
"consumption_tax_price": 1000,
"system_fee": 100,
"system_fee_affiliated_type": 1,
"invoice_download_url": "http://localhost/invoice",
"invoice_password": "password",
"receipt_download_url": "http://localhost/receipt",
"receipt_password": "password",
"manager_name": "山田太郎",
"custom_memo": "管理メモ"
},
"SEQ": "a001",
"DATE": 20230914,
"TIME": 102530,
"IP": "Axxxxxxxxx",
"SID": "20xxxxxxxxxxxxxxxxx",
"KINGAKU": 20000,
"CVS": "VISA",
"SCODE": "20xxxxxxxxxxxxxxxxx",
"SHONIN": "aaaaaaaaa",
"HISHIMUKE": "aaaaaaaaa",
"FUKA": "aaaaaaaaa",
"PAYMODE": 10,
"INCOUNT": "",
"IP_USER_ID": "aaaaaaaaaa"
}

Response samples

200

Content type

application/json

{"result": "OK"
}

会員登録結果通知 Webhook

ペイシスから加盟店様に会員登録結果通知を送信することができます。

Request Body schema: application/json
required

webhook_seq	integer (webhook通番)
result	integer Enum: 0 1 2 ■設定 0: NG 1: OK 2: Cancel
id	string (ID)
order_type	string (請求タイプ) ■設定 PUSH: PUSH PULL: PULL
	object (特定項目表示) ■設定改正特商法の特定項目表示
customer_number	string (契約番号)
ip_user_id	string (ユーザーID) ■設定決済に付与されたユーザーID
	object (お客様氏名)
tel	string (電話番号)
mail	string (メールアドレス)
is_send_auto_mail	integer (自動配信メール) ■設定 0: 停止中 1: 配信中
language	string (言語) ■設定 ja: 日本語 en: 英語
contract_status	integer (契約状況) Enum: 0 1 ■設定 0: 未契約 1: 契約中
contracted_at	string (契約日時)
payment_method	string (支払い方法) ■設定 credit: クレジットカード web_direct_debit: Web口座振替
cvs	string (カードブランド) ■設定 VISA, MASTER, AMEX, JCB, DINERS, CREDIT
card_expiration_date	string (カード有効期限)
card_number	string (カード番号下4桁)
card_name	string (カード名義)
recurring_payment_type	integer (課金パターン) ■設定 0: 自動 + 手動 1: 手動のみ
transaction_id	string (取引ID) ■設定請求URL作成APIで指定した取引番号
first_recurring_date	string (初回課金日)
automatic_recurring_name	string (自動課金名)
automatic_recurring_date	string (自動課金日)
automatic_recurring_price	integer (自動課金金額)
recurring_payment_interval	integer (自動課金間隔) ■設定自動課金が発生する間隔 (単位: 月)
memo	string (会員メモ)

Responses

Request samples

Payload

Content type

application/json

{"webhook_seq": 1,
"result": 1,
"id": "12345",
"order_type": "PUSH",
"order_transaction_law_items": {"status": 1,
"details": [{"sequence": 1,
"title": "分量",
"content": "1000"
},
{"sequence": 2,
"title": "販売価格・対価",
"content": "2000"
}
]
},
"customer_number": "12345678",
"ip_user_id": "0jEvTNR9kmCDYvgX",
"name": {"last_name": "山田",
"first_name": "太郎",
"last_name_kana": "ヤマダ",
"first_name_kana": "タロウ"
},
"tel": "09012345678",
"mail": "example@example.com",
"is_send_auto_mail": 1,
"language": "ja",
"contract_status": 1,
"contracted_at": "2021-12-25 00:00:00",
"payment_method": "credit",
"cvs": "VISA",
"card_expiration_date": "2030-12",
"card_number": "**** **** **** 1234",
"card_name": "TARO YAMADA",
"recurring_payment_type": 1,
"transaction_id": "c5fcb773-1cad-4588-95fc-c056545634d6",
"first_recurring_date": "2023-01-15",
"automatic_recurring_name": " **月額料金",
"automatic_recurring_date": "2023-02-15",
"automatic_recurring_price": 5000,
"recurring_payment_interval": 3,
"memo": "会員メモ"
}

Response samples

200

Content type

application/json

{"result": "OK"
}

返金結果通知 Webhook

返金要求APIでリクエストされた処理結果をペイシスから加盟店様に通知します。その他の処理で行われた返金処理は通知されません。

Request Body schema: application/json
required

One of

webhook_seq	integer (webhook通番)
result	string (結果) ■設定 OK: 返金完了 NG: 返金失敗
transaction_id	string (取引番号) ■設定請求URL作成APIで指定した取引番号
type	integer (返金種別) ■設定 1:都度決済・継続課金会員登録 2:継続課金処理
refunded_at	string (返金日時) ■設定 YYYY-MM-DD hh:mm:ss形式
error_code	integer (エラーコード) 返金NGの場合のみ下記エラーコードが設定されます。 ■設定 100: 返金できませんでした。 101: 返金できませんでした。（与信状態） 102: 返金できませんでした。（与信取消済み） 104: 返金できませんでした。（返金済み） 401: 利用可能なタイプにpush型とpull型が設定されていません。 900: 返金処理中に何らかのエラーが発生しました。 ■補足 900はネットワーク障害や処理の遅延により処理途中でエラーを返却する場合があります。時間を空けて再度返金処理を実施すると 104（返金済み）が返却されることもあります。改善されない場合はお問い合わせください。
error_message	string (エラーメッセージ) 返金NGの場合のみ、エラーコードに対応したエラーメッセージが設定されます。

Responses

Request samples

Payload

Content type

application/json

Example

都度決済・継続課金会員登録

{"webhook_seq": 1,
"result": "OK",
"transaction_id": "a001",
"type": 1,
"refunded_at": "2021-12-25 00:00:00",
"error_code": 100,
"error_message": "返金できませんでした。"
}

Response samples

200

Content type

application/json

{"result": "OK"
}

与信取消結果通知 Webhook

与信取消要求APIでリクエストされた処理結果をペイシスから加盟店様に通知します。その他の処理で行われた与信取消処理は通知されません。

Request Body schema: application/json
required

webhook_seq	integer (webhook通番)
result	string (結果) ■設定 OK: 与信取消完了 NG: 与信取消失敗
transaction_id	string (取引番号) ■設定請求URL作成APIで指定した取引番号
canceled_at	string (与信取消日時) ■設定 YYYY-MM-DD hh:mm:ss形式
error_code	integer (エラーコード) 与信取消NGの場合のみ下記エラーコードが設定されます。 ■設定 100: 与信取消できませんでした。 102: 与信取消できませんでした。（与信取消済み） 103: 与信取消できませんでした。（決済確定済み） 104: 与信取消できませんでした。（返金済み） 900: 与信取消処理中に何らかのエラーが発生しました。 ■補足 900はネットワーク障害や処理の遅延により処理途中でエラーを返却する場合があります。時間を空けて再度返金処理を実施すると 102（与信取消済み）が返却されることもあります。改善されない場合はお問い合わせください。
error_message	string (エラーメッセージ) 与信取消NGの場合のみ、エラーコードに対応したエラーメッセージが設定されます。

Responses

Request samples

Payload

Content type

application/json

{"webhook_seq": 1,
"result": "OK",
"transaction_id": "a001",
"canceled_at": "2021-12-25 00:00:00",
"error_code": 100,
"error_message": "与信取消できませんでした。"
}

Response samples

200

Content type

application/json

{"result": "OK"
}

金額修正結果通知 Webhook

金額修正要求APIでリクエストされた処理結果をペイシスから加盟店様に通知します。その他の処理で行われた金額修正処理は通知されません。未決済データは本通知の対象外であり、APIレスポンスで結果を返却します。

Request Body schema: application/json
required

webhook_seq	integer (webhook通番)
result	string (結果) ■設定 OK: 金額修正完了
transaction_id	string (取引番号) ■設定請求URL作成APIで指定した取引番号
type	integer (金額修正種別) ■設定 1:都度決済 2:継続課金処理
original_amount	integer (修正前金額) ■設定修正前の元金額（円）
modified_amount	integer (修正後金額) ■設定修正後の金額（円）
modified_at	string (金額修正日時) ■設定 YYYY-MM-DD hh:mm:ss形式

Responses

Request samples

Payload

Content type

application/json

{"webhook_seq": 1,
"result": "OK",
"transaction_id": "a001",
"type": 1,
"original_amount": 3000,
"modified_amount": 5000,
"modified_at": "2021-12-25 00:00:00"
}

Response samples

200

Content type

application/json

{"result": "OK"
}

決済依頼通知 Webhook

コンビニ／ペイジーの支払番号及びバーチャル口座を発行した際に、ペイシスから加盟店様システムへ通知します。

Request Body schema: application/json
required

One of

webhook_seq	integer (webhook通番)
transaction_id	string (取引番号)
order_id	integer (注文番号)
order_number	string (請求番号)
sid	string (取引コード) ■設定システムと決済センターとの間で使用された一意な取引コード
issue_at	string (通知生成日時) ■設定通知生成日時（YYYY-MM-DD hh:mm:ss 形式）
payment_expiration_date	string (支払期限日) ■設定支払期限日（YYYY-MM-DD 形式）
tel	string (電話番号)
mail	string (メールアドレス)
	object (請求項目詳細) ■設定請求項目詳細内容
order_name	string (請求名)
	object (お客様氏名)
total_price	integer (合計金額) ■設定支払い合計額（円）
payment_method	string (決済種別) Value: "convenience" convenience: コンビニ決済 payeasy: ペイジー決済 virtual_account: バーチャル口座決済
	object (決済固有情報) 決済方法ごとの追加情報が格納されます。

Responses

Request samples

Payload

Content type

application/json

Example

コンビニ決済

{"webhook_seq": 1,
"transaction_id": "transaction_id_1234567890",
"order_id": 1234567890,
"order_number": "12345",
"sid": "209999999999999",
"issue_at": "2024-04-01 12:00:00",
"payment_expiration_date": "2024-04-15",
"tel": "09012345678",
"mail": "example@example.com",
"item_answer_detail": {"デフォルト請求名": "110円",
"システム利用料": "220円"
},
"order_name": "テスト請求名",
"name": {"name1": "山田",
"name2": "太郎",
"kana1": "ヤマダ",
"kana2": "タロウ"
},
"total_price": 5500,
"payment_method": "convenience",
"payment_info": {"convenience_store_type": 1,
"payment_number": "12345-67890-12345",
"payment_link": "https://example.com/payment/barcode.pdf",
"payment_guide_url": "https://example.com/convenience-guide"
}
}

Response samples

200

Content type

application/json

{"result": "OK"
}

追加請求結果通知 Webhook

追加請求要求APIでリクエストされた処理結果をペイシスから加盟店様に通知します。その他の処理で行われた追加請求処理は通知されません。未決済データは本通知の対象外であり、APIレスポンスで結果を返却します。

Request Body schema: application/json

webhook_seq required	integer (webhook通番)
result required	string (結果) ■設定 OK: 追加請求完了 NG: 追加請求失敗
transaction_id required	string (取引番号) ■設定請求URL作成APIで指定した取引番号

Responses

Request samples

Payload

Content type

application/json

{"webhook_seq": 1,
"result": "OK",
"transaction_id": "a001"
}

Response samples

200

Content type

application/json

{"result": "OK"
}

ペイシス | APIレファレンス (2.0)

ペイシスAPI概要

ペイシスAPIについて

免責事項

APIのリクエストおよびレスポンスに関する注意点

情報

ステータスコード一覧

API設定

認証

認証フロー

Request Header

サンプルコード

シグネチャ生成（PHP）

Note

都度決済・継続課金共通

請求URL作成API

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

都度決済

返金要求API

返金可能な決済方法

返金期限

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

与信取消要求API

与信取消可能な決済方法

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

確定要求API

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

金額修正要求API

処理方法

金額修正可能な決済方法

金額修正期限

金額修正可能な状態

制限事項

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

追加請求要求API

処理方法

追加請求可能な決済方法

追加請求可能な状態

制限事項

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

継続課金

処理キュー作成API

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

処理キュー削除API

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

請求リスト取得API

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

請求参照API

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

請求データ登録API

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required