Képességek és feladatok

Egy képesség jelzi, hogy egy ügyfél képes-e használni egy adott eredményt, fizetési módot és irányt. A nyitott feladatok megmondják, mi kell ahhoz, hogy a képesség vagy egy kapcsolódó erőforrás előrehaladhasson.

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

Támogatott képességek felfedezése

Olvassa be az ügyfél aktuális lehetőségeit a GET /v3/customers/{customerId}/capabilities/supported művelettel:

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

Válasszon egy válaszelemet, amely megfelel a szándékolt directions, method és accountType értékeknek. Csak akkor folytassa, ha az availability értéke available vagy beta, és az eligibility.eligible értéke true. Ha institutions értéket ad vissza, csak abból a válaszból válasszon azonosítót. Tárolja a kiválasztott data[].id értéket CAPABILITY_ID-ként. Soha ne másoljon képességazonosítót másik ügyféltől vagy környezetből.

Közös és dedikált számlatípusok

A banki képességek két változatban léteznek, amelyeket az accountType mező és a képességazonosító utótagja kódol (például ach_pooled, wire_named):

pooled: közös Swipelux bankszámla. Minden pénzbefizetés egyedi hivatkozást használ a pénz irányítására. Egyszeri átutalásokhoz válassza ezt.
named: dedikált banki adatok az ügyfélnek (virtuális IBAN, dedikált ACH számla). Újrafelhasználható és megosztható bármely fizetővel. Kibocsátott bankszámlákhoz szükséges.

Alapértelmezés szerint válassza a pooled opciót. named-et csak akkor használjon, ha az ügyfélnek újrafelhasználható banki adatok szükségesek. Ellenőrizze a supported válaszban, hogy mely változatok érhetők el.

A képesség kérése

Kérje a kiválasztott opciót a POST /v3/customers/{customerId}/capabilities/{capabilityId} művelettel:

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

Csak akkor használjon explicit institutions tömböt, ha a támogatott képesség válasza által visszaadott azonosítókból kell választania. Tárolja a data.status értéket CAPABILITY_STATUS-ként, a data.openTaskIds értéket OPEN_TASK_IDS-ként, és minden data.applications[].id értéket az APPLICATION_IDS alatt.

Aktuális feladatok elvégzése

Sorolja fel a feladatokat a GET /v3/customers/{customerId}/tasks művelettel, válassza ki az azonosítókat az OPEN_TASK_IDS-ből, majd olvassa be minden aktuális feladatot a GET /v3/customers/{customerId}/tasks/{taskId} művelettel:

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

Használja a legfrissebb data.revision és data.requirements értékeit. Frissítse le a feladatot közvetlenül a beküldés előtt, ha bármelyik megváltozhatott. Minden nyitott feladat tartalmaz egy dueAt időbélyeget. Amikor a Swipelux explicit határidő nélkül hoz létre egy feladatot, a dueAt alapértelmezés szerint pontosan 31 nappal a feladat createdAt értéke utánra kerül. Kezelje a dueAt mezőt tájékoztató jellegűként: nem állíthatja be az API-n keresztül, és nem vált ki automatikus életciklus-átmenetet. Csak a különálló deadline mező okoz automatikus átmenetet, ha meg van adva.

Hosted műveletek

A feladat részletes válaszában a verificationSessions és tosSessions minden bejegyzése tartalmaz egy action objektumot. A feladatlisták válaszai nem tartalmazzák ezeket a műveleti hivatkozásokat. Tárolja minden munkamenet id értékét, majd olvassa be az action.kind értékét, mielőtt az ügyfelet továbbküldi; ne következtessen a hivatkozás elérhetőségére a munkamenet status értékéből.

Az action.kind: "available" tartalmazza az action.url és action.expiresAt mezőket (jelenleg mindig null). Tárolja az action.url értékét, küldje oda az ügyfelet, majd olvassa be újra a feladatot. A munkamenetszintű url és expiresAt mezők ugyanezeket az értékeket tartalmazzák.
Az action.kind: "unavailable" azt jelenti, hogy nem szabad hivatkozást megjeleníteni. A munkamenetszintű url és expiresAt mezők hiányoznak. A munkamenet status értéke önmagában nem határozza meg, melyik művelettípust kapja.

