Sandbox-testing

Sandbox bruker samme API-vert som produksjon. En sandbox-API-nøkkel velger testmiljøet, der hjelpere simulerer utfall uten å flytte reelle midler. Hold nøkkelen på backend-en din. Sandbox-hjelpere erstatter ikke produksjons-compliance eller onboarding. Bruk Feil og nye forsøk for å teste hvordan integrasjonen din håndterer validerings-, tilstands- og gjenprøvbare plattformfeil som sandbox-operasjoner returnerer.

Environment variables

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

Test capability-klarhet

I sandbox leveres ACH-, Wire- og SWIFT-capabilities, både navngitte og samlede, kun hos JPMorgan Chase (jpmorgan). Utelat institutions når du ber om en av disse capability-ene, så velger Swipelux jpmorgan. Å oppgi en annen bank returnerer 422 capability_institutions_unsupported. Listen over støttede capabilities i sandbox viser kun jpmorgan for disse metodene. Produksjonsruting og andre metoder, som RTP, Pix og SPEI, er uendret.

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

Etter at du har bedt om en capability, sett dens sandbox-status med 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"}'

Hent capability-en på nytt etter at du har brukt hjelperen. Behandle gjeldende status og openTaskIds som resultatet produktet ditt må håndtere. Et 200-svar kan fortsatt vise åpent arbeid, for eksempel kundeoppgaver eller en pending-gjennomgang. Hjelperen returnerer 409 capability_status_blocked når capability-en ikke kan nå den forespurte statusen av en grunn du ikke kan fjerne i sandbox, som approval_scope_review_required, et driftsmessig hold eller en endelig status. Problemets statusReason inneholder capability-ens årsakskode og melding, med retryable: false. Les capability-en for årsakens resolution. Å tvinge en navngitt capability til rejected en gang til returnerer den samme capability-en uendret. Å tvinge en avvist capability til restricted eller ready returnerer 422 invalid_capability. Opprett i stedet en ny sandbox-kunde for å teste disse statusene.

Test en åpen oppgave

Opprett en sandbox-oppgave med POST /v3/sandbox/tasks. Knytt den til ressursen som har arbeidsflyten du tester, og bruk items til å beskrive hva kunden må sende inn. Denne veiledningen viser capability- og transferflyter; API Reference definerer customer-omfanget og hele request-skjemaet. Bruk et explanation-element for et tekstsvar og et document-element for en opplasting. Nye profile-elementer krever også profilePointer, en JSON Pointer til kundefeltet. Se Opprett sandbox-oppgave for andre elementtyper og felt. For transfereksemplet oppretter du først en sandbox-transfer gjennom en pay-in- eller payout-flyt, og eksporterer deretter returnert data.id:

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

Capability + forklaring
Overførings-RFI + dokument

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

Avgrens oppgaven til overføringen som er under vurdering, og be om et dokument med constraints som begrenser godkjente typer, formater og alder.

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

Eksemplet begrenser godkjent dokumenttype, format og alder. Se Opprett sandbox-oppgave for alle støttede dokumentbegrensninger.

Lagre data.id som TASK_ID, data.revision som TASK_REVISION, og gjeldende data.requirements[0].id som REQUIREMENT_ID. Når du kaller POST /v3/customers/{customerId}/tasks/{taskId}/submissions, må svaret samsvare med elementet du opprettet:

Forklaringssvar
Dokumentsvar

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

Last opp en passende fil med POST /v3/customers/{customerId}/documents, lagre returnert data.id som DOCUMENT_ID, og send den inn som et dokumentsvar:

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

Deretter aksepterer eller avviser du gjeldende innsending med 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"}'

Du kan gjennomgå oppgaver opprettet av POST /v3/sandbox/tasks og capability-mottaksoppgavene som Swipelux samler inn. Å gjennomgå en oppgave som eies av Operations eller en annen arbeidsflyt returnerer 409 task_not_sandbox_reviewable. Den oppgaven forblir lesbar gjennom oppgaveendepunktene og venter på at eieren gjennomgår den. 404 task_not_found betyr at oppgave-ID-en er ukjent eller tilhører en annen forhandler. Bruk Capabilities og oppgaver for produksjonsmønsteret for oppgavefullføring.

Finansier en sandbox-lommebok

Krediter en utstedt lommebok med 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"}'

Lagre den returnerte data.id som TRANSFER_ID når du vil inspisere den simulerte finansieringsoverføringen. Topup-ID-en er en overførings-ID. Hent den via GET /v3/transfers/{transferId} eller list den via GET /v3/transfers for å teste kodestien for innkommende innskudd mot sandbox-topups. Overføringsprojeksjonen er et fullført innkommende stablecoin-innskudd med origin: "inbound_deposit", method: "stablecoin_transfers" og direction: "stablecoin_move", og returneres av samsvarende listefiltre for accountId, origin, method og direction.

Fullfør eller la en overføring feile

Sett utfallet med POST /v3/sandbox/transfers/{transferId}/state:

Fullfør
Feil

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

Deretter, kjør en pay-in, payout eller utstedt bankkonto-flyt i sandbox.

Kom i gang

Kundeombording

Bygg pengestrømmer

Lansering

Test capability-klarhet

Test en åpen oppgave

Finansier en sandbox-lommebok

Fullfør eller la en overføring feile

​Test capability-klarhet

​Test en åpen oppgave

​Finansier en sandbox-lommebok

​Fullfør eller la en overføring feile

Test capability-klarhet

Test en åpen oppgave

Finansier en sandbox-lommebok

Fullfør eller la en overføring feile