retrieve-providers
POST /api/{team}/gateway/retrieve-providers
Ödeme hesabı eklenebilen sağlayıcıları ve her birinin istediği ayar alanlarını (fields) döner; hiçbir şeyi değiştirmez. create-payment-provider isteğinde provider olarak sağlayıcının id'si, settings anahtarları olarak da fields[].key değerleri gönderilir.
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
Gövde boş bir nesnedir:
{}
SDK örnekleri
not
Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.
- PHP
- Node.js
- Python
- Java
- cURL
foreach ($client->retrieveProviders()->providers as $provider) {
$provider->id; // create-payment-provider'da provider
foreach ($provider->fields as $field) {
$field->key; // canlı ayar; testinki 'test_'.$field->key
$field->required;
$field->options; // yalnızca select alanlarında, diğerlerinde null
}
}
const { providers } = await client.retrieveProviders();
for (const provider of providers) {
provider.id; // create-payment-provider'da provider
for (const field of provider.fields) {
field.key; // canlı ayar; testinki `test_${field.key}`
field.required;
field.options; // yalnızca select alanlarında, diğerlerinde null
}
}
for provider in client.retrieve_providers().providers:
provider.id # create-payment-provider'da provider
for field in provider.fields:
field.key # canlı ayar; testinki "test_" + field.key
field.required
field.options # yalnızca select alanlarında, diğerlerinde None
import com.odemehub.request.RetrieveProviders;
for (var provider : client.retrieveProviders(new RetrieveProviders()).getProviders()) {
provider.getId(); // create-payment-provider'da provider
for (var field : provider.getFields()) {
field.getKey(); // canlı ayar; testinki "test_" + field.getKey()
field.isRequired();
field.getOptions(); // yalnızca select alanlarında dolu, diğerlerinde boş
}
}
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/retrieve-providers"
BODY='{}'
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 },
"providers": [
{
"id": "esnekpos",
"title": "EsnekPos",
"is_alternative": false,
"fields": [
{ "key": "merchant", "required": true, "type": "text", "label": "Merchant" },
{ "key": "merchant_key", "required": true, "type": "text", "label": "Merchant Key" }
]
}
]
}
| Alan | Tip | Açıklama |
|---|---|---|
providers[].id | string | Sağlayıcının kimliği; create-payment-provider'da provider olarak gönderilir. |
providers[].title | string | Sağlayıcının adı. |
providers[].is_alternative | boolean | Alternatif ödeme yöntemiyse (kart almayan, müşteriyi sağlayıcının sayfasına yönlendiren) true. Alternatif hesap varsayılan yapılamaz ve payment_provider_token olarak kullanılamaz. |
providers[].fields[].key | string | Ayarın anahtarı. |
providers[].fields[].required | boolean | Ayar zorunluysa true. |
providers[].fields[].type | string | text ya da select. |
providers[].fields[].label | string | Ayarın adı. |
providers[].fields[].options | object | Yalnızca select alanlarında: gönderilebilecek değerler (anahtar) ve adları (değer). |
Her ayar iki kez gönderilebilir: canlı mod için anahtarın kendisiyle (merchant), test modu için test_ önekiyle (test_merchant). Ayrıntı: create-payment-provider.
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | Liste döndü. |
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. |
429 | İstek sınırı aşıldı. |