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.

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:

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:

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ää yritykseen liittyvät osapuolet

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:

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.

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.

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

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

Lisää yritykseen liittyvät osapuolet

Lue valmius kyvyistä

​Yksityisasiakkaat

​Yritysasiakkaat

​Lisää yritykseen liittyvät osapuolet

​Lue valmius kyvyistä

Yksityisasiakkaat

Yritysasiakkaat

Lisää yritykseen liittyvät osapuolet

Lue valmius kyvyistä