決済作成

決済作成

curl --request POST \
  --url https://api.sandbox.zafapay.com/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 17.62,
  "currency": "usd",
  "capture_method": "automatic",
  "external_id": "order_12345",
  "flow_id": "flow_abc123",
  "payment_method": "card",
  "metadata": {},
  "save_card": true,
  "payment_method_id": "pmi_abc123",
  "name": "山田 太郎",
  "customer_id": "cust_abc123",
  "email": "customer@example.com",
  "tel": "090-1234-5678"
}
'

{
  "id": "req_abc123",
  "status": "pending",
  "amount": 17.62,
  "currency": "usd",
  "external_id": "order_12345",
  "metadata": {},
  "flow_id": "flow_default",
  "payment_type": "single",
  "payment_url": "https://pay.sandbox.zafapay.com/checkout/req_abc123?token=xxxxxxxx",
  "created_at": "2025-01-01T00:00:00.000Z"
}

POST

payments

決済作成

curl --request POST \
  --url https://api.sandbox.zafapay.com/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 17.62,
  "currency": "usd",
  "capture_method": "automatic",
  "external_id": "order_12345",
  "flow_id": "flow_abc123",
  "payment_method": "card",
  "metadata": {},
  "save_card": true,
  "payment_method_id": "pmi_abc123",
  "name": "山田 太郎",
  "customer_id": "cust_abc123",
  "email": "customer@example.com",
  "tel": "090-1234-5678"
}
'

{
  "id": "req_abc123",
  "status": "pending",
  "amount": 17.62,
  "currency": "usd",
  "external_id": "order_12345",
  "metadata": {},
  "flow_id": "flow_default",
  "payment_type": "single",
  "payment_url": "https://pay.sandbox.zafapay.com/checkout/req_abc123?token=xxxxxxxx",
  "created_at": "2025-01-01T00:00:00.000Z"
}

承認

Authorization

string

header

必須

アクセストークンを使用したBearer認証

ボディ

application/json

amount

number

必須

決済金額（正の数値、小数点以下2桁まで対応）

例:

17.62

currency

string

必須

3文字の通貨コード（例: usd, sgd, jpy）

例:

"usd"

capture_method

enum<string>

キャプチャ方式（省略時はフローの設定に従う）

利用可能なオプション:

automatic,

manual

external_id

string

加盟店側の注文ID

例:

"order_12345"

flow_id

string

使用するフローID（省略時はデフォルトフロー）

例:

"flow_abc123"

payment_method

決済方法（文字列またはオブジェクト形式）

例:

"card"

metadata

object

トランザクションに保存する追加データ

save_card

boolean

trueの場合、カードを将来の継続決済用に保存します

例:

true

payment_method_id

string

保存済みの決済方法を使用して継続決済を行う（/v1/customers/{id}/payment-methodsから取得）

例:

"pmi_abc123"

name

string

カード名義人名（一部の決済方法では必須）

例:

"山田太郎"

customer_id

string

顧客ID（決済方法の保存・取得に使用）

例:

"cust_abc123"

string

顧客のメールアドレス

例:

"customer@example.com"

tel

string

顧客の電話番号

例:

"090-1234-5678"

レスポンス

決済作成成功

string

決済リクエストID

例:

"req_abc123"

status

string

ステータス

例:

"pending"

amount

number

決済金額

例:

17.62

currency

string

通貨コード

例:

"usd"

external_id

string | null

加盟店側の注文ID

例:

"order_12345"

metadata

object

追加データ（未指定の場合は空オブジェクト）

例:

{}

flow_id

string

使用された決済フローID

例:

"flow_default"

payment_type

enum<string>

決済タイプ。single: 通常決済、initial: カード保存を伴う初回決済、recurring: 保存済みカードを使用した継続決済

利用可能なオプション:

single,

initial,

recurring

例:

"single"

payment_url

string

チェックアウトページのURL（署名付き）

例:

"https://pay.sandbox.zafapay.com/checkout/req_abc123?token=xxxxxxxx"

created_at

string<date-time>

作成日時（ISO 8601形式）

例:

"2025-01-01T00:00:00.000Z"

エラーコード決済取得

概要

Payments

Customers

Webhook

承認

ボディ

レスポンス