Ātrais starts

1. Konfigurējiet smilšu kasti

Izmantojiet smilšu kastes API atslēgu no savas aizmugursistēmas:

Sandbox setup

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

Atslēga izvēlas smilšu kastes vidi kopīgajā API resursdatorā.

2. Izveidojiet klientu

Izveidojiet privātpersonas klientu ar POST /v3/customers:

Create customer

curl --request POST \
  "${API_BASE}/v3/customers" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-customer-001" \
  --header "Content-Type: application/json" \
  --data '{"type":"individual","externalId":"quickstart-customer-001"}'

Saglabājiet data.id kā CUSTOMER_ID.

3. Izvēlieties rezultātu

Iemaksa: saņemiet USD un norēķinieties ar USDC klienta izsniegtajā makā.
Izmaksa: sūtiet USDC no klienta izsniegtā maka uz klienta bankas kontu.
Izsniegts bankas konts: izsniedziet ACH/USD kontu, kas norēķinās klienta izsniegtajā makā.

Trešās puses izmaksai sekojiet Saņēmēji vai Sūtīt līdzekļus.

4. Atrodiet piemērotu iespēju

Uzskaitiet atbalstītās iespējas ar GET /v3/customers/{customerId}/capabilities/supported:

Supported capabilities

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

Izvēlieties atbildes ierakstu, kur availability ir iestatīts uz available vai beta, eligibility.eligible ir iestatīts uz true, ir nepieciešamie directions un method, kā arī atbilstošais accountType. Izmantojiet klienta izsniegto maku kā iemaksas galamērķi, izmaksas avotu vai bankas konta norēķinu kontu; izmantojiet klientam piederošo kontu kā destinationId šai izmaksas plūsmai. Ja tiek atgrieztas institutions, izmantojiet tikai kādu no atgrieztajām institūcijām. Saglabājiet ieraksta id kā CAPABILITY_ID; nekodējiet universālu iespējas ID.

5. Pieprasiet iespēju

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

Request capability

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/capabilities/${CAPABILITY_ID}" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-capability-001" \
  --header "Content-Type: application/json" \
  --data '{}'

Saglabājiet data.status kā CAPABILITY_STATUS un data.openTaskIds kā TASK_IDS.

6. Pabeidziet iesaisti smilšu kastē

Ja TASK_IDS nav tukšs, pabeidziet katru pašreizējo prasību sadaļā Iespējas un uzdevumi. Šai pastaigā iestatiet iespēju uz ready ar POST /v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status:

Set capability ready

curl --request POST \
  "${API_BASE}/v3/sandbox/customers/${CUSTOMER_ID}/capabilities/${CAPABILITY_ID}/status" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{"status":"ready"}'

Šī testa kontrole nav produkcijas iesaiste. Atkārtoti ielādējiet ar GET /v3/customers/{customerId}/capabilities/{capabilityId}:

Refetch capability

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

Atsvaidziniet CAPABILITY_STATUS un TASK_IDS no data.status un data.openTaskIds. Turpiniet tikai tad, kad CAPABILITY_STATUS ir ready.

7. Veidojiet izvēlēto plūsmu

Izveidojiet vienu izsniegtu USDC maku uz Base tīkla ar POST /v3/customers/{customerId}/accounts:

Create wallet

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/accounts" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-flow-wallet-001" \
  --header "Content-Type: application/json" \
  --data '{"origin":"issued","type":"wallet","currency":"USDC","network":"base"}'

Saglabājiet data.id kā FLOW_WALLET_ID, data.status kā FLOW_WALLET_STATUS un data.openTaskIds kā FLOW_WALLET_TASK_IDS. Ja FLOW_WALLET_TASK_IDS nav tukšs, pabeidziet pašreizējos uzdevumus sadaļā Iespējas un uzdevumi. Atkārtoti ielādējiet maku ar GET /v3/customers/{customerId}/accounts/{accountId}:

Refetch wallet

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

Atsvaidziniet FLOW_WALLET_STATUS un FLOW_WALLET_TASK_IDS no data.status un data.openTaskIds. Turpiniet tikai tad, kad FLOW_WALLET_STATUS ir ready.

Iemaksa
Izmaksa
Izsniegts bankas konts

Izveidojiet USD uz USDC kotāciju ar POST /v3/quotes:

Pay-in quote

curl --request POST \
  "${API_BASE}/v3/quotes" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-payin-quote-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{"customerId":"${CUSTOMER_ID}","capabilityId":"${CAPABILITY_ID}","in":{"amount":"150.00","currency":"USD"},"destinationId":"${FLOW_WALLET_ID}","out":{"currency":"USDC"}}
JSON

Saglabājiet data.id kā QUOTE_ID, pēc tam izpildiet to ar POST /v3/transfers:

Execute quote

curl --request POST \
  "${API_BASE}/v3/transfers" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-payin-transfer-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{"quoteId":"${QUOTE_ID}"}
JSON

Saglabājiet data.id kā TRANSFER_ID. Iegūstiet instrukcijas ar GET /v3/transfers/{transferId}/instructions:

Funding instructions

curl --request GET \
  "${API_BASE}/v3/transfers/${TRANSFER_ID}/instructions" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}"

Atbilde satur data.transferId un data.instructions. Saglabājiet data.transferId kā TRANSFER_ID un data.instructions kā FUNDING_INSTRUCTIONS.

