Sandbox-testaus

Sandbox käyttää samaa API-isäntää kuin tuotanto. Sandbox-API-avain valitsee testiympäristön, jossa apuvälineet simuloivat tuloksia siirtämättä oikeita varoja. Pidä avain taustapalvelussasi. Sandbox-apuvälineet eivät korvaa tuotannon vaatimustenmukaisuutta tai käyttöönottoa. Käytä Virheet ja uudelleenyritykset -sivua testataksesi, miten integraatiosi käsittelee sandbox-toimintojen palauttamat validointi-, tila- ja uudelleenyritettävät alustavirheet.

Environment variables

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

Testaa kyvyn valmius

Sandboxissa ACH-, Wire- ja SWIFT-kykyjä, sekä nimettyjä että yhdistettyjä, tarjotaan vain JPMorgan Chasessa (jpmorgan). Jos jätät institutions-kentän pois pyytäessäsi jotakin näistä kyvyistä, Swipelux valitsee jpmorgan. Minkä tahansa muun pankin nimeäminen palauttaa 422 capability_institutions_unsupported. Sandboxin tuettujen kykyjen luettelo näyttää näille menetelmille vain jpmorgan. Tuotannon reititys ja muut menetelmät, kuten RTP, Pix ja SPEI, pysyvät ennallaan.

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

Kun olet pyytänyt kykyä, aseta sen sandbox-tila POST /v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status -toiminnolla:

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

Hae kyky uudelleen apuvälineen käytön jälkeen. Käsittele sen nykyistä status- ja openTaskIds-tulosta tuotteesi käsittelemänä tuloksena. 200-vastaus voi silti näyttää avointa työtä, kuten asiakkaan tehtäviä tai pending-tarkistuksen. Apuväline palauttaa 409 capability_status_blocked, kun kyky ei voi saavuttaa pyydettyä tilaa syystä, jota et voi poistaa sandboxissa, kuten approval_scope_review_required, operatiivinen pito tai lopullinen tila. Ongelman statusReason sisältää kyvyn syykoodin ja viestin sekä arvon retryable: false. Lue kyky saadaksesi syyn resolution-tiedon. Nimetyn kyvyn pakottaminen tilaan rejected toisen kerran palauttaa saman kyvyn muuttumattomana. Hylätyn kyvyn pakottaminen tilaan restricted tai ready palauttaa 422 invalid_capability. Luo sen sijaan uusi sandbox-asiakas näiden tilojen testaamiseen.

Testaa avoin tehtävä

Luo sandbox-tehtävä POST /v3/sandbox/tasks -toiminnolla. Kohdista se testattavan työnkulun resurssiin ja kuvaa asiakkaan toimitus items-kentässä. Tässä oppaassa näytetään capability- ja transfer-työnkulut; API Reference määrittää customer-laajuuden ja koko pyyntöskeeman. Käytä explanation-elementtiä tekstivastaukseen ja document-elementtiä tiedoston lataamiseen. Uudet profile-elementit vaativat myös profilePointer-kentän, joka on asiakaskentän nimeävä JSON Pointer. Muut elementtityypit ja kentät ovat kohdassa Luo sandbox-tehtävä. Luo transfer-esimerkkiä varten ensin sandbox-transfer pay-in- tai payout-työnkululla ja vie sitten palautettu data.id:

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

Kyky + selitys
Siirron RFI + dokumentti

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

Kohdista tehtävä tarkasteltavana olevaan siirtoon ja pyydä dokumenttia constraints-määrittelyillä, jotka rajaavat hyväksyttyjä tyyppejä, muotoja ja ikää.

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

Esimerkki rajaa hyväksytyn dokumenttityypin, muodon ja iän. Kaikki tuetut dokumenttirajoitukset ovat kohdassa Luo sandbox-tehtävä.

Tallenna data.id muuttujaan TASK_ID, data.revision muuttujaan TASK_REVISION ja nykyinen data.requirements[0].id muuttujaan REQUIREMENT_ID. Kun kutsut POST /v3/customers/{customerId}/tasks/{taskId}/submissions -toimintoa, sovita vastaus luomaasi elementtiin:

Selitysvastaus
Dokumenttivastaus

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

Lataa vaatimuksia vastaava tiedosto POST /v3/customers/{customerId}/documents -toiminnolla, tallenna palautettu data.id muuttujaan DOCUMENT_ID ja lähetä se dokumenttivastauksena:

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

Hyväksy tai hylkää sitten nykyinen lähetys POST /v3/sandbox/tasks/{taskId}/review -toiminnolla:

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

Voit tarkistaa tehtävät, jotka on luotu POST /v3/sandbox/tasks -kutsulla, sekä kykyjen vastaanottotehtävät, jotka Swipelux kerää. Sellaisen tehtävän tarkistaminen, jonka omistaa Operations tai jokin muu työnkulku, palauttaa 409 task_not_sandbox_reviewable. Tehtävä pysyy luettavana tehtävien päätepisteiden kautta ja odottaa omistajansa tarkistusta. 404 task_not_found tarkoittaa, että tehtävän ID on tuntematon tai kuuluu toiselle kauppiaalle. Käytä Kyvyt ja tehtävät -sivua tuotannon tehtävän suorittamisen mallia varten.

Rahoita sandbox-lompakko

Hyvitä luotu lompakko POST /v3/sandbox/accounts/{accountId}/topup -toiminnolla:

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

Tallenna palautettu data.id muuttujaan TRANSFER_ID, kun haluat tarkastella simuloitua rahoitussiirtoa. Topupin tunniste on siirron tunniste. Hae se GET /v3/transfers/{transferId} -toiminnolla tai listaa se GET /v3/transfers -toiminnolla harjoitellaksesi saapuvien talletusten koodipolkuasi sandbox-topupeja vastaan. Siirron projisointi on valmistunut saapuva stablecoin-talletus, jonka origin: "inbound_deposit", method: "stablecoin_transfers" ja direction: "stablecoin_move", ja se palautetaan vastaavilla accountId-, origin-, method- ja direction-listasuodattimilla.

Suorita tai epäonnistu siirto

Aseta tulos POST /v3/sandbox/transfers/{transferId}/state -toiminnolla:

Suorita
Epäonnistu

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

Seuraavaksi suorita maksun vastaanotto, maksu ulos tai luotu pankkitili -virta sandboxissa.

Aloita

Asiakkaiden käyttöönotto

Rakenna rahavirrat

Julkaisu

Testaa kyvyn valmius

Testaa avoin tehtävä

Rahoita sandbox-lompakko

Suorita tai epäonnistu siirto

​Testaa kyvyn valmius

​Testaa avoin tehtävä

​Rahoita sandbox-lompakko

​Suorita tai epäonnistu siirto

Testaa kyvyn valmius

Testaa avoin tehtävä

Rahoita sandbox-lompakko

Suorita tai epäonnistu siirto