Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
Login
Pay-Doc Pay-Doc
Login
Pay-Doc Pay-Doc
  • Home
  • 利用ガイド
  • APIリファレンス
  • FAQ
  • 更新履歴
  • 旧システムからの移行
  • お問い合わせ
loading
  1. Home
  2. APIリファレンス
  3. 一般
  4. API連携、SDKについて
Updated on 2025年4月15日

APIリファレンス

  • Folder icon closed Folder open icon一般
    • API連携、SDKについて
    • 認証
    • APIの制限
    • レスポンス
    • ページネーション
    • メタデータ
    • ポーリング
    • 冪等なリクエスト
    • 通貨と為替レート
  • Folder icon closed Folder open iconトランザクショントークン
    • トランザクショントークン – 概要
    • トランザクショントークン – リクエスト
      • トランザクショントークン – CREATE
      • トランザクショントークン – GET
      • トランザクショントークン – LIST
      • トランザクショントークン – UPDATE
      • トランザクショントークン – DELETE
      • トランザクショントークン – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon課金
    • 課金 – 概要
    • 課金 – リクエスト
      • 課金 – CREATE
      • 課金 – GET
      • 課金 – GET(銀行振込)
      • 課金 – LIST
      • 課金 – UPDATE
      • キャプチャ – CREATE
      • イシュアトークン – GET
      • 課金 – イシュアトークン(3-Dセキュア) – GET
  • Folder icon closed Folder open icon定期課金
    • 定期課金 – 概要
    • 定期課金 – リクエスト
      • 定期課金 – CREATE
      • 定期課金 – GET
      • 定期課金 – LIST
      • 定期課金 – UPDATE
      • 定期課金 – CANCEL
      • 定期課金 – 課金 – LIST
      • 支払い – 概要
      • 支払い – GET
      • 支払い – LIST
  • Folder icon closed Folder open icon返金
    • 返金 – 概要
    • 返金 – リクエスト
      • 返金 – CREATE
      • 返金 – GET
      • 返金 – LIST
      • 返金 – UPDATE
  • Folder icon closed Folder open iconキャンセル
    • キャンセル – 概要
    • キャンセル – リクエスト
      • キャンセル – CREATE
      • キャンセル – GET
      • キャンセル – LIST
      • キャンセル – UPDATE
  • Folder icon closed Folder open iconトランザクション
    • トランザクション – 概要
    • トランザクション – リクエスト
      • トランザクション – LIST
  • Folder icon closed Folder open icon加盟店
    • 加盟店 – 概要
    • 加盟店 – リクエスト
      • 加盟店 – GET
  • Folder icon closed Folder open icon店舗
    • 店舗 – 概要
    • 店舗 – リクエスト
      • 店舗 – GET
      • 店舗 – LIST
      • カスタマーUUID
  • Folder icon closed Folder open icon決済設定
    • 決済設定 – 概要
    • 決済設定 – リクエスト
      • 決済設定 – GET
  • Folder icon closed Folder open iconウェブフック
    • ウェブフック – 概要
    • ウェブフック – リクエスト
      • ウェブフック – GET
      • ウェブフック – UPDATE
  • Folder icon closed Folder open iconエラーコード
    • エラーコード – 概要
  • Folder icon closed Folder open icon3-DセキュアをAPIで実装する
    • 3-Dセキュア認証の処理の流れ
    • 実装方法
    • 追加されるパラメータ
    • 3-Dセキュア認証情報を自社で取得している場合の対応

API連携、SDKについて

APIとは、様々な決済手段を提供する RESTfulな HTTPS インターフェースです。

API を呼び出す為に、直接 HTTP リクエストを実行することも可能ですが、いくつかの開発言語向けにライブラリを提供しています。これらは様々なベストプラクティスや、型情報を提供するので、APIの統合をより簡単に行うことができます。これらの使用例は、本ドキュメントのリソースに対する呼び出し例として記載されています。

API連携

画面遷移をシンプルにする等の理由で、加盟店サイト内に独自の決済フォームを設けたい場合は、API連携を行ってください。

クレジットカード情報の送信を伴う場合

クレジットカード情報を加盟店サイト内に入力させ、APIに送信する場合は、カード情報の「通過」にあたるため、加盟店サイトがPCI DSSに準拠することが必要です。
PCI DSSに準拠していない場合、カード情報は当社準備の決済フォームを利用する構築をしてください。
PCI DSSに準拠している場合、トークン化から課金、返金までの全てのリクエストを本サービスのAPIに送信することが可能です。

APIの呼び出しについて

APIはシークレットトークンなどの機密情報を含むためCORSでの実行を許可していません。
APIを呼び出す場合はサーバーアプリケーションから呼び出すよう実装してください。

SDK

ここでは、API連携開発をシンプルにする「SDK」について説明します。

APIとの連携開発を行う際は、本ドキュメントを参照して設計・開発してください。
開発言語が対応しているようであれば、SDK(Software Development Kit)の利用を推奨します。

SDKは、APIを利用するためのライブラリです。GitHub上で公開しています。
利用フローについては、Githubの「Readme」を参照してください。

SDK利用のメリット

  • APIと通信するためのコードを記述する必要がない
  • セキュリティ(トークンの有効期限や利用回数制限のアルゴリズム)の取り扱いについても考慮する必要がない

SDKの機能やツール例

IDE、オートコンプリート、コンパイルエラー etc…

GitHubについて

GitHubは、ソフトウェア開発プロジェクトのためのソースコード管理サービスです。
GitHubの公式言語は英語で、アカウント設定画面から言語を日本語に指定することはできません。以降、最低限必要なアクションを日本語で解説します。

技術的な不明点や、Github内ドキュメントへのフィードバックがある場合

SDKの組込において技術的な質問がある場合や、ドキュメントへのフィードバックがある場合は、該当のリポジトリ※から「Issues」を選択し、当社エンジニアに質問・要望を日本語または英語で送信してください。

リポジトリとは:
「格納庫」を意味する言葉で、Githubでは組織またはプロジェクトの階層下に設置されるサブプロジェクトのような存在です。例:https://github.com/univapay/univapay-java-sdk
この場合は「univapay-java-sdk」がリポジトリです。

サポートしている開発言語

  • Javascript Typescript NodeJS
  • JAVA
  • PHP
Share this Doc

API連携、SDKについて

Or copy link

Clipboard Icon
CONTENTS

© All Rights Reserved by UNIVA Paycast Limited.