Papildiniet gatavo maku ar POST /v3/sandbox/accounts/{accountId}/topup:

Fund wallet

curl --request POST \
  "${API_BASE}/v3/sandbox/accounts/${FLOW_WALLET_ID}/topup" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{"amount":"250.00","currency":"USDC"}'

Izveidojiet klientam piederošu ACH kontu ar POST /v3/customers/{customerId}/accounts:

Create ACH account

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/accounts" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-payout-account-001" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{"origin":"external","type":"bank","methods":["ach"],"country":"US","currency":"USD","details":{"routingNumber":"021000021","accountNumber":"123456789","accountType":"checking","bankName":"Example Bank","accountHolderName":"Amina Diallo"}}
JSON

Saglabājiet data.id kā PAYOUT_ACCOUNT_ID, data.status kā PAYOUT_ACCOUNT_STATUS un data.openTaskIds kā PAYOUT_ACCOUNT_TASK_IDS. Ja PAYOUT_ACCOUNT_TASK_IDS nav tukšs, pabeidziet pašreizējos uzdevumus sadaļā Iespējas un uzdevumi.Atkārtoti ielādējiet to ar GET /v3/customers/{customerId}/accounts/{accountId}:

Refetch ACH account

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

Atsvaidziniet PAYOUT_ACCOUNT_STATUS un PAYOUT_ACCOUNT_TASK_IDS no data.status un data.openTaskIds. Turpiniet tikai tad, kad PAYOUT_ACCOUNT_STATUS ir ready, pēc tam izveidojiet kotāciju ar POST /v3/quotes:

Payout quote

curl --request POST \
  "${API_BASE}/v3/quotes" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-payout-quote-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{"customerId":"${CUSTOMER_ID}","capabilityId":"${CAPABILITY_ID}","in":{"amount":"150.00","currency":"USDC","accountId":"${FLOW_WALLET_ID}"},"destinationId":"${PAYOUT_ACCOUNT_ID}","out":{"currency":"USD"}}
JSON

Saglabājiet data.id kā QUOTE_ID, izpildiet to ar POST /v3/transfers un saglabājiet atgriezto data.id kā TRANSFER_ID:

Execute payout

curl --request POST \
  "${API_BASE}/v3/transfers" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-payout-transfer-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{"quoteId":"${QUOTE_ID}"}
JSON

Izveidojiet ACH/USD kontu, kas norēķinās uz gatavā maka, ar POST /v3/customers/{customerId}/accounts:

Issue bank account

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/accounts" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: quickstart-bank-account-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{"origin":"issued","type":"bank","method":"ach","country":"US","currency":"USD","settlement":{"accountId":"${FLOW_WALLET_ID}"}}
JSON

Saglabājiet data.id kā BANK_ACCOUNT_ID, pēc tam nolasiet nodrošinājumu ar GET /v3/customers/{customerId}/accounts/{accountId}:

Check provisioning

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

Saglabājiet data.status kā BANK_ACCOUNT_STATUS, data.details kā BANK_ACCOUNT_DETAILS un data.openTaskIds kā BANK_ACCOUNT_TASK_IDS. Pabeidziet visus pašreizējos uzdevumus, pēc tam atkārtoti nolasiet kontu, līdz tā statuss atļauj lietošanu un ir pieejams data.details.Bankas rekvizīti var nebūt pieejami uzreiz. Zars ir pabeigts, kad varat parādīt precīzus atkārtoti izmantojamus bankas rekvizītus, kas atgriezti sadaļā BANK_ACCOUNT_DETAILS. Nekad neveidojiet un nerādiet vietturu koordinātas, kamēr konts vēl tiek nodrošināts.

Iemaksām un izmaksām uzraugiet TRANSFER_ID ar GET /v3/transfers/{transferId}:

Monitor transfer

curl --request GET \
  "${API_BASE}/v3/transfers/${TRANSFER_ID}" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}"

Iemaksa

Veidojiet pilnu iemaksas plūsmu.

Izmaksa

Veidojiet produkcijas izmaksu apstrādi.

Izsniegts bankas konts

Apstrādājiet nodrošinājumu un detaļas.

Tālāk pievienojiet webhook izsaukumus. Katrs iepriekš minētais pieprasījums jau saista uz tā pilnu API atsauces shēmu un statusa lapu.

Sākt darbu

Klientu iekļaušana

Veidot naudas plūsmas

Palaišana

1. Konfigurējiet smilšu kasti

2. Izveidojiet klientu

3. Izvēlieties rezultātu

4. Atrodiet piemērotu iespēju

5. Pieprasiet iespēju

6. Pabeidziet iesaisti smilšu kastē

7. Veidojiet izvēlēto plūsmu

Iemaksa

Izmaksa

Izsniegts bankas konts

​1. Konfigurējiet smilšu kasti

​2. Izveidojiet klientu

​3. Izvēlieties rezultātu

​4. Atrodiet piemērotu iespēju

​5. Pieprasiet iespēju

​6. Pabeidziet iesaisti smilšu kastē

​7. Veidojiet izvēlēto plūsmu

Iemaksa

Izmaksa

Izsniegts bankas konts

1. Konfigurējiet smilšu kasti

2. Izveidojiet klientu

3. Izvēlieties rezultātu

4. Atrodiet piemērotu iespēju

5. Pieprasiet iespēju

6. Pabeidziet iesaisti smilšu kastē

7. Veidojiet izvēlēto plūsmu