決済作成
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",
"external_id": "order_12345",
"flow_id": "flow_abc123",
"payment_method": "card",
"metadata": {},
"save_card": true,
"payment_method_id": "pmi_abc123",
"name": "山田 太郎",
"customer_id": "cust001",
"product_name": "Premium Plan",
"email": "customer@example.com",
"tel": "08000000000",
"token": "tok_xxxxxxxxxxxxxxxxxxxxxx",
"return_url": "https://your-site.com/payment-complete",
"success_url": "https://your-site.com/orders/12345/thanks",
"failure_url": "https://your-site.com/orders/12345/failed",
"cancel_url": "https://your-site.com/orders/12345/cancelled"
}
'import requests
url = "https://api.sandbox.zafapay.com/v1/payments"
payload = {
"amount": 17.62,
"currency": "usd",
"external_id": "order_12345",
"flow_id": "flow_abc123",
"payment_method": "card",
"metadata": {},
"save_card": True,
"payment_method_id": "pmi_abc123",
"name": "山田 太郎",
"customer_id": "cust001",
"product_name": "Premium Plan",
"email": "customer@example.com",
"tel": "08000000000",
"token": "tok_xxxxxxxxxxxxxxxxxxxxxx",
"return_url": "https://your-site.com/payment-complete",
"success_url": "https://your-site.com/orders/12345/thanks",
"failure_url": "https://your-site.com/orders/12345/failed",
"cancel_url": "https://your-site.com/orders/12345/cancelled"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 17.62,
currency: 'usd',
external_id: 'order_12345',
flow_id: 'flow_abc123',
payment_method: 'card',
metadata: {},
save_card: true,
payment_method_id: 'pmi_abc123',
name: '山田 太郎',
customer_id: 'cust001',
product_name: 'Premium Plan',
email: 'customer@example.com',
tel: '08000000000',
token: 'tok_xxxxxxxxxxxxxxxxxxxxxx',
return_url: 'https://your-site.com/payment-complete',
success_url: 'https://your-site.com/orders/12345/thanks',
failure_url: 'https://your-site.com/orders/12345/failed',
cancel_url: 'https://your-site.com/orders/12345/cancelled'
})
};
fetch('https://api.sandbox.zafapay.com/v1/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.zafapay.com/v1/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 17.62,
'currency' => 'usd',
'external_id' => 'order_12345',
'flow_id' => 'flow_abc123',
'payment_method' => 'card',
'metadata' => [
],
'save_card' => true,
'payment_method_id' => 'pmi_abc123',
'name' => '山田 太郎',
'customer_id' => 'cust001',
'product_name' => 'Premium Plan',
'email' => 'customer@example.com',
'tel' => '08000000000',
'token' => 'tok_xxxxxxxxxxxxxxxxxxxxxx',
'return_url' => 'https://your-site.com/payment-complete',
'success_url' => 'https://your-site.com/orders/12345/thanks',
'failure_url' => 'https://your-site.com/orders/12345/failed',
'cancel_url' => 'https://your-site.com/orders/12345/cancelled'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.zafapay.com/v1/payments"
payload := strings.NewReader("{\n \"amount\": 17.62,\n \"currency\": \"usd\",\n \"external_id\": \"order_12345\",\n \"flow_id\": \"flow_abc123\",\n \"payment_method\": \"card\",\n \"metadata\": {},\n \"save_card\": true,\n \"payment_method_id\": \"pmi_abc123\",\n \"name\": \"山田 太郎\",\n \"customer_id\": \"cust001\",\n \"product_name\": \"Premium Plan\",\n \"email\": \"customer@example.com\",\n \"tel\": \"08000000000\",\n \"token\": \"tok_xxxxxxxxxxxxxxxxxxxxxx\",\n \"return_url\": \"https://your-site.com/payment-complete\",\n \"success_url\": \"https://your-site.com/orders/12345/thanks\",\n \"failure_url\": \"https://your-site.com/orders/12345/failed\",\n \"cancel_url\": \"https://your-site.com/orders/12345/cancelled\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.zafapay.com/v1/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 17.62,\n \"currency\": \"usd\",\n \"external_id\": \"order_12345\",\n \"flow_id\": \"flow_abc123\",\n \"payment_method\": \"card\",\n \"metadata\": {},\n \"save_card\": true,\n \"payment_method_id\": \"pmi_abc123\",\n \"name\": \"山田 太郎\",\n \"customer_id\": \"cust001\",\n \"product_name\": \"Premium Plan\",\n \"email\": \"customer@example.com\",\n \"tel\": \"08000000000\",\n \"token\": \"tok_xxxxxxxxxxxxxxxxxxxxxx\",\n \"return_url\": \"https://your-site.com/payment-complete\",\n \"success_url\": \"https://your-site.com/orders/12345/thanks\",\n \"failure_url\": \"https://your-site.com/orders/12345/failed\",\n \"cancel_url\": \"https://your-site.com/orders/12345/cancelled\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.zafapay.com/v1/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 17.62,\n \"currency\": \"usd\",\n \"external_id\": \"order_12345\",\n \"flow_id\": \"flow_abc123\",\n \"payment_method\": \"card\",\n \"metadata\": {},\n \"save_card\": true,\n \"payment_method_id\": \"pmi_abc123\",\n \"name\": \"山田 太郎\",\n \"customer_id\": \"cust001\",\n \"product_name\": \"Premium Plan\",\n \"email\": \"customer@example.com\",\n \"tel\": \"08000000000\",\n \"token\": \"tok_xxxxxxxxxxxxxxxxxxxxxx\",\n \"return_url\": \"https://your-site.com/payment-complete\",\n \"success_url\": \"https://your-site.com/orders/12345/thanks\",\n \"failure_url\": \"https://your-site.com/orders/12345/failed\",\n \"cancel_url\": \"https://your-site.com/orders/12345/cancelled\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"redirect_url": "https://pay.sandbox.zafapay.com/3ds/req_abc123?token=xxxxxxxx",
"created_at": "2025-01-01T00:00:00.000Z"
}{
"status": "failed",
"error": {
"code": "card_declined",
"category": "soft_decline",
"message": "カードが拒否されました",
"recommended_action": "use_different_card"
},
"id": "req_abc123",
"transaction_id": "tx_xyz789",
"payment_type": "token"
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "Invalid request parameters",
"param": "amount",
"details": [
{
"path": [
"<string>"
],
"message": "<string>"
}
],
"request_id": "req_abc123xyz789"
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "Invalid request parameters",
"param": "amount",
"details": [
{
"path": [
"<string>"
],
"message": "<string>"
}
],
"request_id": "req_abc123xyz789"
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "Invalid request parameters",
"param": "amount",
"details": [
{
"path": [
"<string>"
],
"message": "<string>"
}
],
"request_id": "req_abc123xyz789"
}
}Payments
決済作成
新しい決済を作成します
POST
/
v1
/
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",
"external_id": "order_12345",
"flow_id": "flow_abc123",
"payment_method": "card",
"metadata": {},
"save_card": true,
"payment_method_id": "pmi_abc123",
"name": "山田 太郎",
"customer_id": "cust001",
"product_name": "Premium Plan",
"email": "customer@example.com",
"tel": "08000000000",
"token": "tok_xxxxxxxxxxxxxxxxxxxxxx",
"return_url": "https://your-site.com/payment-complete",
"success_url": "https://your-site.com/orders/12345/thanks",
"failure_url": "https://your-site.com/orders/12345/failed",
"cancel_url": "https://your-site.com/orders/12345/cancelled"
}
'import requests
url = "https://api.sandbox.zafapay.com/v1/payments"
payload = {
"amount": 17.62,
"currency": "usd",
"external_id": "order_12345",
"flow_id": "flow_abc123",
"payment_method": "card",
"metadata": {},
"save_card": True,
"payment_method_id": "pmi_abc123",
"name": "山田 太郎",
"customer_id": "cust001",
"product_name": "Premium Plan",
"email": "customer@example.com",
"tel": "08000000000",
"token": "tok_xxxxxxxxxxxxxxxxxxxxxx",
"return_url": "https://your-site.com/payment-complete",
"success_url": "https://your-site.com/orders/12345/thanks",
"failure_url": "https://your-site.com/orders/12345/failed",
"cancel_url": "https://your-site.com/orders/12345/cancelled"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 17.62,
currency: 'usd',
external_id: 'order_12345',
flow_id: 'flow_abc123',
payment_method: 'card',
metadata: {},
save_card: true,
payment_method_id: 'pmi_abc123',
name: '山田 太郎',
customer_id: 'cust001',
product_name: 'Premium Plan',
email: 'customer@example.com',
tel: '08000000000',
token: 'tok_xxxxxxxxxxxxxxxxxxxxxx',
return_url: 'https://your-site.com/payment-complete',
success_url: 'https://your-site.com/orders/12345/thanks',
failure_url: 'https://your-site.com/orders/12345/failed',
cancel_url: 'https://your-site.com/orders/12345/cancelled'
})
};
fetch('https://api.sandbox.zafapay.com/v1/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.zafapay.com/v1/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 17.62,
'currency' => 'usd',
'external_id' => 'order_12345',
'flow_id' => 'flow_abc123',
'payment_method' => 'card',
'metadata' => [
],
'save_card' => true,
'payment_method_id' => 'pmi_abc123',
'name' => '山田 太郎',
'customer_id' => 'cust001',
'product_name' => 'Premium Plan',
'email' => 'customer@example.com',
'tel' => '08000000000',
'token' => 'tok_xxxxxxxxxxxxxxxxxxxxxx',
'return_url' => 'https://your-site.com/payment-complete',
'success_url' => 'https://your-site.com/orders/12345/thanks',
'failure_url' => 'https://your-site.com/orders/12345/failed',
'cancel_url' => 'https://your-site.com/orders/12345/cancelled'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.zafapay.com/v1/payments"
payload := strings.NewReader("{\n \"amount\": 17.62,\n \"currency\": \"usd\",\n \"external_id\": \"order_12345\",\n \"flow_id\": \"flow_abc123\",\n \"payment_method\": \"card\",\n \"metadata\": {},\n \"save_card\": true,\n \"payment_method_id\": \"pmi_abc123\",\n \"name\": \"山田 太郎\",\n \"customer_id\": \"cust001\",\n \"product_name\": \"Premium Plan\",\n \"email\": \"customer@example.com\",\n \"tel\": \"08000000000\",\n \"token\": \"tok_xxxxxxxxxxxxxxxxxxxxxx\",\n \"return_url\": \"https://your-site.com/payment-complete\",\n \"success_url\": \"https://your-site.com/orders/12345/thanks\",\n \"failure_url\": \"https://your-site.com/orders/12345/failed\",\n \"cancel_url\": \"https://your-site.com/orders/12345/cancelled\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.zafapay.com/v1/payments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 17.62,\n \"currency\": \"usd\",\n \"external_id\": \"order_12345\",\n \"flow_id\": \"flow_abc123\",\n \"payment_method\": \"card\",\n \"metadata\": {},\n \"save_card\": true,\n \"payment_method_id\": \"pmi_abc123\",\n \"name\": \"山田 太郎\",\n \"customer_id\": \"cust001\",\n \"product_name\": \"Premium Plan\",\n \"email\": \"customer@example.com\",\n \"tel\": \"08000000000\",\n \"token\": \"tok_xxxxxxxxxxxxxxxxxxxxxx\",\n \"return_url\": \"https://your-site.com/payment-complete\",\n \"success_url\": \"https://your-site.com/orders/12345/thanks\",\n \"failure_url\": \"https://your-site.com/orders/12345/failed\",\n \"cancel_url\": \"https://your-site.com/orders/12345/cancelled\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.zafapay.com/v1/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 17.62,\n \"currency\": \"usd\",\n \"external_id\": \"order_12345\",\n \"flow_id\": \"flow_abc123\",\n \"payment_method\": \"card\",\n \"metadata\": {},\n \"save_card\": true,\n \"payment_method_id\": \"pmi_abc123\",\n \"name\": \"山田 太郎\",\n \"customer_id\": \"cust001\",\n \"product_name\": \"Premium Plan\",\n \"email\": \"customer@example.com\",\n \"tel\": \"08000000000\",\n \"token\": \"tok_xxxxxxxxxxxxxxxxxxxxxx\",\n \"return_url\": \"https://your-site.com/payment-complete\",\n \"success_url\": \"https://your-site.com/orders/12345/thanks\",\n \"failure_url\": \"https://your-site.com/orders/12345/failed\",\n \"cancel_url\": \"https://your-site.com/orders/12345/cancelled\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"redirect_url": "https://pay.sandbox.zafapay.com/3ds/req_abc123?token=xxxxxxxx",
"created_at": "2025-01-01T00:00:00.000Z"
}{
"status": "failed",
"error": {
"code": "card_declined",
"category": "soft_decline",
"message": "カードが拒否されました",
"recommended_action": "use_different_card"
},
"id": "req_abc123",
"transaction_id": "tx_xyz789",
"payment_type": "token"
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "Invalid request parameters",
"param": "amount",
"details": [
{
"path": [
"<string>"
],
"message": "<string>"
}
],
"request_id": "req_abc123xyz789"
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "Invalid request parameters",
"param": "amount",
"details": [
{
"path": [
"<string>"
],
"message": "<string>"
}
],
"request_id": "req_abc123xyz789"
}
}{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "Invalid request parameters",
"param": "amount",
"details": [
{
"path": [
"<string>"
],
"message": "<string>"
}
],
"request_id": "req_abc123xyz789"
}
}承認
アクセストークンを使用したBearer認証
ボディ
application/json
決済金額（正の数値、小数点以下2桁まで対応）。Depot の場合は円単位の正の整数・100000以下である必要があり、小数は受け付けられません。
例:
17.62
3文字の通貨コード（例: usd, sgd, jpy）。Depot は jpy のみ対応。
例:
"usd"
キャプチャ方式（省略時はフローの設定に従う）
利用可能なオプション:
automatic, manual 加盟店側の注文ID
例:
"order_12345"
使用するフローID（省略時はデフォルトフロー）
例:
"flow_abc123"
決済方法（文字列またはオブジェクト形式）
例:
"card"
トランザクションに保存する追加データ
trueの場合、カードを将来の継続決済用に保存します
例:
true
保存済みの決済方法を使用して継続決済を行う（/v1/customers/{id}/payment-methodsから取得）
例:
"pmi_abc123"
カード名義（一部の決済方法では必須）
例:
"山田 太郎"
顧客ID（決済方法の保存・取得に使用）。Depot では半角英数字のみ・150文字以内である必要があります。記号を含む値もここでは受理されますが、顧客が支払う段階でエラー 1004 となり失敗します。
例:
"cust001"
決済ページで顧客に表示される商品名。Depot では30文字以内、漢字は使用できません。
例:
"Premium Plan"
顧客のメールアドレス。Depot 決済では必須。
例:
"customer@example.com"
顧客の電話番号。Depot では10〜15桁の数字である必要があります。
例:
"08000000000"
JavaScript SDKで取得したトークンID（tok_ プレフィックス）。サーバー間決済に使用。トークンは1回のみ使用可能で、30分で有効期限切れとなります。
例:
"tok_xxxxxxxxxxxxxxxxxxxxxx"
3Dセキュア認証後に顧客をリダイレクトするURL。token パラメータ使用時は必ず指定してください。指定しない場合、3DS後のリダイレクト先がなくなります。
例:
"https://your-site.com/payment-complete"
決済成功後に顧客をリダイレクトするURL。決済ごとに指定でき、決済リンクのURLおよびダッシュボードで設定した加盟店デフォルトより優先されます。http(s) のURLである必要があります。
Maximum string length:
2048例:
"https://your-site.com/orders/12345/thanks"
決済失敗後に顧客をリダイレクトするURL。決済リンクのURLおよび加盟店デフォルトより優先されます。http(s) のURLである必要があります。
Maximum string length:
2048例:
"https://your-site.com/orders/12345/failed"
決済がキャンセルされた際に顧客をリダイレクトするURL。決済リンクのURLおよび加盟店デフォルトより優先されます。http(s) のURLである必要があります。
Maximum string length:
2048例:
"https://your-site.com/orders/12345/cancelled"
レスポンス
決済作成成功
決済リクエストID
例:
"req_abc123"
ステータス
例:
"pending"
決済金額
例:
17.62
通貨コード
例:
"usd"
加盟店側の注文ID
例:
"order_12345"
追加データ（未指定の場合は空オブジェクト）
例:
{}
使用された決済フローID
例:
"flow_default"
決済タイプ。single: 通常決済、initial: カード保存を伴う初回決済、recurring: 保存済みカードを使用した継続決済、token: トークンを使用したサーバー間決済
利用可能なオプション:
single, initial, recurring, token 例:
"single"
チェックアウトページのURL（署名付き）。ホスト型チェックアウト決済時に返されます。
例:
"https://pay.sandbox.zafapay.com/checkout/req_abc123?token=xxxxxxxx"
3Dセキュア認証URL。status が requires_action の場合に返されます（トークン決済のみ）。
例:
"https://pay.sandbox.zafapay.com/3ds/req_abc123?token=xxxxxxxx"
作成日時（ISO 8601形式）
例:
"2025-01-01T00:00:00.000Z"
⌘I