Capabilities और tasks

एक capability आपको बताती है कि क्या एक customer किसी विशिष्ट outcome, payment method, और direction का उपयोग कर सकता है। Open tasks आपको बताते हैं कि उस capability या संबंधित resource के आगे बढ़ने से पहले क्या होना चाहिए।

export API_BASE='https://platform.swipelux.com'
export SWIPELUX_API_KEY='replace-with-your-api-key'

समर्थित capabilities खोजें

Customer के वर्तमान विकल्पों को GET /v3/customers/{customerId}/capabilities/supported के साथ पढ़ें:

curl --request GET \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/capabilities/supported" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

एक response entry चुनें जो इच्छित directions, method, और accountType से मेल खाती हो। केवल तब जारी रखें जब availability available या beta हो और eligibility.eligible true हो। यदि institutions लौटाए जाते हैं, तो केवल उस response से एक ID चुनें। चयनित data[].id को CAPABILITY_ID के रूप में संग्रहीत करें। किसी अन्य customer या environment से capability ID को कभी copy न करें।

Pooled बनाम named account types

Bank capabilities दो variants में आती हैं, जिन्हें accountType field और capability ID suffix (उदाहरण के लिए ach_pooled, wire_named) के रूप में encode किया गया है:

pooled: साझा Swipelux bank account। Funds को route करने के लिए प्रत्येक pay-in एक unique reference का उपयोग करता है। एक-बार के transfers के लिए इसे चुनें।
named: customer के लिए dedicated bank details (virtual IBAN, dedicated ACH account)। पुन: उपयोग करने योग्य और किसी भी payer के साथ साझा करने योग्य। Issued bank accounts के लिए आवश्यक।

Default रूप से pooled का उपयोग करें। named का उपयोग केवल तभी करें जब customer को पुन: उपयोग करने योग्य bank details की आवश्यकता हो। यह देखने के लिए कि कौन से variants उपलब्ध हैं, supported response की जाँच करें।

Capability का अनुरोध करें

चयनित option का अनुरोध POST /v3/customers/{customerId}/capabilities/{capabilityId} के साथ करें:

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/capabilities/${CAPABILITY_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: capability-request-001" \
  --header "Content-Type: application/json" \
  --data '{}'

एक explicit institutions array का उपयोग केवल तब करें जब आपको supported-capability response द्वारा लौटाए गए IDs में से चयन करने की आवश्यकता हो। data.status को CAPABILITY_STATUS, data.openTaskIds को OPEN_TASK_IDS, और प्रत्येक data.applications[].id को APPLICATION_IDS में संग्रहीत करें।

वर्तमान tasks पूरे करें

Tasks को GET /v3/customers/{customerId}/tasks के साथ सूचीबद्ध करें, OPEN_TASK_IDS से IDs चुनें, फिर प्रत्येक वर्तमान task को GET /v3/customers/{customerId}/tasks/{taskId} के साथ पढ़ें:

curl --request GET \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/tasks/${TASK_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

नवीनतम data.revision और data.requirements का उपयोग करें। यदि दोनों में से कोई बदल सकता है, तो submit करने से ठीक पहले task को पुन: प्राप्त करें।

Hosted actions

जब task verificationSessions या tosSessions लौटाता है, तो प्रत्येक session id और वर्तमान url संग्रहीत करें। Customer को लौटाए गए URL पर भेजें, फिर task को फिर से पढ़ें। ये task-scoped actions हैं, अलग customer-verification lifecycle नहीं।

Documents upload करें

जब कोई requirement एक document का अनुरोध करता है, तो उसे POST /v3/customers/{customerId}/documents के साथ upload करें:

export DOCUMENT_PATH='/absolute/path/to/requested-document.pdf'

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/documents" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-document-001" \
  --form "file=@${DOCUMENT_PATH}"

Answer submit करने से पहले जो इसे संदर्भित करता है, लौटाए गए data.id को DOCUMENT_ID के रूप में संग्रहीत करें।

API answers

वर्तमान revision के लिए एक पूर्ण answer set POST /v3/customers/{customerId}/tasks/{taskId}/submissions के साथ submit करें:

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/tasks/${TASK_ID}/submissions" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: task-submission-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "taskRevision": 3,
  "answers": [
    {
      "requirementId": "req_from_current_task",
      "answer": {
        "type": "text",
        "value": "Current answer"
      }
    }
  ]
}
JSON

प्रत्येक requirement ID और answer type नवीनतम task से लें। यदि API यह रिपोर्ट करता है कि task बदल गया है, तो इसे पुन: प्राप्त करें और नए revision से submission को फिर से बनाएँ।

जब capability तैयार हो तो जारी रखें

Capability को GET /v3/customers/{customerId}/capabilities/{capabilityId} के साथ फिर से पढ़ें:

curl --request GET \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/capabilities/${CAPABILITY_ID}" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}"

संग्रहीत status और task IDs को नवीनतम response से बदलें। केवल तब जारी रखें जब वर्तमान capability status उस account, quote, या transfer की अनुमति देती है जिसे आप बनाने का इरादा रखते हैं। आगे, Common flows में मेल खाती यात्रा चुनें।

शुरू करें

ग्राहकों को शामिल करें

धन प्रवाह बनाएँ

लॉन्च

Capabilities और tasks

समर्थित capabilities खोजें

Pooled बनाम named account types

Capability का अनुरोध करें

वर्तमान tasks पूरे करें

Hosted actions

Documents upload करें

API answers

जब capability तैयार हो तो जारी रखें

​समर्थित capabilities खोजें

​Pooled बनाम named account types

​Capability का अनुरोध करें

​वर्तमान tasks पूरे करें

​Hosted actions

​Documents upload करें

​API answers

​जब capability तैयार हो तो जारी रखें

समर्थित capabilities खोजें

Pooled बनाम named account types

Capability का अनुरोध करें

वर्तमान tasks पूरे करें

Hosted actions

Documents upload करें

API answers

जब capability तैयार हो तो जारी रखें