Ana içeriğe geç

retrieve-checkout-design

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

Ödeme sayfasının (sipariş, ödeme linki ve abonelik ödemelerinin alındığı sayfa) güncel tasarımını döner; hiçbir şeyi değiştirmez. Tasarım hiç kaydedilmemişse varsayılan değerler döner.

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.

$design = $client->retrieveCheckoutDesign()->checkoutDesign;

$design->logo; // yoksa null
$design->accentColor;
$design->requiresTerms;
$design->termsUrl; // yoksa null

Yanıt​

{
"result": { "successful": true, "message": null },
"checkout_design": {
"logo": "https://app.odemehub.com/storage/12/logos/Yw3k...png",
"layout": "standard",
"is_reversed": false,
"summary_color": "#1f2937",
"accent_color": "#2563eb",
"font": "inter",
"form_style": "rounded",
"takes_coupons": false,
"offers_shipping_methods": false,
"submit_type": "auto",
"payment_method_style": "list",
"requires_terms": true,
"terms_url": "https://magazam.com/hizmet-sartlari",
"takes_company": true
}
}

Ödeme sayfası tasarımı nesnesi​

AlanTipAçıklama
logostring | nullLogonun adresi; create-logo ile yüklenir. Logo yoksa null.
layoutstringYerleşim: standard ya da card.
is_reversedbooleanPaneldeki Ters çevir seçeneği; açıksa true.
summary_colorstringMarka rengi, #rrggbb.
accent_colorstringVurgu rengi, #rrggbb.
fontstringYazı tipi: default, be_vietnam_pro, bitter, chakra_petch, hahmlet, inconsolata, inter, lato, lora, m_plus_1_code, montserrat, noto_sans, noto_sans_jp, noto_serif, nunito, open_sans, pridi, pt_sans, pt_serif, raleway, roboto, roboto_slab, source_sans_3, titillium_web, ubuntu_mono, zen_maru_gothic.
form_stylestringKöşeler: rounded, rectangular ya da pill.
takes_couponsbooleanKupon kodu alanı gösterilirse true.
offers_shipping_methodsbooleanGönderim seçenekleri gösterilirse true.
submit_typestringÖdeme butonunun metni: auto (abonelikte "Abone Ol", diğerlerinde "Öde"), pay, book, donate, subscribe.
payment_method_stylestringÖdeme yöntemlerinin gösterimi: list ya da tabs.
requires_termsbooleanÖdeyenin hizmet şartlarını kabul etmesi gerekiyorsa true.
terms_urlstring | nullHizmet şartlarının adresi.
takes_companybooleanKurumsal fatura bilgisi alınırsa true.

HTTP durum kodları​

KodDurum
200Tasarım 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ı.