Asiakkaat

Luo asiakas ennen kuin rakennat maksun vastaanottoa, maksua ulos tai luotua pankkitiliä. Kyvyt, tilit ja siirrot on rajattu tähän asiakkaaseen. Käytä externalId-kenttää vakaana yhdistämisenä järjestelmäsi vastaavaan tietueeseen.

Environment variables

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

Yksityisasiakkaat

Yksityishenkilö vaatii vain type-kentän. Sisällytä jo tiedossa olevat profiilikentät ja lisää lisää vain, kun nykyinen kyky tai tehtävä niitä tarvitsee. Luo asiakas POST /v3/customers -toiminnolla:

Create individual customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-user-123" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "individual",
  "externalId": "user_123",
  "individual": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

Tallenna palautettu data.id muuttujaan CUSTOMER_ID. Katso Yksityishenkilön käyttöönotto käytäntökontekstia varten.

Yritysasiakkaat

Yritys vaatii business.legalName-kentän. Luo yritys samalla toiminnolla:

Create business customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: customer-company-456" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "business",
  "externalId": "company_456",
  "business": {
    "legalName": "Acme Payments SAS"
  }
}
JSON

Tallenna palautettu data.id muuttujaan CUSTOMER_ID. Katso Yrityksen käyttöönotto käytäntö- ja dokumenttikontekstia varten. Lisää johtajat, omistajat ja muut yrityksen osallistujat, kun ne ovat tiedossa tai pyydettyjä. Tämä esimerkki luo johtajan POST /v3/customers/{customerId}/related-parties -toiminnolla:

Add related party

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/related-parties" \
  --header "X-API-Key: ${SWIPELUX_API_KEY}" \
  --header "Idempotency-Key: related-party-director-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "partyType": "person",
  "roles": ["director"],
  "title": "Chief executive officer",
  "person": {
    "firstName": "Amina",
    "lastName": "Diallo",
    "residenceCountry": "FR"
  }
}
JSON

Tallenna palautettu data.id muuttujaan RELATED_PARTY_ID. Jos sinun täytyy viedä asiakkaan tiedot, käytä toimintoa POST /v3/customers/{customerId}/export ja noudata sen pyyntöskeemaa. json_basic_data-muoto palauttaa nykyisen julkisen v3-asiakasresurssin JSON-liitteenä; jokainen kutsu laskee nykyiset tiedot uudelleen eikä sisällä asiakirjoja tai asiakirjojen metatietoja. Siirrettävyystunnusmuotoa varten lähetä vastaanottavan KYC-projektin asiakas-ID kentässä forClientId, ei Swipeluxin customerId-arvoa. Käytä palautettua data.token-arvoa ennen data.expiresAt-ajankohtaa. Saman Idempotency-Key-avaimen ja rungon uudelleenkäyttö toistaa kyseisen tunnustuloksen; käytä uutta avainta uuden tunnuksen myöntämiseen.

Lue valmius kyvyistä

Asiakkaalla ei ole vahvistus- tai valmiustilaa API:ssa. Lue asiakas GET /v3/customers/{customerId} -toiminnolla nykyisten profiilitietojen saamiseksi, käytä sitten kykyjä ja niiden openTaskIds-kenttiä päättämään, mitä asiakas voi tehdä seuraavaksi.

Get customer

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

Etsi asiakkaat, joilta puuttuu asiakirjoja

Selvittääksesi, mitkä sivun asiakkaat ovat vielä velkaa pakollisia asiakirjoja, välitä include=documentRequirements kohteelle GET /v3/customers. Voit yhdistää sen kykyjen yhteenvetoihin muodossa include=capabilities,documentRequirements. API-avaimet tarvitsevat accounts:read-oikeuden documentRequirements-laajennukseen. Jokainen asiakasyhteenveto sisältää tällöin documentRequirements-objektin:

Document requirement summary

{
  "documentRequirements": {
    "required": true,
    "count": 2
  }
}

count on niiden pakollisten asiakirjavaatimusten määrä, jotka ovat tilassa action_required tehtävissä, jotka ovat myös tilassa action_required. Se kattaa kaikki tehtävien laajuudet, myös koko tilin tehtävät, eikä se riipu kykyjen valmiudesta.
required on true, kun count on suurempi kuin 0.
Vaihtoehtojen joukko lasketaan kerran, ja vain silloin, kun jokainen vaihtoehto vaatii asiakirjan.

Yhteenveto on varovainen. Se jättää pois valinnaiset asiakirjat, ehdollisesti pakolliset asiakirjat sekä vaihtoehdot, joissa yhdistyvät asiakirjareitit ja muut reitit. Se jättää pois myös vaatimukset, jotka asiakas voi täyttää isännöidyn vahvistuksen kautta. Siksi required: false ei todista, ettei mikään asiakirjatehtävä koske asiakasta. Käytä sitä asiakkaiden priorisointiin ja lue sitten heidän tehtävänsä saadaksesi määräävän luettelon kerättävistä tiedoista. Ilman laajennusta vastaus jättää documentRequirements-kentän pois. Seuraavaksi jatka kohtaan Kyvyt ja tehtävät, joka löytää ja aktivoi tarvitsemasi tuotetuloksen.

Aloita

Asiakkaiden käyttöönotto

Rakenna rahavirrat

Julkaisu

Yksityisasiakkaat

Yritysasiakkaat

Lue valmius kyvyistä

Etsi asiakkaat, joilta puuttuu asiakirjoja

​Yksityisasiakkaat

​Yritysasiakkaat

​Lisää yritykseen liittyvät osapuolet

​Lue valmius kyvyistä

​Etsi asiakkaat, joilta puuttuu asiakirjoja

Yksityisasiakkaat

Yritysasiakkaat

Lisää yritykseen liittyvät osapuolet

Lue valmius kyvyistä

Etsi asiakkaat, joilta puuttuu asiakirjoja