Quickstart

Crea un client, prepara una cartera reutilitzable i executa el flux de sandbox que necessitis.

1. Configura el sandbox

Utilitza una clau d’API de sandbox des del teu backend:

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

La clau selecciona l’entorn de sandbox al host compartit de l’API.

2. Crea un client

Crea un client individual amb POST /v3/customers:

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

Emmagatzema data.id com a CUSTOMER_ID.

3. Escull el resultat

Cobrament: rep USD i liquida USDC a la cartera emesa del client.
Pagament: envia USDC des de la cartera emesa del client a un compte bancari propietat del client.
Compte bancari emès: emet un compte ACH/USD que liquida a la cartera emesa del client.

Per a un pagament a tercers, segueix Destinataris o Enviar fons.

4. Troba una capacitat elegible

Llista les capacitats suportades amb GET /v3/customers/{customerId}/capabilities/supported:

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

Escull una entrada de resposta amb availability establert a available o beta, eligibility.eligible establert a true, les directions i method necessaris i l’accountType corresponent. Utilitza la cartera emesa del client com a destinació del cobrament, origen del pagament o compte de liquidació del compte bancari; utilitza el compte propietat del client com a destinationId per a aquesta ruta de pagament. Si es retornen institutions, utilitza només una opció d’institució retornada. Emmagatzema l’id de l’entrada com a CAPABILITY_ID; no codifiquis de manera fixa un ID de capacitat universal.

5. Sol·licita la capacitat

Sol·licita la capacitat seleccionada amb POST /v3/customers/{customerId}/capabilities/{capabilityId}:

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

Emmagatzema data.status com a CAPABILITY_STATUS i data.openTaskIds com a TASK_IDS.

6. Completa la incorporació al sandbox

Si TASK_IDS no està buit, completa cada requisit actual mitjançant Capacitats i tasques. Per a aquest recorregut, estableix la capacitat a ready amb POST /v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status:

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

Aquest control de proves no és la incorporació de producció. Torna a obtenir amb GET /v3/customers/{customerId}/capabilities/{capabilityId}:

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

Refresca CAPABILITY_STATUS i TASK_IDS a partir de data.status i data.openTaskIds. Continua només quan CAPABILITY_STATUS sigui ready.

7. Construeix el flux seleccionat

Crea una cartera USDC emesa a Base amb POST /v3/customers/{customerId}/accounts:

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

Emmagatzema data.id com a FLOW_WALLET_ID, data.status com a FLOW_WALLET_STATUS i data.openTaskIds com a FLOW_WALLET_TASK_IDS. Si FLOW_WALLET_TASK_IDS no està buit, completa les tasques actuals mitjançant Capacitats i tasques. Torna a obtenir la cartera amb GET /v3/customers/{customerId}/accounts/{accountId}:

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

Refresca FLOW_WALLET_STATUS i FLOW_WALLET_TASK_IDS a partir de data.status i data.openTaskIds. Continua només quan FLOW_WALLET_STATUS sigui ready.

Cobrament
Pagament
Compte bancari emès

Crea una cotització USD-a-USDC amb POST /v3/quotes:

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

Emmagatzema data.id com a QUOTE_ID, i després executa-la amb POST /v3/transfers:

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

Emmagatzema data.id com a TRANSFER_ID. Obté les instruccions amb GET /v3/transfers/{transferId}/instructions:

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

La resposta conté data.transferId i data.instructions. Emmagatzema data.transferId com a TRANSFER_ID i data.instructions com a FUNDING_INSTRUCTIONS.

Finança la cartera preparada amb POST /v3/sandbox/accounts/{accountId}/topup:

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

Crea un compte ACH propietat del client amb POST /v3/customers/{customerId}/accounts:

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

Emmagatzema data.id com a PAYOUT_ACCOUNT_ID, data.status com a PAYOUT_ACCOUNT_STATUS i data.openTaskIds com a PAYOUT_ACCOUNT_TASK_IDS. Si PAYOUT_ACCOUNT_TASK_IDS no està buit, completa les tasques actuals mitjançant Capacitats i tasques.Torna a obtenir-lo amb GET /v3/customers/{customerId}/accounts/{accountId}:

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

Refresca PAYOUT_ACCOUNT_STATUS i PAYOUT_ACCOUNT_TASK_IDS a partir de data.status i data.openTaskIds. Continua només quan PAYOUT_ACCOUNT_STATUS sigui ready, i després crea la cotització amb POST /v3/quotes:

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

Emmagatzema data.id com a QUOTE_ID, executa-la amb POST /v3/transfers i emmagatzema el data.id retornat com a TRANSFER_ID:

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

Crea un compte ACH/USD liquidat a la cartera preparada amb POST /v3/customers/{customerId}/accounts:

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

Emmagatzema data.id com a BANK_ACCOUNT_ID, i després llegeix el provisionament amb GET /v3/customers/{customerId}/accounts/{accountId}:

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

Emmagatzema data.status com a BANK_ACCOUNT_STATUS, data.details com a BANK_ACCOUNT_DETAILS i data.openTaskIds com a BANK_ACCOUNT_TASK_IDS. Completa qualsevol tasca actual, i després torna a llegir el compte fins que el seu estat permeti utilitzar-lo i data.details estigui present.Els detalls bancaris poden no estar presents immediatament. La branca està completa quan pots presentar els detalls bancaris reutilitzables exactes retornats a BANK_ACCOUNT_DETAILS. No construeixis ni mostris coordenades de reserva mentre el compte encara s’està provisionant.

Per a cobraments i pagaments, monitoritza TRANSFER_ID amb GET /v3/transfers/{transferId}:

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

Cobrament

Construeix el flux complet de cobrament.

Pagament

Construeix la gestió de pagaments en producció.

Compte bancari emès

Gestiona el provisionament i els detalls.

A continuació, afegeix webhooks. Cada sol·licitud anterior ja enllaça al seu esquema complet de la referència de l’API i a la pàgina d’estat.

Comença aquí

Incorpora clients

Construeix fluxos de diners

Llança

1. Configura el sandbox

2. Crea un client

3. Escull el resultat

4. Troba una capacitat elegible

5. Sol·licita la capacitat

6. Completa la incorporació al sandbox

7. Construeix el flux seleccionat

Cobrament

Pagament

Compte bancari emès

​1. Configura el sandbox

​2. Crea un client

​3. Escull el resultat

​4. Troba una capacitat elegible

​5. Sol·licita la capacitat

​6. Completa la incorporació al sandbox

​7. Construeix el flux seleccionat

Cobrament

Pagament

Compte bancari emès

1. Configura el sandbox

2. Crea un client

3. Escull el resultat

4. Troba una capacitat elegible

5. Sol·licita la capacitat

6. Completa la incorporació al sandbox

7. Construeix el flux seleccionat