RESTをベースに構成された決済APIです。都度の支払い、定期的な支払い、顧客情報の管理など、ビジネス運用における様々なことができます。"sk_test_c62fade9d045b54cd76d7036";PAY.JPのAPIを利用するには、ユーザー登録を行い、APIページからAPIキーを取得してください。テスト用のキーでは、本番の支払い処理を行うサーバーへは接続されず、実際の支払い情報として計上されることもありません。本番用のキーは、本番申請を行うことで利用できるようになります。通常の認証は、シークレットキーをユーザーネームとして扱い、Basic認証経由で行われます。パブリックキーは、あなたの決済画面のHTML内に組み込む公開用のAPIキーで、クレジットカードのトークンを生成する際に使用します。取扱いにご注意ください。プロトコルセキュリティのため、PAY.JPに対する全てのAPI通信は必ずHTTPSで行うようにしてください。APIへのリクエストでは、GET、POST、DELETEの3種類のHTTPメソッドを利用できます。application/x-www-form-urlencodedのボディで送信ください。charset=utf-8)で返されます。タイムスタンプ日次に関するデータは、UTCタイムゾーンのUNIXタイムスタンプで表示されます。Payjp}エラーとなるリクエストには、"error"というキーが含まれたエラーレスポンスが返されます。エラーメッセージが含まれます。エラーメッセージは事業者向けの内容となっており、エンドユーザーへ提示する内容として利用することを推奨しておりません。"/v1/customers"}各オブジェクトを一覧取得した際、戻り値はlistオブジェクトを介して取得されます。一覧取得APIは共通して以下のページネーションを指定でき、各種オブジェクトは直近で生成された順番に取得されます。取得するデータ数の最大値(1~100まで)。基準点からのデータ取得を行う開始位置。いうクエリーを追加します。offset=0)が行われた状態で取得されます。指定してページングを行なってください。Subscription)に任意のキーバリュー型のデータ持たせることのできるオブジェクトです。請求書番号や注文番号などを支払いオブジェクトのメタデータに保存すれば、それらをPAY.JPの支払いオブジェクトから直接取得することが可能になります。メタデータを設定していない場合でも、各種オブジェクトのレスポンスのJSON内にmetadataキーは存在します。メタデータを利用するには、対象オブジェクトの作成もしくは更新リクエストに例のように設定します。一つのオブジェクトには最大20キーまで保存でき、キーは40文字まで、バリューは500文字までの文字列をセットすることができます。詳しい実装についてはブログ記事もご覧ください。(支払い)都度の支払いや定期購入の引き落としのときに生成される、支払い情報のオブジェクトです。Boolean認証処理が成功しているかどうか。プラットフォーマーに振り分けられる入金金額。}}トークンID、カードを保有している顧客IDのパラメーターを指定して支払いを作成します。顧客IDを使って支払いを作成する場合はcardパラメータに顧客の保有するカードのIDを指定でき、省略された場合はデフォルトカードとして登録されているものが利用されます。以前はカードオブジェクトの指定ができましたが非通過対応により既に当該パラメーターは利用出来ないようになっております。テスト用のキーでは、本番用の決済ネットワークへは接続されず、実際の請求が行われることもありません。本番用のキーでは、決済ネットワークで処理が行われ、実際の請求が行われます。指定することで、認証の期間を定めることができます。デフォルトで7日となっており、1日~60日の間で設定が可能です。60日に設定した場合、認証期限は59日後の11:59PM(日本時間)までになります。設定されました期間を過ぎると解放されるようなっております。String通常はトークンIDを指定カードIDを指定した場合、customer引数も指定することで、顧客のデフォルトカード以外を利用できます。}}生成された支払い情報を取得します。}}支払い情報を更新します。}}支払い済みとなった処理を返金します。指定することで金額の部分返金を行うことができます。指定して部分返金をすることはできません。返金可能な期限につきましては売上作成より180日以内となります。}}各種SDKは順次対応予定です認証状態となった処理待ちの支払いを再認証します。指定することで、新たな認証の期間を定めることができます。デフォルトで7日となっており、1日~60日の間で設定が可能です。60日に設定した場合、認証期限は59日後の11:59PM(日本時間)までになります。することを推奨いたします。このAPIは認証済みの与信をキャンセルせず別の与信を作るため、同じ金額で認証済みでも失敗したり、デビットカードなどでは一度目の認証(capture=falseの支払い)と含めて二重に金額が引き落とされることがあります。}}認証状態となった処理待ちの支払い処理を確定させます。なった支払いが該当します。Integer50~9,999,999の整数これをセットすることで、支払い生成時の金額と異なる金額の支払い処理を行うことができます。支払い生成時の金額よりも少額である必要があるためご注意ください。なり、確定金額が400円に変更された状態で支払いが確定されます。}}生成した支払い情報のリストを取得します。Integer取得するデータ数の最大値(1~100まで)。Integer基準点からのデータ取得を行う開始位置。(顧客)顧客を管理するためのオブジェクトです。顧客における都度の支払いや定期購入、複数カードの管理など、さまざまなことができます。作成した顧客は、あとからカードを追加・更新・削除したり、顧客自体を削除することができます。Stringこのクレジットカード番号に紐づく値。トークン化の度にトークンIDは変わりますが、この値は変わりません。}}メールアドレスやIDなどを指定して顧客を作成します。作成と同時にカード情報を登録する場合、トークンIDを指定します。以前はカードオブジェクトの指定ができましたが非通過対応により既に当該パラメーターは利用出来ないようになっております。作成した顧客やカード情報はあとから更新・削除することができます。3696に則ったバリデーションを行なっているため、ピリオドが連続する場合など、RFCに準拠せず発行されたメールアドレスは登録できません。cus_で始まる32桁までの一意な文字列が自動生成されます。}}生成した顧客情報を取得します。}}生成した顧客情報を更新したり、新たなカードを顧客に追加することができます。保持しているカードIDを指定することで、メイン利用のカードを変更することもできます。以前はカードオブジェクトの指定ができましたが非通過対応により既に当該パラメーターは利用出来ないようになっております。}}生成した顧客情報を削除します。削除した顧客情報は、もう一度生成することができないためご注意ください。顧客に紐付く定期課金がある場合に関しましては、当該顧客の削除と同時に定期課金も削除されます。}}生成した顧客情報のリストを取得します。リストは、直近で生成された順番に取得されます。Integer取得するデータ数の最大値(1~100まで)。Integer基準点からのデータ取得を行う開始位置。Integerタイムスタンプ指定したタイムスタンプ以前に作成されたデータのみ取得レスポンスcustomerオブジェクトのリスト。リストは、直近で生成された順番に取得されます。}}トークンIDを指定して、新たにカードを追加します。同じカード番号および同じ有効期限年/月のカードは、重複追加することができません。指定することで、作成したカードを顧客のメイン利用のカードに設定することができます。}}顧客の特定のカード情報を取得します。}}顧客の特定のカード情報を更新します。指定ができましたが非通過対応により既に当該パラメーターは利用出来ないようになっております。}}顧客の特定のカードを削除します。}}顧客の保持しているカードリストを取得します。リストは、直近で生成された順番に取得されます。Integer取得するデータ数の最大値(1~100まで)。Integer基準点からのデータ取得を行う開始位置。Integerタイムスタンプ(sec)指定したタイムスタンプ以前に作成されたデータのみ取得レスポンスcardオブジェクトのリスト。リストは、直近で生成された順番に取得されます。}}顧客の特定の定期課金情報を取得します。}}顧客の定期課金リストを取得します。Integer取得するデータ数の最大値(1~100まで)。Integer基準点からのデータ取得を行う開始位置。String定期課金ステータス。レスポンスsubscriptionオブジェクトのリスト。リストは、直近で生成された順番に取得されます。(プラン)定期購入に使用するプラン情報です。あなたのビジネスに必要なさまざまなプランを生成することができます。StringプランID。一意なplanオブジェクトを識別する文字列。年次の場合は"null")指定した日が存在しない月の場合、定期課金におけるサイクルは自動的に月末に調整されるため、例えば31を指定した場合は常に月末が課金日となります。定期課金における課金時刻は、この指定日の日本時間午前9:00に固定されます。billing_dayを指定しない場合は最初に課金された時刻(UTC)からのサイクルになります。課金時刻は固定されません。それ以降、サイクル開始時刻と同じ日がない場合、月末の日付に自動で調整され、以降はその日に課金されます。}}金額や通貨などを指定して定期購入に利用するプランを生成します。月次課金であればmonthを、年次課金であればyearを指定下さい。年次課金の場合、billing_dayは指定できません(現在作成はできますが、定期課金利用時にエラーとなります)。String任意のプランID。一意に識別できる必要があり、重複する値を設定するとエラーとなります。trial)となります。定期課金を作成時にもトライアルを追加したり、ここで指定したトライアル日数を無効にして作成することが可能です。Integer月次プラン(interval=month)のみに指定可能な課金日(1〜31)指定した日が存在しない月の場合、定期課金におけるサイクルは自動的に月末に調整されるため、例えば31を指定した場合は常に月末が課金日となります。定期課金における課金時刻は、この指定日の日本時間午前9:00に固定されます。billing_dayを指定しない場合は最初に課金された時刻(UTC)からのサイクルになります。課金時刻は固定されません。それ以降、サイクル開始時刻と同じ日がない場合、月末の日付に自動で調整され、以降はその日に課金されます。}}特定のプラン情報を取得します。}}プラン情報を更新します。}}プランを削除します。}}生成したプランのリストを取得します。Integerここに指定したタイムスタンプ以前に作成されたデータを取得レスポンスplanオブジェクトのリスト。リストは、直近で生成された順番に取得されます。(定期課金)月もしくは年単位の定期的な支払い処理を行います。顧客IDとプランIDを指定して生成します。顧客に複数紐付けるができ、停止・再開・キャンセル・削除もできます。原則として、定期課金は前払い式であり、課金が行われた時点から周期が開始します。Object定期課金に紐付くplanオブジェクト。