Ana içeriğe geç

update-checkout-design

POST /api/{team}/gateway/update-checkout-design

Ödeme sayfasının tasarımını değiştirir; yalnızca gönderilen alanlar değişir. Değişiklik, sayfanın bir sonraki açılışından itibaren görünür. Logo önce create-logo ile yüklenir, dönen adres burada logo olarak 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​

{
"checkout_design": {
"logo": "https://app.odemehub.com/storage/12/logos/Yw3k...png",
"accent_color": "#2563eb",
"font": "inter",
"requires_terms": true,
"terms_url": "https://magazam.com/hizmet-sartlari"
}
}

checkout_design zorunludur ve yalnızca tasarım nesnesindeki alanları taşır; başka anahtar gönderilirse 422. Alanların değerleri o tablodaki gibidir. Ek kurallar:

AlanKural
logocreate-logo ile alınan adres, en çok 255 karakter. Logoyu kaldırmak için null.
terms_urlhttp ya da https ile başlayan adres, en çok 255 karakter; null gönderilebilir.
summary_color, accent_color# ve altı onaltılık hane, örneğin #2563eb.
Diğer alanlarGönderilirse null olamaz.

requires_terms açıkken hizmet şartları adresi bulunmalıdır: istekte gönderilmiş ya da daha önce kaydedilmiş olmalıdır.

SDK örnekleri​

not

Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak. SDK'larda logoyu ya da terms_url'i kaldırmak için PHP ve Python'da clear, Node.js ve Java'da alana null verilir.

use Gurmehub\Odemehub\Request\UpdateCheckoutDesign;

$design = $client->updateCheckoutDesign(new UpdateCheckoutDesign(
accentColor: '#2563eb',
font: 'inter',
))->checkoutDesign;

$client->updateCheckoutDesign(new UpdateCheckoutDesign(clear: ['logo'])); // logoyu kaldırır

Yanıt​

result ve tasarımın güncel hâli (checkout_design): Ödeme sayfası tasarımı nesnesi.

HTTP durum kodları​

KodDurum
200Tasarım güncellendi.
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ı.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
checkout_design.terms_urlHizmet şartları açıkken hizmet şartları adresi zorunludur.