Kyvyt ja tehtävät

Kyky kertoo, voiko asiakas käyttää tiettyä tulosta, maksutapaa ja suuntaa. Avoimet tehtävät kertovat, mitä on tapahduttava, ennen kuin kyseinen kyky tai siihen liittyvä resurssi voi edetä.

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

Löydä tuetut kyvyt

Lue asiakkaan nykyiset vaihtoehdot GET /v3/customers/{customerId}/capabilities/supported -toiminnolla:

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

Valitse vastauskohta, joka vastaa aiottua directions-, method- ja accountType-arvoa. Jatka vain, kun availability on available tai beta ja eligibility.eligible on true. Jos institutions palautetaan, valitse vain ID kyseisestä vastauksesta. Tallenna valittu data[].id muuttujaan CAPABILITY_ID. Älä koskaan kopioi kyky-ID:tä toiselta asiakkaalta tai ympäristöstä.

Jaetut ja nimelliset tilityypit

Pankkikykyjä on kahta muunnelmaa, jotka koodataan accountType-kenttään ja kyky-ID:n loppuliitteeseen (esimerkiksi ach_pooled, wire_named):

pooled: jaettu Swipeluxin pankkitili. Kukin maksun vastaanotto käyttää yksilöllistä viitettä varojen reitittämiseen. Valitse tämä kertaluontoisia siirtoja varten.
named: asiakkaalle omistettu pankkitilitiedot (virtuaalinen IBAN, omistettu ACH-tili). Uudelleenkäytettävä ja jaettavissa minkä tahansa maksajan kanssa. Vaaditaan luotuja pankkitilejä varten.

Käytä oletuksena pooled. Käytä named-tyyppiä vain, kun asiakas tarvitsee uudelleenkäytettäviä pankkitilitietoja. Tarkista supported-vastauksesta, mitkä muunnelmat ovat saatavilla.

Pyydä kyky

Pyydä valittu vaihtoehto POST /v3/customers/{customerId}/capabilities/{capabilityId} -toiminnolla:

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

Käytä eksplisiittistä institutions-taulukkoa vain, kun sinun täytyy valita tuettu-kykyvastauksen palauttamista ID:istä. Tallenna data.status muuttujaan CAPABILITY_STATUS, data.openTaskIds muuttujaan OPEN_TASK_IDS ja kukin data.applications[].id muuttujaan APPLICATION_IDS.

Suorita nykyiset tehtävät

Listaa tehtävät GET /v3/customers/{customerId}/tasks -toiminnolla, valitse ID:t muuttujasta OPEN_TASK_IDS, lue sitten kukin nykyinen tehtävä GET /v3/customers/{customerId}/tasks/{taskId} -toiminnolla:

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

Käytä uusinta data.revision- ja data.requirements-arvoa. Hae tehtävä uudelleen juuri ennen lähettämistä, jos jompikumpi voi olla muuttunut. Jokainen avoin tehtävä sisältää dueAt-aikaleiman. Kun Swipelux luo tehtävän ilman eksplisiittistä eräpäivää, dueAt on oletuksena tasan 31 päivää tehtävän createdAt-ajankohdan jälkeen. Käsittele dueAt-arvoa informatiivisena: et voi asettaa sitä API:n kautta, eikä se laukaise automaattista elinkaarisiirtymää. Vain erillinen deadline-kenttä aiheuttaa automaattisen siirtymän, jos se on asetettu.

Isännöidyt toiminnot

Tehtävän tietovastauksessa jokainen verificationSessions- ja tosSessions-merkintä sisältää action-objektin. Tehtäväluettelon vastaukset eivät sisällä näitä toimintolinkkejä. Tallenna kunkin istunnon id ja lue action.kind ennen asiakkaan ohjaamista; älä päättele linkin saatavuutta istunnon status-arvosta.

action.kind: "available" sisältää action.url- ja action.expiresAt-arvot (tällä hetkellä aina null). Tallenna action.url, lähetä asiakas siihen ja lue tehtävä sitten uudelleen. Istuntotason url- ja expiresAt-kentät sisältävät samat arvot.
action.kind: "unavailable" tarkoittaa, ettei linkkiä pidä näyttää. Istuntotason url- ja expiresAt-kentät puuttuvat. Istunnon status ei yksin määritä saatavan toiminnon tyyppiä.

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

