Sandbox-testen

Sandbox gebruikt dezelfde API-host als productie. Een sandbox API-key selecteert de testomgeving, waar helpers uitkomsten simuleren zonder echt geld te verplaatsen. Houd de key op je backend. Sandbox-helpers vervangen geen productiecompliance of -onboarding. Gebruik Fouten en nieuwe pogingen om te testen hoe je integratie omgaat met validatie-, state- en retryable platformfouten die sandbox-operations retourneren.

Environment variables

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

Test capability-readiness

In de sandbox worden ACH-, Wire- en SWIFT-capabilities, zowel benoemde als gepoolde, alleen bij JPMorgan Chase (jpmorgan) aangeboden. Laat institutions weg wanneer je een van deze capabilities aanvraagt en Swipelux kiest jpmorgan. Een andere bank opgeven retourneert 422 capability_institutions_unsupported. De lijst met ondersteunde capabilities in de sandbox toont voor deze methoden alleen jpmorgan. Productieroutering en andere methoden, zoals RTP, Pix en SPEI, blijven ongewijzigd.

Request a sandbox bank capability

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

Nadat je een capability hebt aangevraagd, stel je de sandbox-status in met POST /v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status:

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

Refetch de capability na gebruik van de helper. Behandel de huidige status en openTaskIds als het resultaat dat je product moet verwerken. Een 200-response kan nog steeds openstaand werk tonen, zoals klanttaken of een pending-review. De helper retourneert 409 capability_status_blocked wanneer de capability de gevraagde status niet kan bereiken om een reden die je in de sandbox niet kunt oplossen, zoals approval_scope_review_required, een operationele blokkade of een eindstatus. De statusReason van het probleem bevat de redencode en het bericht van de capability, met retryable: false. Lees de capability voor de resolution van de reden. Een benoemde capability een tweede keer naar rejected forceren retourneert dezelfde capability ongewijzigd. Een afgewezen capability naar restricted of ready forceren retourneert 422 invalid_capability. Maak in plaats daarvan een nieuwe sandboxklant aan om die statussen te testen.

Test een open taak

Maak een sandbox-taak met POST /v3/sandbox/tasks. Koppel deze aan de resource waarvan je de workflow test en gebruik items om te beschrijven wat de klant moet indienen. Deze handleiding toont capability- en transferworkflows; de API Reference definieert de customer-scope en het volledige requestschema. Gebruik een explanation-item voor een tekstantwoord en een document-item voor een upload. Nieuwe profile-items vereisen ook profilePointer, een JSON Pointer naar het klantveld. Zie Sandbox-taak aanmaken voor de overige itemtypen en velden. Maak voor het transfervoorbeeld eerst een sandbox-transfer via een pay-in- of payout-flow en exporteer daarna de geretourneerde data.id:

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

Capability + toelichting
Transfer RFI + document

curl --request POST \
  "${API_BASE}/v3/sandbox/tasks" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{
  "scope": {
    "type": "capability",
    "customerId": "${CUSTOMER_ID}",
    "capabilityId": "${CAPABILITY_ID}"
  },
  "items": [
    {
      "type": "explanation",
      "request": "Explain the source of funds."
    }
  ]
}
JSON

Scope de taak op de transfer die wordt beoordeeld en vraag een document op met constraints die de geaccepteerde typen, formaten en leeftijd beperken.

Create document task

curl --request POST \
  "${API_BASE}/v3/sandbox/tasks" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{
  "scope": {
    "type": "transfer",
    "customerId": "${CUSTOMER_ID}",
    "transferId": "${TRANSFER_ID}"
  },
  "category": "transaction_rfi",
  "items": [
    {
      "type": "document",
      "request": "Upload a bank statement showing the source of funds for this transfer.",
      "constraints": {
        "acceptedDocumentTypes": ["bank_statement"],
        "acceptedFormats": ["pdf", "jpeg"],
        "maxAgeDays": 90
      }
    }
  ]
}
JSON

Het voorbeeld beperkt het geaccepteerde documenttype, de indeling en de ouderdom. Zie Sandbox-taak aanmaken voor alle ondersteunde documentbeperkingen.

