Ana içeriğe geç

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"
}
}
}
AlanTipZorunluAçıklama
payment_provider.providerstringevetSağlayıcının id'si (retrieve-providers).
payment_provider.namestringevetHesabın adı, en çok 255 karakter.
payment_provider.settingsobjecthayırSağ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​

not

Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.

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

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​

AlanTipAçıklama
tokenstringHesabın token'ı (UUID); ödeme isteklerinde payment_provider_token, güncelleme ve silmede adres parametresi.
namestringHesabın adı.
providerstringSağlayıcının id'si.
is_defaultbooleanÇalışma alanının varsayılan hesabıysa true. Bkz. Ödeme hesabı seçimi.
created_atstringEkleniş anı, ISO 8601, UTC.

HTTP durum kodları​

KodDurum
200Hesap eklendi.
401API 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.
422Doğrulama hatası ya da ödeme hesabı sınırı.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
payment_provider.providerBu ö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.