Nämä ovat tehtäväkohtaisia toimintoja, ei erillinen asiakkaan vahvistuselinkaari.

Lataa dokumentteja

Kun vaatimus pyytää dokumenttia, lataa se POST /v3/customers/{customerId}/documents -toiminnolla:

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

Tallenna palautettu data.id muuttujaan DOCUMENT_ID ennen kuin lähetät siihen viittaavan vastauksen.

API-vastaukset

Lähetä yksi täydellinen vastausjoukko nykyistä versiota varten POST /v3/customers/{customerId}/tasks/{taskId}/submissions -toiminnolla:

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

Ota jokainen vaatimuksen ID ja vastaustyyppi uusimmasta tehtävästä. Jos API ilmoittaa, että tehtävä on muuttunut, hae se uudelleen ja rakenna lähetys uuden version pohjalta.

Edunsaajaa koskeva ennakkoedellytys yrityksille

Sellaisen yrityskyvyn pyytäminen, joka tarvitsee edunsaajatodisteita, onnistuu myös silloin, kun asiakkaalla ei vielä ole kelvollista omistajaa. Kyky luodaan tilassa restricted arvolla statusReason.code: tasks_due, ja yrityksen intake-tehtävä pyytää puuttuvat omistusfaktat, mukaan lukien omistusrakenteen. Sama tehtävä sisältää resource_reference-vaatimuksen, jonka pyyntö sisältää qualification: "beneficial_owner":

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

Liittyvä osapuoli kelpaa, kun se on saman asiakkaan aktiivinen person-osapuoli, jolla on ownership.declared: true tai toimitettu omistusprosentti vähintään 25. Vaatimus johdetaan nykyisestä liittyvien osapuolten luettelosta, joten et yleensä vastaa siihen suoraan:

Kelvollisen liittyvän osapuolen luominen tai päivittäminen täyttää vaatimuksen samassa uudelleenarvioinnissa ja avaa kyseisen omistajan oman profiili- ja asiakirjatyön. Katso Lisää yritykseen liittyvät osapuolet.
Voit myös viitata kelvolliseen osapuoleen eksplisiittisesti resource_reference-vastauksella, joka sisältää sen relatedPartyId:n.
Vaatimus pysyy listattuna nykyisessä tehtävässä sen täyttymisen jälkeen. Kun muita avoimia velvoitteita ei ole, tehtävä siirtyy tilaan satisfied.
Viimeisen kelvollisen osapuolen arkistointi tai sen kelpuuttaneiden faktojen poistaminen avaa vaatimuksen uudelleen, myös sen jälkeen, kun tehtävä oli satisfied.

Jatka, kun kyky on valmis

Lue kyky uudelleen GET /v3/customers/{customerId}/capabilities/{capabilityId} -toiminnolla:

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

Korvaa tallennettu tila ja tehtävän ID:t uusimmalla vastauksella. Jatka vain, kun nykyinen kyvyn tila sallii aiottujen tilin, tarjouksen tai siirron luomisen. Seuraavaksi valitse vastaava matka Yleiset virrat -sivulta.

Aloita

Asiakkaiden käyttöönotto

Rakenna rahavirrat

Julkaisu

Kyvyt ja tehtävät

Löydä tuetut kyvyt

Jaetut ja nimelliset tilityypit

Pyydä kyky

Suorita nykyiset tehtävät

Isännöidyt toiminnot

Lataa dokumentteja

API-vastaukset

Edunsaajaa koskeva ennakkoedellytys yrityksille

Jatka, kun kyky on valmis

​Löydä tuetut kyvyt

​Jaetut ja nimelliset tilityypit

​Pyydä kyky

​Suorita nykyiset tehtävät

​Isännöidyt toiminnot

​Lataa dokumentteja

​API-vastaukset

​Edunsaajaa koskeva ennakkoedellytys yrityksille

​Jatka, kun kyky on valmis

Löydä tuetut kyvyt

Jaetut ja nimelliset tilityypit

Pyydä kyky

Suorita nykyiset tehtävät

Isännöidyt toiminnot

Lataa dokumentteja

API-vastaukset

Edunsaajaa koskeva ennakkoedellytys yrityksille

Jatka, kun kyky on valmis