Iespējas un uzdevumi

Iespēja norāda, vai klients var izmantot konkrētu rezultātu, maksājuma metodi un virzienu. Atvērtie uzdevumi norāda, kam jānotiek, pirms šī iespēja vai saistīts resurss var virzīties uz priekšu.

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

Atklājiet atbalstītās iespējas

Nolasiet klienta pašreizējās iespējas ar GET /v3/customers/{customerId}/capabilities/supported:

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

Izvēlieties atbildes ierakstu, kas atbilst paredzētajiem 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. Saglabājiet izvēlēto 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ā lauks accountType 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.

Pēc noklusējuma izmantojiet 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.

Pieprasiet iespēju

Pieprasiet izvēlēto opciju ar POST /v3/customers/{customerId}/capabilities/{capabilityId}:

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

Izmantojiet skaidru 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.openTaskIds kā OPEN_TASK_IDS un katru data.applications[].id sarakstā APPLICATION_IDS.

Pabeidziet pašreizējos uzdevumus

Uzskaitiet uzdevumus ar GET /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}:

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

Izmantojiet jaunāko 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.

Uzņemtās darbības

Ja uzdevums atgriež verificationSessions vai tosSessions, saglabājiet katras sesijas id un pašreizējo url. Nosūtiet klientu uz atgriezto URL, pēc tam atkārtoti nolasiet uzdevumu. Tās ir uzdevuma mērogā ierobežotas darbības, nevis atsevišķs klienta verifikācijas dzīves cikls.

Augšupielādējiet dokumentus

Ja prasība pieprasa dokumentu, augšupielādējiet to ar POST /v3/customers/{customerId}/documents:

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

Saglabājiet atgriezto data.id kā DOCUMENT_ID, pirms iesniedzat atbildi, kas uz to atsaucas.

API atbildes

Iesniedziet vienu pilnu atbilžu kopu pašreizējai versijai ar POST /v3/customers/{customerId}/tasks/{taskId}/submissions:

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

Ņemiet katru prasības ID un atbildes veidu no jaunākā uzdevuma. Ja API ziņo, ka uzdevums ir mainījies, atkārtoti ielādējiet to un pārveidojiet iesniegumu no jaunās versijas.

Turpiniet, kad iespēja ir gatava

Atkārtoti nolasiet iespēju ar GET /v3/customers/{customerId}/capabilities/{capabilityId}:

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

Aizstājiet saglabāto statusu un uzdevumu ID ar jaunāko atbildi. Turpiniet tikai tad, kad pašreizējais iespējas statuss atļauj kontu, kotāciju vai pārvedumu, ko paredzat izveidot. Tālāk izvēlieties atbilstošo ceļojumu sadaļā Biežākās plūsmas.

Sākt darbu

Klientu iekļaušana

Veidot naudas plūsmas

Palaišana

Iespējas un uzdevumi

Atklājiet atbalstītās iespējas

Apkopotais un nosauktais konta veids

Pieprasiet iespēju

Pabeidziet pašreizējos uzdevumus

Uzņemtās darbības

Augšupielādējiet dokumentus

API atbildes

Turpiniet, kad iespēja ir gatava

​Atklājiet atbalstītās iespējas

​Apkopotais un nosauktais konta veids

​Pieprasiet iespēju

​Pabeidziet pašreizējos uzdevumus

​Uzņemtās darbības

​Augšupielādējiet dokumentus

​API atbildes

​Turpiniet, kad iespēja ir gatava

Atklājiet atbalstītās iespējas

Apkopotais un nosauktais konta veids

Pieprasiet iespēju

Pabeidziet pašreizējos uzdevumus

Uzņemtās darbības

Augšupielādējiet dokumentus

API atbildes

Turpiniet, kad iespēja ir gatava