Bewaar data.id als TASK_ID, data.revision als TASK_REVISION en de huidige data.requirements[0].id als REQUIREMENT_ID. Laat het antwoord bij een aanroep van POST /v3/customers/{customerId}/tasks/{taskId}/submissions overeenkomen met het item dat je hebt gemaakt:

Antwoord met toelichting
Documentantwoord

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/tasks/${TASK_ID}/submissions" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: sandbox-task-submission-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{
  "taskRevision": ${TASK_REVISION},
  "answers": [
    {
      "requirementId": "${REQUIREMENT_ID}",
      "answer": {
        "type": "text",
        "value": "Sandbox requirement completed."
      }
    }
  ]
}
JSON

Upload een passend bestand met POST /v3/customers/{customerId}/documents, bewaar de geretourneerde data.id als DOCUMENT_ID en dien deze in als documentantwoord:

Upload document

curl --request POST \
  "${API_BASE}/v3/customers/${CUSTOMER_ID}/tasks/${TASK_ID}/submissions" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Idempotency-Key: sandbox-task-document-submission-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{
  "taskRevision": ${TASK_REVISION},
  "answers": [
    {
      "requirementId": "${REQUIREMENT_ID}",
      "answer": {
        "type": "document",
        "documentIds": ["${DOCUMENT_ID}"]
      }
    }
  ]
}
JSON

Accepteer of weiger vervolgens de huidige submission met POST /v3/sandbox/tasks/{taskId}/review:

Review submission

curl --request POST \
  "${API_BASE}/v3/sandbox/tasks/${TASK_ID}/review" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{"outcome":"accepted"}'

Je kunt taken reviewen die zijn aangemaakt met POST /v3/sandbox/tasks en de capability-intaketaken die Swipelux verzamelt. Een taak reviewen die eigendom is van Operations of een andere workflow retourneert 409 task_not_sandbox_reviewable. Die taak blijft leesbaar via de taak-endpoints en wacht tot de eigenaar hem reviewt. 404 task_not_found betekent dat de taak-ID onbekend is of bij een andere merchant hoort. Gebruik Capabilities en tasks voor het productie-patroon voor taakvoltooiing.

Financier een sandbox-wallet

Crediteer een uitgegeven wallet met POST /v3/sandbox/accounts/{accountId}/topup:

Top up issued wallet

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

Bewaar de geretourneerde data.id als TRANSFER_ID wanneer je de gesimuleerde funding-transfer wilt inspecteren. Het topup-id is een transfer-id. Haal het op via GET /v3/transfers/{transferId} of vraag het lijst-endpoint op via GET /v3/transfers om je code-pad voor inbound-deposits te oefenen tegen sandbox-topups. De transfer-projectie is een voltooide inbound stablecoin-deposit met origin: "inbound_deposit", method: "stablecoin_transfers" en direction: "stablecoin_move", en wordt geretourneerd door de bijbehorende lijstfilters accountId, origin, method en direction.

Voltooi of laat een transfer mislukken

Stel de uitkomst in met POST /v3/sandbox/transfers/{transferId}/state:

Voltooien
Laten mislukken

curl --request POST \
  "${API_BASE}/v3/sandbox/transfers/${TRANSFER_ID}/state" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{"state":"completed"}'

curl --request POST \
  "${API_BASE}/v3/sandbox/transfers/${TRANSFER_ID}/state" \
  --header "X-API-Key: ${SWIPELUX_SANDBOX_API_KEY}" \
  --header "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "state": "failed",
  "stateDetail": {
    "code": "sandbox_review",
    "message": "Sandbox transfer failed."
  }
}
JSON

Voer vervolgens een pay-in, uitbetaling of uitgegeven bankrekening-flow uit in sandbox.

Aan de slag

Klanten onboarden

Geldstromen bouwen

Live gaan

Test capability-readiness

Test een open taak

Financier een sandbox-wallet

Voltooi of laat een transfer mislukken

​Test capability-readiness

​Test een open taak

​Financier een sandbox-wallet

​Voltooi of laat een transfer mislukken

Test capability-readiness

Test een open taak

Financier een sandbox-wallet

Voltooi of laat een transfer mislukken