Ana içeriğe geç

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.

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
}
}

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" }
]
}
]
}
AlanTipAçıklama
providers[].idstringSağlayıcının kimliği; create-payment-provider'da provider olarak gönderilir.
providers[].titlestringSağlayıcının adı.
providers[].is_alternativebooleanAlternatif ö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[].keystringAyarın anahtarı.
providers[].fields[].requiredbooleanAyar zorunluysa true.
providers[].fields[].typestringtext ya da select.
providers[].fields[].labelstringAyarın adı.
providers[].fields[].optionsobjectYalnı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ı​

KodDurum
200Liste döndü.
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.
429İstek sınırı aşıldı.