Kyvyt ja tehtävät

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

​

Löydä tuetut kyvyt

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

{
  "institutions": [
    {
      "id": "jpmorgan",
      "name": "JPMorgan Chase",
      "bic": "CHASUS33",
      "logoUrl": "https://wallet.swipelux.com/bank-logos/jpmorgan.png",
      "countries": ["US"],
      "isDefault": true
    }
  ]
}

​

Jaetut ja nimelliset tilityypit

• 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.

​

Pyydä kyky

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

​

Pankkikohtaiset jaetut hakemukset

• Yksi hyväksyntä voi kattaa useita kykyjä. Esimerkiksi yhden pankin hyväksytty tapaus voi tehdä sekä ACH- että wire-kyvystä ready-tilaisen.
• Myöhempi pyyntö, joka vastaa olemassa olevaa tapausta, käyttää sitä uudelleen. Swipelux ei avaa toista hakemusta eikä lisää päällekkäisiä tehtäviä.
• Eri pankkien tapaukset ovat toisistaan riippumattomia. Hylkäys yhdessä pankissa ei vaikuta toisen pankin tapaukseen.

• 201 tarkoittaa, että pyyntö avasi uuden hakemustapauksen.
• 200 tarkoittaa, että pyyntö kohdistui hakemustapaukseen, joka asiakkaalla jo oli, esimerkiksi toistettu pyyntö pankkikyvylle, joka asiakkaalla jo on, tai pyyntö peruutetulle kyvylle. Toistettu pyyntö kyvylle card tai stablecoin_transfers palauttaa edelleen 409 capability_already_exists.
• selectedApplicationId on ylätason kenttä data-kentän vieressä, ja se sisältää pyynnön valitseman tai avaaman tapauksen ID:n. Swipelux jättää sen pois, kun pyyntö ei valinnut tapausta. Idempotentti uusinta palauttaa saman arvon.

{
  "data": {
    "id": "ach_named",
    "status": "pending",
    "openTaskIds": ["tsk_000000000000000002"],
    "applications": [{ "id": "apl_000000000000000005", "status": "in_review" }]
  },
  "selectedApplicationId": "apl_000000000000000005"
}

​

Listaa asiakkaan hakemukset

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

• scope: named yhden pankin tapaukselle, provider_pooled tai platform tapauksille ilman pankkia, tai null luokittelemattomalle historialliselle tapaukselle. institution puuttuu provider_pooled- ja platform-tapauksista.
• requestedScope[]: tapaukseen kohdistetut pyydetyt kykyavaimet, kukin ensimmäisellä requestedAt-arvollaan. Merkintöjä ei koskaan poisteta.
• coverage[]: kykyavaimet, jotka tapauksen hyväksyntä kattaa, kukin grantedAt- ja source-arvoineen. Kattavuus kirjaa laajuuden, ei valtuutusta. Lue kyky saadaksesi sen nykyisen tilan.
• probes[]: maksutavan tarkistukset tapauksen kattamille jaetuille kykyavaimille, kukin capabilityKey-, status- ja reason-arvoineen. Nimelliset avaimet eivät koskaan vaadi tarkistusta.
• generation, predecessorApplicationId ja supersededByApplicationId: seuraantolinkit. Kun supersededByApplicationId on asetettu, tapaus on korvattu. Seuraa kyseistä ID:tä nykyiseen tapaukseen. Kyvyn applications[] sisältää vain nykyiset tapaukset, joten korvattu tapaus näkyy vain tässä luettelossa.

{
  "data": [
    {
      "id": "apl_000000000000000005",
      "status": "ready",
      "scope": "named",
      "institution": { "id": "jpmorgan", "name": "JPMorgan Chase", "bic": "CHASUS33" },
      "requestedScope": [
        { "capabilityKey": "ach_named", "requestedAt": "2026-09-20T10:00:00.000Z" }
      ],
      "coverage": [
        { "capabilityKey": "ach_named", "grantedAt": "2026-09-22T12:00:00.000Z", "source": "approval" },
        { "capabilityKey": "wire_named", "grantedAt": "2026-09-22T12:00:00.000Z", "source": "approval" }
      ],
      "probes": [],
      "generation": 1,
      "predecessorApplicationId": null,
      "supersededByApplicationId": null
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

​

Suorita nykyiset tehtävät

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

​

Uudelleenkäytetyt profiilitodisteet

​

Vaatimusten esittäminen

• allowedValues: sallitut arvot skalaarikentälle tai taulukkokentän jokaiselle alkiolle. Lähetä nämä arvot, älä käännettyjä näyttöotsikoita.
• valueSchema: itsenäinen JSON Schema Draft 7 -dokumentti, joka kuvaa syötteen muodon, sisäkkäiset ominaisuudet, pakolliset kentät ja rakenteelliset rajoitteet. Objektien enumit näkyvät asianomaisessa ominaisuudessa, esimerkiksi valueSchema.items.properties.type.enum verotunnisteille. Swipelux soveltaa silti kenttien välistä validointia ja tarkastusvalidointia lähetyksen jälkeen, joten skeeman läpäisevä arvo voidaan silti hylätä.
• valueType: "country", tai taulukoille itemValueType: "country": kenttä hyväksyy isoilla kirjaimilla kirjoitettuja ISO 3166-1 alpha-2 -koodeja. valueSchema-skeeman sisäkkäiset maaominaisuudet käyttävät format: "iso-3166-1-alpha-2". Käytä vakiomaaluetteloa lokalisoituja otsikoita varten.

{
  "id": "req_000000000000000010",
  "key": "account_purposes",
  "title": "Account purpose",
  "status": "action_required",
  "request": {
    "type": "profile",
    "prompt": "Select every purpose that applies.",
    "required": true,
    "profilePointer": "/financialProfile/accountPurposes",
    "valueType": "array",
    "itemValueType": "string",
    "allowedValues": ["business_expenses", "ecommerce", "payroll"],
    "valueSchema": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "array",
      "items": { "enum": ["business_expenses", "ecommerce", "payroll"] }
    }
  }
}

​

Isännöidyt toiminnot

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

​

Lataa dokumentteja

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

​

API-vastaukset

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

​

Edunsaajaa koskeva ennakkoedellytys yrityksille

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

• 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

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