create-payment-provider
POST /api/{team}/gateway/create-payment-provider
Çalışma alanına bir ödeme hesabı ekler. Sağlayıcılar ve istedikleri ayarlar: retrieve-providers. Ayarların sağlayıcıda çalışıp çalışmadığı bu uçta denenmez. Eklenen hesap yanıttaki token'la anılır; ödeme isteklerinde payment_provider_token olarak bu token gönderilir.
Ayarlar (sağlayıcı anahtarları) hiçbir yanıtta dönmez; API kayıtlarında da gizlenir.
Yalnızca iş ortağının açtığı çalışma alanlarında çalışır; diğerleri 403 alır. Bkz. İş Ortakları.
Kimlik doğrulama
Çalışma alanının anahtarıyla: X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza.
İstek
{
"payment_provider": {
"provider": "esnekpos",
"name": "EsnekPos",
"settings": {
"test_merchant": "TEST_MERCHANT",
"test_merchant_key": "TEST_KEY",
"merchant": "MERCHANT",
"merchant_key": "KEY"
}
}
}
| Alan | Tip | Zorunlu | Açıklama |
|---|---|---|---|
payment_provider.provider | string | evet | Sağlayıcının id'si (retrieve-providers). |
payment_provider.name | string | evet | Hesabın adı, en çok 255 karakter. |
payment_provider.settings | object | hayır | Sağlayıcının ayarları. Anahtarlar fields[].key (canlı) ve test_ + fields[].key (test). Her değer string, en çok 255 karakter; select alanlarında options'taki anahtarlardan biri. |
Zorunlu ayarlar çalışma alanının moduna göre değişir: test modundaki çalışma alanında required: true alanların test_ önekli hâlleri, canlı moddaki çalışma alanında öneksiz hâlleri zorunludur. Diğer modun ayarları isteğe bağlıdır; ikisini birlikte gönderebilirsiniz.
Çalışma alanının ödeme hesabı sayısı ödemehub'ın tanımladığı sınırla sınırlı olabilir.
SDK örnekleri
Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.
- PHP
- Node.js
- Python
- Java
- cURL
use Gurmehub\Odemehub\Request\CreatePaymentProvider;
$paymentProvider = $client->createPaymentProvider(new CreatePaymentProvider(
provider: 'esnekpos',
name: 'EsnekPos',
settings: [
'test_merchant' => 'TEST_MERCHANT',
'test_merchant_key' => 'TEST_KEY',
],
))->paymentProvider;
$paymentProvider->token; // ödeme isteklerinde payment_provider_token
const { paymentProvider } = await client.createPaymentProvider({
provider: 'esnekpos',
name: 'EsnekPos',
settings: { test_merchant: 'TEST_MERCHANT', test_merchant_key: 'TEST_KEY' },
});
paymentProvider.token; // ödeme isteklerinde payment_provider_token
from odemehub.request import CreatePaymentProvider
payment_provider = client.create_payment_provider(CreatePaymentProvider(
provider="esnekpos",
name="EsnekPos",
settings={"test_merchant": "TEST_MERCHANT", "test_merchant_key": "TEST_KEY"},
)).payment_provider
payment_provider.token # ödeme isteklerinde payment_provider_token
import com.odemehub.request.CreatePaymentProvider;
import java.util.Map;
var paymentProvider = client.createPaymentProvider(CreatePaymentProvider.builder()
.provider("esnekpos")
.name("EsnekPos")
.settings(Map.of("test_merchant", "TEST_MERCHANT", "test_merchant_key", "TEST_KEY"))
.build()).getPaymentProvider();
paymentProvider.getToken(); // ödeme isteklerinde payment_provider_token
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/create-payment-provider"
BODY='{"payment_provider":{"provider":"esnekpos","name":"EsnekPos","settings":{"test_merchant":"TEST_MERCHANT","test_merchant_key":"TEST_KEY"}}}'
TIMESTAMP=$(date +%s)
SIGNATURE=$(printf '%s\n%s\n%s\n%s' "$TIMESTAMP" "POST" "$URI_PATH" "$BODY" | openssl dgst -sha256 -hmac "$ODEMEHUB_API_SECRET" | sed 's/^.* //')
curl -X POST "https://sandbox.odemehub.com$URI_PATH" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $ODEMEHUB_API_KEY" \
-H "X-Timestamp: $TIMESTAMP" \
-H "X-Signature: $SIGNATURE" \
--data-raw "$BODY"
Yanıt
{
"result": { "successful": true, "message": null },
"payment_provider": {
"token": "9b2f4c1e-7a3d-4e8b-b5f6-2c9d0e1a7f43",
"name": "EsnekPos",
"provider": "esnekpos",
"is_default": false,
"created_at": "2026-11-05T09:35:00.000000Z"
}
}
Ödeme hesabı nesnesi
| Alan | Tip | Açıklama |
|---|---|---|
token | string | Hesabın token'ı (UUID); ödeme isteklerinde payment_provider_token, güncelleme ve silmede adres parametresi. |
name | string | Hesabın adı. |
provider | string | Sağlayıcının id'si. |
is_default | boolean | Çalışma alanının varsayılan hesabıysa true. Bkz. Ödeme hesabı seçimi. |
created_at | string | Ekleniş anı, ISO 8601, UTC. |
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | Hesap eklendi. |
401 | API anahtarı ya da imza geçersiz. |
403 | Çalışma alanı işlem yapamıyor ya da bir iş ortağının açtığı çalışma alanı değil: Bu uç yalnızca iş ortağı çalışma alanlarına açıktır. |
422 | Doğrulama hatası ya da ödeme hesabı sınırı. |
429 | İstek sınırı aşıldı. |
Hatalar
| Alan | Mesaj |
|---|---|
payment_provider.provider | Bu ödeme hesabı türü bulunamadı; türleri retrieve-providers ile sorgulayın. |
payment_provider.provider | Çalışma alanınız en fazla {sınır} ödeme hesabı ekleyebilir. |