/v3/businesses/ के अंतर्गत छह सार्वजनिक endpoints के ज़रिए सभी व्यवसाय इकाइयों का प्रबंधन होता है। यह पेज आपको अवधारणात्मक मार्गदर्शन देता है। पूरे अनुरोध और रिस्पॉन्स स्कीमा के लिए API reference देखें।
व्यवसाय सूची देखें
GET /v3/businesses/
आपके एप्लिकेशन के व्यवसायों की पेजिनेटेड सूची, जिसमें स्थिति, खोज, देश और तिथि सीमा के फ़िल्टर हैं।
एक व्यवसाय प्राप्त करें
GET /v3/businesses/{vendor_data}/
vendor_data से एक व्यवसाय प्राप्त करें।
व्यवसाय बनाएँ
POST /v3/businesses/create/
किसी भी व्यवसाय सत्यापन (KYB) सत्र से पहले व्यवसाय पहले से बनाएँ:
vendor_data वाला व्यवसाय पहले से मौजूद है, तो संघर्ष त्रुटि लौटता है। मौजूदा व्यवसाय अपडेट करने के लिए PATCH का उपयोग करें।
व्यवसाय अपडेट करें
PATCH /v3/businesses/{vendor_data}/
बदले जा सकने वाले प्रोफ़ाइल फ़ील्ड अपडेट करें। रजिस्ट्री लुकअप से मिले फ़ील्ड (legal_name, registration_number, country_code) सत्यापन के बाद केवल-पढ़ने योग्य होते हैं, लेकिन उन्हें ओवरराइड किया जा सकता है। ओवरराइड ऑडिट लॉग में चिह्नित होते हैं।
बदले जा सकने वाले फ़ील्ड: display_name, metadata, tags।
सत्यापन के बाद केवल-पढ़ने योग्य: रजिस्ट्री से लिए गए सभी फ़ील्ड, एकत्रित काउंटर और features मैप।
business.data.updated जारी होता है।
स्थिति बदलें
PATCH /v3/businesses/{vendor_data}/update-status/
किसी व्यवसाय को ACTIVE, FLAGGED और BLOCKED के बीच स्थानांतरित करें।
business.status.updated जारी करता है।
व्यवसाय हटाएँ (बैच)
POST /v3/businesses/delete/
एक या अधिक व्यवसाय हटाएँ। व्यवसाय के रिकॉर्ड स्थायी रूप से हटा दिए जाते हैं। उनके सत्यापन सत्र इस endpoint में शामिल नहीं हैं और व्यवसाय से उनका लिंक हटाकर बने रहते हैं। उन्हें Delete Session से हटाएँ। लेन-देन भी इसमें शामिल नहीं हैं; उन्हें Console से हटाएँ।
अनुमति मॉडल
सभी/v3/businesses/* endpoints businesses अनुमति संसाधन के दायरे में हैं:
भूमिकाएँ और अनुमतियाँ देखें।
इन ऑपरेशनों द्वारा जारी webhook इवेंट्स
अगले कदम
डेटा मॉडल
फ़ील्ड का पूरा संदर्भ।
सूची API
GET /v3/businesses/ स्कीमा।
निर्माण API
POST /v3/businesses/create/ स्कीमा।