{
  "data": {
    "verificationSessions": [
      {
        "id": "vfy_000000000000000003",
        "key": "identity_verification",
        "type": "identity_verification",
        "status": "action_required",
        "action": {
          "kind": "available",
          "url": "https://platform.swipelux.com/kyc/redirect/cus_000000000000000001/tsk_000000000000000002/vfy_000000000000000003",
          "expiresAt": null
        },
        "url": "https://platform.swipelux.com/kyc/redirect/cus_000000000000000001/tsk_000000000000000002/vfy_000000000000000003",
        "expiresAt": null
      }
    ],
    "tosSessions": [
      {
        "id": "vfy_000000000000000004",
        "key": "terms_of_service",
        "type": "terms_of_service",
        "status": "completed",
        "action": { "kind": "unavailable" }
      }
    ]
  }
}

Ezek feladathoz kötött műveletek, nem egy külön ügyfél-ellenőrzési életciklus.

Dokumentumok feltöltése

Ha egy követelmény dokumentumot kér, töltse fel a POST /v3/customers/{customerId}/documents művelettel:

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

Tárolja a visszakapott data.id értéket DOCUMENT_ID-ként, mielőtt beküldi a rá hivatkozó választ.

API válaszok

Küldjön el egy teljes válaszcsomagot az aktuális revízióhoz a POST /v3/customers/{customerId}/tasks/{taskId}/submissions művelettel:

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

Vegyen minden követelményazonosítót és válaszreprezentációt a legfrissebb feladatból. Ha az API jelzi, hogy a feladat megváltozott, olvassa be újra és állítsa össze a beküldést az új revízió alapján.

Haszonhúzó előfeltétel vállalkozásoknál

Egy haszonhúzói bizonyítékot igénylő üzleti képesség kérése akkor is sikeres, ha az ügyfélnek még nincs megfelelő tulajdonosa. A képesség restricted státusszal jön létre, statusReason.code: tasks_due értékkel, és az üzleti adatfelvételi feladat kéri a hiányzó tulajdonlási tényeket, beleértve a tulajdonlási struktúrát. Ugyanez a feladat tartalmaz egy resource_reference követelményt, amelynek kérése tartalmazza a qualification: "beneficial_owner" értéket:

{
  "type": "resource_reference",
  "prompt": "Add or select a qualifying beneficial owner.",
  "required": true,
  "resourceType": "related_party",
  "qualification": "beneficial_owner"
}

Egy kapcsolt fél akkor felel meg, ha ugyanazon ügyfél aktív person fele, és ownership.declared: true értékkel vagy legalább 25 megadott tulajdonlási százalékkal rendelkezik. A követelmény az aktuális kapcsolt fél listából származik, így általában nem válaszolja meg közvetlenül:

Egy megfelelő kapcsolt fél létrehozása vagy frissítése ugyanabban az újraértékelésben teljesíti a követelményt, és megnyitja az adott tulajdonos saját profil- és dokumentummunkáját. Lásd az Üzleti kapcsolt felek hozzáadása oldalt.
Hivatkozhat egy megfelelő félre explicit módon is egy resource_reference válasszal, amely tartalmazza annak relatedPartyId értékét.
A követelmény a teljesítése után is listázva marad az aktuális feladatban. Amikor más nyitott kötelezettség nem marad, a feladat satisfied státuszba kerül.
Az utolsó megfelelő fél archiválása, vagy az őt minősítő tények eltávolítása újranyitja a követelményt, még azután is, hogy a feladat satisfied lett.

Folytatás, amikor a képesség kész

Olvassa be újra a képességet a GET /v3/customers/{customerId}/capabilities/{capabilityId} művelettel:

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

Cserélje ki a tárolt státuszt és a feladatazonosítókat a legfrissebb válasz értékeire. Csak akkor folytassa, ha az aktuális képesség státusza engedi a számla, árajánlat vagy átutalás létrehozását. Ezután válassza ki a megfelelő útvonalat a Gyakori folyamatok oldalon.

Kezdő lépések

Ügyfelek beléptetése

Pénzáramlások kiépítése

Élesítés

Képességek és feladatok

Támogatott képességek felfedezése

Közös és dedikált számlatípusok

A képesség kérése

Aktuális feladatok elvégzése

Hosted műveletek

Dokumentumok feltöltése

API válaszok

Haszonhúzó előfeltétel vállalkozásoknál

Folytatás, amikor a képesség kész

​Támogatott képességek felfedezése

​Közös és dedikált számlatípusok

​A képesség kérése

​Aktuális feladatok elvégzése

​Hosted műveletek

​Dokumentumok feltöltése

​API válaszok

​Haszonhúzó előfeltétel vállalkozásoknál

​Folytatás, amikor a képesség kész

Támogatott képességek felfedezése

Közös és dedikált számlatípusok

A képesség kérése

Aktuális feladatok elvégzése

Hosted műveletek

Dokumentumok feltöltése

API válaszok

Haszonhúzó előfeltétel vállalkozásoknál

Folytatás, amikor a képesség kész