Environment variables
Atklājiet atbalstītās iespējas
Nolasiet klienta pašreizējās iespējas arGET /v3/customers/{customerId}/capabilities/supported:
List supported capabilities
directions, method un accountType. Turpiniet tikai tad, kad availability ir available vai beta un eligibility.eligible ir true. Ja tiek atgrieztas institutions, izvēlieties tikai ID no šīs atbildes.
Katrs iestādes ieraksts ietver logoUrl un karodziņu isDefault. Izmantojiet logoUrl, lai parādītu bankas logotipu bankas izvēles saskarnē, un attēlojiet savu vispārīgo bankas ikonu, kad tā vērtība ir null. isDefault attiecas tikai uz šo klientu un iespēju, nevis uz iestādi globāli. GET /v3/institutions atgriež to pašu logoUrl, kura vērtība var būt null. Iestāžu ID ir necaurredzami, tāpēc apstrādājiet jaunus ID bez koda izmaiņām.
Institution entry
data[].id kā CAPABILITY_ID. Nekad nekopējiet iespējas ID no cita klienta vai vides.
Apkopotais un nosauktais konta veids
Bankas iespējas ir divos variantos, kas kodēti kā lauksaccountType un iespējas ID sufikss (piemēram, ach_pooled, wire_named):
pooled: kopīgs Swipelux bankas konts. Katra iemaksa izmanto unikālu atsauci līdzekļu maršrutēšanai. Izvēlieties šo vienreizējiem pārvedumiem.named: klientam veltīti bankas rekvizīti (virtuāls IBAN, veltīts ACH konts). Atkārtoti izmantojami un dalāmi ar jebkuru maksātāju. Nepieciešams izsniegtiem bankas kontiem.
pooled. Izmantojiet named tikai tad, kad klientam nepieciešami atkārtoti izmantojami bankas rekvizīti. Pārbaudiet supported atbildi, lai uzzinātu, kuri varianti ir pieejami.
Lai saņemtu SWIFT iemaksas vai izsniegtu SWIFT bankas rekvizītus, izmantojiet swift_named. swift_pooled atbalsta tikai izmaksas, tāpēc pārbaudiet katras opcijas directions atbalstīto iespēju atbildē. Nosauktais SWIFT konts atgriež atkārtoti izmantojamus saņemšanas rekvizītus, tostarp bankas BIC, atsauci, ja tā ir nepieciešama, un saņēmēja adresi, ja banka to sniedz.
Izsniegtiem ACH, Wire un SWIFT kontiem varat izvēlēties konkrētu banku ar institution un saglabāt konta pieprasījumu, pirms banka apstiprina klientu. Skatiet Izsniegt bankas kontu.
Pieprasiet iespēju
Pieprasiet izvēlēto opciju arPOST /v3/customers/{customerId}/capabilities/{capabilityId}:
Request capability
institutions masīvu tikai tad, kad jums nepieciešams izvēlēties no atbalstīto iespēju atbildē atgrieztajiem ID.
Saglabājiet data.status kā CAPABILITY_STATUS, data.accountProvisioning kā ACCOUNT_PROVISIONING_STATUS, data.openTaskIds kā OPEN_TASK_IDS un katru data.applications[].id sarakstā APPLICATION_IDS.
Kopīgi pieteikumi katrai bankai
Nosauktajām bankas iespējām katram klientam ir viena pieteikuma lieta katrā bankā. Apkopotās un platformas iespējas izmanto lietas bez bankas. Swipelux koplieto lietu starp visām saderīgajām iespējām, ko pieprasāt:- Viens apstiprinājums var aptvert vairākas iespējas. Piemēram, apstiprināta lieta vienā bankā var padarīt gan ACH, gan Wire iespēju
ready. - Vēlāks pieprasījums, kas atbilst esošai lietai, to izmanto atkārtoti. Swipelux neatver otru pieteikumu un nepievieno dublētus uzdevumus.
- Lietas dažādās bankās ir neatkarīgas. Noraidījums vienā bankā neietekmē lietu citā bankā.
201nozīmē, ka pieprasījums atvēra jaunu pieteikuma lietu.200nozīmē, ka pieprasījums tika piesaistīts pieteikuma lietai, kas klientam jau bija, piemēram, atkārtots pieprasījums bankas iespējai, kas klientam jau ir, vai pieprasījums atceltai iespējai. Atkārtots pieprasījums iespējāmcardvaistablecoin_transfersjoprojām atgriež409 capability_already_exists.selectedApplicationIdir augstākā līmeņa lauks blakusdata, kas satur pieprasījuma izvēlētās vai atvērtās lietas ID. Swipelux to izlaiž, ja pieprasījums neizvēlējās lietu. Idempotenta atkārtošana atgriež to pašu vērtību.
Response (abbreviated)
institutions sarakstu, lai izvēlētos to pašu lietu, vai nosūtiet viena iestādes ID, lai mērķētu uz šo banku. Banka, kas klientu ir galīgi noraidījusi, tiek izlaista. Ja norādāt tikai šo banku vai ja visas atbilstošās bankas ir klientu noraidījušas, pieprasījums atgriež 409 capability_terminally_rejected. Lai pēc noraidījuma mēģinātu citu banku, vēlreiz pieprasiet iespēju ar šīs bankas iestādes ID.
Iespējas statuss atspoguļo visas klienta saistītās lietas. Nosauktai iespējai pietiek ar vienu ready lietu, kuras apstiprinājums to aptver, lai tā kļūtu ready, neatkarīgi no tā, ko ziņo citas bankas. Apkopotā iespēja gaida arī savu metodes pārbaudi, kas tiek norādīta probes klienta pieteikumu sarakstā.
Uzskaitiet klienta pieteikumus
Uzskaitiet visas klienta pieteikuma lietas arGET /v3/customers/{customerId}/applications. Rezultāti tiek lapoti ar nextCursor un hasMore, un tie pieņem updatedAfter:
List applications
applications[], kā arī:
scope:namedlietai vienā bankā,provider_pooledvaiplatformlietām bez bankas, vainullneklasificētai vēsturiskai lietai.institutionnav iekļautsprovider_pooledunplatformlietām.requestedScope[]: iespēju atslēgas, kas pieprasītas attiecībā uz lietu, katra ar savu pirmorequestedAt. Ieraksti nekad netiek noņemti.coverage[]: iespēju atslēgas, ko aptver lietas apstiprinājums, katra argrantedAtunsource. Pārklājums fiksē tvērumu, nevis autorizāciju. Nolasiet iespēju, lai uzzinātu tās pašreizējo statusu.probes[]: metožu pārbaudes apkopotajām iespēju atslēgām, ko lieta aptver, katra arcapabilityKey,statusunreason. Nosauktajām atslēgām pārbaude nekad nav nepieciešama.generation,predecessorApplicationIdunsupersededByApplicationId: pēctecības saites. Ja ir iestatītssupersededByApplicationId, lieta ir aizstāta. Sekojiet šim ID uz pašreizējo lietu. Iespējasapplications[]uzskaita tikai pašreizējās lietas, tāpēc aizstāta lieta parādās tikai šajā sarakstā.
Response (abbreviated)
Pabeidziet pašreizējos uzdevumus
Uzskaitiet uzdevumus arGET /v3/customers/{customerId}/tasks, izvēlieties ID no OPEN_TASK_IDS, pēc tam nolasiet katru pašreizējo uzdevumu ar GET /v3/customers/{customerId}/tasks/{taskId}:
List open tasks
data.revision un data.requirements. Uzreiz pirms iesniegšanas atkārtoti ielādējiet uzdevumu, ja kāds no tiem varētu būt mainījies.
Atkārtoti izmantoti profila pierādījumi
Pieteikuma datu ievākšanas uzdevumiem, kas pieņem tiešu iesniegšanu caur API, Swipelux atkārtoti izmanto informāciju, ko klients jau ir sniedzis. Kad šāds uzdevums tiek izveidots vai saskaņots, Swipelux pārbauda klienta profilu un paša klienta augšupielādētos dokumentus. Atbilstošās prasības, ko jau pamato izmantojama profila vērtība vai dokuments, pāriet uzin_review, nevis paliek rīkojamas. Profila atjauninājumi un jaunu dokumentu augšupielāde izraisa to pašu pārbaudi esošajiem uzdevumiem.
Rīkojamas paliek tikai trūkstošās vai nesaderīgās vērtības. Atkārtota izmantošana neapstiprina pierādījumus. Swipelux tos joprojām pārskata. Skaidri labojumu pieprasījumi un iepriekš atbildētas prasības paliek rīkojamas. Īpašnieku un saistīto pušu dokumenti netiek izmantoti atkārtoti, un prasības, kas tiek ievāktas tikai mitinātā sesijā, saglabā savu parasto plūsmu.
Prasību attēlošana
Veidojiet formas no metadatiem, ko atgriež katra prasība, nevis no prasību atslēgām. Prasība var ietvert neobligātu īsutitle, un katrs request ietver prompt, ko parādīt zem virsraksta.
Prasības ar request.type: "profile" identificē profila lauku ar profilePointer un pievieno ievades metadatus:
allowedValues: atļautās vērtības skalāram laukam vai katram masīva lauka elementam. Iesniedziet šīs vērtības, nevis tulkotas attēlojamās etiķetes.valueSchema: pašpietiekams JSON Schema Draft 7 dokuments, kas apraksta ievades formu, ligzdotos rekvizītus, obligātos laukus un strukturālos ierobežojumus. Objektu uzskaitījumi parādās attiecīgajā rekvizītā, piemēram,valueSchema.items.properties.type.enumnodokļu identifikatoriem. Swipelux pēc iesniegšanas joprojām piemēro starplauku un pārskatīšanas validāciju, tāpēc vērtību, kas atbilst shēmai, joprojām var noraidīt.valueType: "country"vai masīviemitemValueType: "country": lauks pieņem ISO 3166-1 alpha-2 kodus ar lielajiem burtiem. Ligzdotie valsts rekvizītivalueSchemaizmantoformat: "iso-3166-1-alpha-2". Lokalizētām etiķetēm izmantojiet standarta valstu sarakstu.
Requirement
valueSchema un allowedValues. Attēlojiet tās, izmantojot prompt un valueType.
Katrs atvērtais uzdevums ietver dueAt laika zīmogu. Kad Swipelux izveido uzdevumu bez skaidri norādīta izpildes termiņa, dueAt pēc noklusējuma tiek iestatīts tieši 31 dienu pēc uzdevuma createdAt. Uztveriet dueAt kā informatīvu: to nevar iestatīt caur API, un tas neizraisa automātisku dzīves cikla pāreju. Tikai atsevišķais lauks deadline, ja tas ir norādīts, izraisa automātisku pāreju.
Mitinātās darbības
Uzdevuma detaļu atbildē katrsverificationSessions un tosSessions ieraksts ietver action objektu. Uzdevumu saraksta atbildēs šo darbību saišu nav. Saglabājiet katras sesijas id, pēc tam pirms klienta nosūtīšanas nolasiet action.kind; nenosakiet saites pieejamību tikai pēc sesijas status.
action.kind: "available"ietveraction.urlunaction.expiresAt(pašlaik vienmērnull). Saglabājietaction.url, nosūtiet klientu uz šo adresi un pēc tam atkārtoti nolasiet uzdevumu. Sesijas līmeņa laukiurlunexpiresAtsatur tās pašas vērtības.action.kind: "unavailable"nozīmē, ka saiti nedrīkst parādīt. Sesijas līmeņa laukuurlunexpiresAtnav. Sesijasstatusviens pats nenosaka, kuru darbības veidu saņemsiet.
Verification session
action_required, satur reviewFeedback.code: hosted_profile_direct_submission_required. Iegūstiet šo vērtību no klienta un iesniedziet to kā API atbildi.
Augšupielādējiet dokumentus
Ja prasība pieprasa dokumentu, augšupielādējiet to arPOST /v3/customers/{customerId}/documents:
Upload document
data.id kā DOCUMENT_ID, pirms iesniedzat atbildi, kas uz to atsaucas.
Lai vēlāk izgūtu saglabātu failu, izsauciet GET /v3/customers/{customerId}/documents/{documentId}/download. Swipelux atgriež url, kas lejupielādē failu kā pielikumu un kura derīgums beidzas pēc vienas stundas. Arhivēti dokumenti atgriež 404.
API atbildes
Iesniedziet vienu pilnu atbilžu kopu pašreizējai versijai arPOST /v3/customers/{customerId}/tasks/{taskId}/submissions:
Submit task answers
Patiesā labuma guvēja priekšnosacījums uzņēmumiem
Uzņēmuma iespējas pieprasīšana, kurai nepieciešami patiesā labuma guvēja pierādījumi, izdodas arī tad, kad klientam vēl nav kvalificējoša īpašnieka. Iespēja tiek izveidota kārestricted ar statusReason.code: tasks_due, un uzņēmuma datu ievākšanas uzdevums pieprasa trūkstošos īpašumtiesību faktus, tostarp īpašumtiesību struktūru.
Tas pats uzdevums ietver resource_reference prasību, kuras pieprasījums ietver qualification: "beneficial_owner":
Beneficial owner requirement
person puse ar norādītu īpašumtiesību procentu vismaz 25 vai ar ownership.declared: true bez norādīta procenta.
Prasība tiek atvasināta no pašreizējā saistīto pušu saraksta, tāpēc parasti uz to neatbildat tieši:
- Kvalificējošas saistītās puses izveide vai atjaunināšana izpilda prasību tajā pašā pārvērtēšanā un atver šī īpašnieka paša profila un dokumentu darbu. Skatiet Pievienojiet uzņēmuma saistītās puses.
- Varat arī tieši atsaukties uz kvalificējošu pusi ar
resource_referenceatbildi, kas satur tāsrelatedPartyId. - Prasība paliek uzskaitīta pašreizējā uzdevumā arī pēc tās izpildes. Kad neviena cita saistība vairs nav atvērta, uzdevums kļūst
satisfied. - Pēdējās kvalificējošās puses arhivēšana vai to faktu noņemšana, kas to kvalificēja, atkārtoti atver prasību pat pēc tam, kad uzdevums bija
satisfied.
Turpiniet, kad iespēja ir gatava
Atkārtoti nolasiet iespēju arGET /v3/customers/{customerId}/capabilities/{capabilityId}:
Refetch capability
status ziņo, vai tiesības ir apstiprinātas. Iespējai, kas izsniedz kontu, accountProvisioning atsevišķi ziņo, vai šis konts ir not_started, in_progress, issued vai failed; iespēja, kas neizsniedz kontu, atgriež not_applicable.
Kamēr iespēja ir pending, divas no statusReason.code vērtībām, ko tā var ziņot, parāda, vai notiek pārskatīšana. preparing_submission nozīmē, ka Swipelux joprojām sagatavo pieteikumu iesniegšanai un neviena pārskatīšana nenotiek, pat ja citas bankas pieteikums ir rejected vai prasa uzmanību. review_in_progress nozīmē, ka notiek pārskatīšana, piemēram, kamēr pieteikums ir in_review vai ir atvērta uzņemtā verifikācija. Abi izmanto resolution: wait. Maiņa starp šiem kodiem saglabā statusu pending, tāpēc netiek nosūtīts notikums capability.status_changed. Nolasiet iespēju, lai redzētu pašreizējo kodu.
Turpiniet tikai tad, kad pašreizējais iespējas statuss atļauj kontu, kotāciju vai pārvedumu, ko paredzat izveidot. Ja plūsmai nepieciešams izsniegts konts, gaidiet arī, līdz accountProvisioning kļūst issued.
Tālāk izvēlieties atbilstošo ceļojumu sadaļā Biežākās plūsmas.