顧客を作成

POSThttps://api.omise.co/customers

リピート請求のために支払い方法を保存する顧客プロファイルを作成します。顧客は複数の保存されたカードを持ち、カード詳細を再入力せずに将来の購入が可能です。

---

リクエストパラメータ

推奨 - 2 フィールド推奨パラメータ

▼

`email`STRING(optional)

顧客のメールアドレス。領収書、返金通知、サポートに使用されます。

Example:"john@example.com"

`description`STRING(optional)

顧客名または説明。ダッシュボードやレポートで顧客を識別するのに役立ちます。

Example:"John Doe"

追加 - 3 フィールド追加パラメータ

▼

---

レスポンス

200

顧客が正常に作成されました

顧客プロファイルが作成されました。将来の課金のために顧客IDをデータベースに保存する必要があります。

顧客オブジェクトのフィールド:

• id - 顧客ID (cust_*)。データベースに保存してください。
• email - 顧客のメールアドレス。
• description - 顧客の説明/名前。
• default_card - デフォルトの支払いカードのID（カードが提供された場合）。
• cards - すべての保存されたカードを含むリストオブジェクト。
• metadata - カスタムキーと値のデータ。

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 無効なメール形式
• 無効なトークンID
• メタデータが15,000文字を超過

401

認証エラー

認証に失敗しました。APIキーが無効または不足しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式の誤り

404

見つかりません

トークンが見つからないか無効です。

一般的な原因:

• トークンIDが存在しない
• トークンがすでに使用済み
• トークンの有効期限切れ

5xx

サーバーエラー

サーバー側でエラーが発生しました。稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/customers \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "email=john@example.com" \
  -d "description=John Doe" \
  -d "card=tokn_test_5xuy4w91xqz7d1w9u0t"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = Omise::Customer.create({
  email: 'john@example.com',
  description: 'John Doe',
  card: 'tokn_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.create(
    email='john@example.com',
    description='John Doe',
    card='tokn_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const customer = await omise.customers.create({
  email: 'john@example.com',
  description: 'John Doe',
  card: 'tokn_test_5xuy4w91xqz7d1w9u0t'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$customer = OmiseCustomer::create([
    'email' => 'john@example.com',
    'description' => 'John Doe',
    'card' => 'tokn_test_5xuy4w91xqz7d1w9u0t'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Customer customer = client.customers().create()
    .email("john@example.com")
    .description("John Doe")
    .card("tokn_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customer = await client.Customers.Create(new CreateCustomerRequest
{
    Email = "john@example.com",
    Description = "John Doe",
    Card = "tokn_test_5xuy4w91xqz7d1w9u0t"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

customer, _ := client.Customers().Create(&operations.CreateCustomer{
    Email:       "john@example.com",
    Description: "John Doe",
    Card:        "tokn_test_5xuy4w91xqz7d1w9u0t",
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	パラメータの欠落または無効	メール形式とメタデータサイズを確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
used_token	トークンがすでに使用済み	新しいトークンを生成
token_not_found	トークンIDが存在しない	トークンIDが正しいか確認
invalid_card	カードトークンが無効	トークンが正常に作成されたか確認

顧客フィールド

フィールド	説明
id	顧客ID（データベースに保存）
email	顧客のメールアドレス
description	顧客名または説明
default_card	デフォルトの支払いカードのID
cards	すべての保存されたカードのリスト
metadata	カスタムキーと値のデータ
created_at	顧客作成タイムスタンプ

---

🔑API認証情報

▼

試してみる

推奨 - 2項目

▼

追加 - 2項目

▼

あなたのIP: ...読み込み中...