メインコンテンツへスキップ

​
API エンドポイント

環境Base URL
Sandboxhttps://api.sandbox.zafapay.com
Productionhttps://api.zafapay.com

​
認証

全てのAPIリクエストにBearer token認証が必要です。 
Authorization: Bearer YOUR_ACCESS_TOKEN
アクセストークンの取得方法は認証を参照してください。

​
リクエスト形式

  • Content-Type: application/json
  • 文字エンコーディング: UTF-8

​
レスポンス形式

全てのレスポンスはJSON形式で返されます。 成功時（決済作成）: 
{
  "success": true,
  "status": "pending",
  "transaction_id": "tx_abc123",
  "gateway_transaction_id": "pi_xxxxx",
  ...
}
成功時（決済取得）: 
{
  "id": "tx_abc123",
  "status": "completed",
  "amount": 1000,
  ...
}
エラー時: 
{
  "error": {
    "type": "invalid_request_error",
    "code": "VALIDATION_ERROR",
    "message": "エラーメッセージ",
    "request_id": "req_abc123xyz789"
  }
}
エラーコードの詳細はエラーコードを参照してください。

​
トランザクションステータス

ステータス説明
pending決済作成済み、顧客のアクション待ち（リダイレクト型）
requires_actionフロントエンドでのアクション待ち（カード決済）
authorizedオーソリ完了（手動キャプチャ待ち）
completed決済完了
failed決済失敗
canceled決済キャンセル
partially_refunded一部返金済み
refunded全額返金済み