Smilšu kastes testēšana

Smilšu kaste izmanto to pašu API resursdatoru kā produkcija. Smilšu kastes API atslēga izvēlas testa vidi, kur palīgi simulē rezultātus, nepārvietojot reālus līdzekļus. Turiet atslēgu savā aizmugursistēmā. Smilšu kastes palīgi neaizstāj produkcijas atbilstību vai iesaisti. Izmantojiet Kļūdas un atkārtoti mēģinājumi, lai testētu, kā jūsu integrācija apstrādā validācijas, stāvokļa un atkārtojamas platformas kļūmes, ko atgriež smilšu kastes operācijas.

Environment variables

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

Testējiet iespējas gatavību

Sandbox vidē ACH, Wire un SWIFT iespējas, gan nosauktās, gan apvienotās, tiek nodrošinātas tikai JPMorgan Chase (jpmorgan). Ja, pieprasot kādu no šīm iespējām, izlaižat institutions, Swipelux izvēlas jpmorgan. Jebkuras citas bankas norādīšana atgriež 422 capability_institutions_unsupported. Sandbox vidē atbalstīto iespēju sarakstā šīm metodēm ir redzams tikai jpmorgan. Produkcijas maršrutēšana un citas metodes, piemēram, RTP, Pix un SPEI, nemainās.

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

Pēc iespējas pieprasīšanas iestatiet tās smilšu kastes statusu ar 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"}'

Pēc palīga izmantošanas atkārtoti ielādējiet iespēju. Uztveriet tās pašreizējo status un openTaskIds kā rezultātu, ko jūsu produktam jāapstrādā. Arī 200 atbildē joprojām var būt redzams atvērts darbs, piemēram, klienta uzdevumi vai pending pārskatīšana. Palīgs atgriež 409 capability_status_blocked, ja iespēja nevar sasniegt pieprasīto statusu iemesla dēļ, ko sandbox vidē nevarat novērst, piemēram, approval_scope_review_required, operatīva aizturēšana vai galīgs statuss. Problēmas statusReason satur iespējas iemesla kodu un ziņojumu ar retryable: false. Lai uzzinātu iemesla resolution, nolasiet iespēju. Nosauktas iespējas piespiedu iestatīšana uz rejected otro reizi atgriež to pašu iespēju bez izmaiņām. Noraidītas iespējas piespiedu iestatīšana uz restricted vai ready atgriež 422 invalid_capability. Lai testētu šos statusus, tā vietā izveidojiet jaunu sandbox klientu.

Testējiet atvērtu uzdevumu

Izveidojiet smilšu kastes uzdevumu ar POST /v3/sandbox/tasks. Piesaistiet to resursam, kura darbplūsmu testējat, un ar items aprakstiet, kas klientam jāiesniedz. Šī rokasgrāmata parāda capability un transfer darbplūsmas; API Reference definē customer mērogu un pilno pieprasījuma shēmu. Teksta atbildei izmantojiet explanation elementu, bet faila augšupielādei — document elementu. Jauniem profile elementiem vajadzīgs arī profilePointer, JSON Pointer uz klienta lauku. Citus elementu tipus un laukus skatiet sadaļā Izveidot smilšu kastes uzdevumu. Transfer piemēram vispirms izveidojiet smilšu kastes transfer ar pay-in vai payout darbplūsmu un pēc tam eksportējiet atgriezto data.id:

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

Iespēja + paskaidrojums
Pārveduma RFI + dokuments

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

Ierobežojiet uzdevuma mērogu līdz pārbaudāmajam pārvedumam un pieprasiet dokumentu ar constraints, kas sašaurina pieņemtos tipus, formātus un vecumu.

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

Piemērs ierobežo pieņemto dokumenta tipu, formātu un vecumu. Visus atbalstītos dokumenta ierobežojumus skatiet sadaļā Izveidot smilšu kastes uzdevumu.

Saglabājiet data.id kā TASK_ID, data.revision kā TASK_REVISION un pašreizējo data.requirements[0].id kā REQUIREMENT_ID. Izsaucot POST /v3/customers/{customerId}/tasks/{taskId}/submissions, atbildes tipam jāatbilst izveidotajam elementam:

Paskaidrojuma atbilde
Dokumenta atbilde

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

Augšupielādējiet atbilstošu failu ar POST /v3/customers/{customerId}/documents, saglabājiet atgriezto data.id kā DOCUMENT_ID un iesniedziet to kā dokumenta atbildi:

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

Pēc tam pieņemiet vai noraidiet pašreizējo iesniegumu ar 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"}'

Varat pārskatīt uzdevumus, kas izveidoti ar POST /v3/sandbox/tasks, un iespēju pieņemšanas uzdevumus, ko Swipelux apkopo. Tāda uzdevuma pārskatīšana, kas pieder Operations vai citai darbplūsmai, atgriež 409 task_not_sandbox_reviewable. Šis uzdevums joprojām ir nolasāms, izmantojot uzdevumu galapunktus, un gaida, kad to pārskatīs tā īpašnieks. 404 task_not_found nozīmē, ka uzdevuma ID nav zināms vai pieder citam tirgotājam. Izmantojiet Iespējas un uzdevumi produkcijas uzdevumu pabeigšanas paraugam.

Papildiniet smilšu kastes maku

Kreditējiet izsniegtu maku ar 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"}'

Saglabājiet atgriezto data.id kā TRANSFER_ID, ja vēlaties pārbaudīt simulēto finansējuma pārvedumu. Papildinājuma id ir pārveduma id. Iegūstiet to caur GET /v3/transfers/{transferId} vai uzskaitiet caur GET /v3/transfers, lai izmēģinātu savu ienākošās iemaksas koda ceļu ar smilšu kastes papildinājumiem. Pārveduma projekcija ir pabeigta ienākoša stabilās monētas iemaksa ar origin: "inbound_deposit", method: "stablecoin_transfers" un direction: "stablecoin_move", un to atgriež atbilstošie accountId, origin, method un direction saraksta filtri.

Pabeidziet vai noraidiet pārvedumu

Iestatiet rezultātu ar POST /v3/sandbox/transfers/{transferId}/state:

Pabeigt
Noraidīt

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

Tālāk palaidiet iemaksas, izmaksas vai izsniegta bankas konta plūsmu smilšu kastē.

Sākt darbu

Klientu iekļaušana

Veidot naudas plūsmas

Palaišana

Smilšu kastes testēšana

Testējiet iespējas gatavību

Testējiet atvērtu uzdevumu

Papildiniet smilšu kastes maku

Pabeidziet vai noraidiet pārvedumu

​Testējiet iespējas gatavību

​Testējiet atvērtu uzdevumu

​Papildiniet smilšu kastes maku

​Pabeidziet vai noraidiet pārvedumu

Testējiet iespējas gatavību

Testējiet atvērtu uzdevumu

Papildiniet smilšu kastes maku

Pabeidziet vai noraidiet pārvedumu