サンドボックステスト

サンドボックスは、本番と同じ API ホストを使用します。サンドボックスの API キーがテスト環境を選択し、そこではヘルパーが実際の資金を移動せずに結果をシミュレートします。キーはバックエンドに保管してください。サンドボックスのヘルパーは本番のコンプライアンスやオンボーディングを置き換えるものではありません。サンドボックス操作が返すバリデーション、状態、および再試行可能なプラットフォーム障害をインテグレーションがどのように処理するかをテストするには、エラーと再試行を使用してください。

Environment variables

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

ケイパビリティの ready 状態をテストする

サンドボックスでは、ACH、Wire、SWIFT のケイパビリティは、指定型とプール型のどちらも JPMorgan Chase (jpmorgan) でのみ提供されます。これらのケイパビリティをリクエストする際に institutions を省略すると、Swipelux は jpmorgan を選択します。他の銀行を指定すると 422 capability_institutions_unsupported が返されます。サンドボックスのサポート対象ケイパビリティ一覧では、これらの方法について jpmorgan のみが表示されます。本番環境のルーティングや、RTP、Pix、SPEI などの他の方法は変わりません。

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

ケイパビリティをリクエストした後、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"}'

ヘルパーの使用後にケイパビリティを再取得します。現在の status と openTaskIds を、製品が処理すべき結果として扱ってください。 200 レスポンスでも、顧客タスクや pending のレビューなど、未完了の作業が表示される場合があります。 approval_scope_review_required、運用上の保留、終了ステータスなど、サンドボックスでは解消できない理由によりケイパビリティがリクエストされたステータスに到達できない場合、ヘルパーは 409 capability_status_blocked を返します。問題レスポンスの statusReason には、ケイパビリティの理由コードとメッセージが retryable: false とともに含まれます。理由の resolution を確認するには、ケイパビリティを読み取ってください。指定型ケイパビリティを 2 回目に rejected に強制すると、同じケイパビリティが変更されずに返されます。却下されたケイパビリティを restricted または ready に強制すると 422 invalid_capability が返されます。これらのステータスをテストするには、代わりに新しいサンドボックス顧客を作成してください。

オープンタスクをテストする

POST /v3/sandbox/tasks でサンドボックスタスクを作成します。テストするワークフローのリソースをスコープに指定し、顧客が提出する内容を items で記述します。このガイドではケイパビリティと送金のワークフローを示します。customer スコープと完全なリクエストスキーマは API Reference で確認してください。テキスト回答には explanation 項目、ファイルのアップロードには document 項目を使用します。新しい profile 項目には、顧客フィールドを示す JSON Pointer である profilePointer も必要です。その他の項目タイプとフィールドは Create sandbox task を参照してください。送金の例では、まず入金または支払いフローでサンドボックス送金を作成し、返された data.id をエクスポートします。

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

ケイパビリティ + explanation
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

タスクを審査対象の送金にスコープし、受け付ける種類・形式・経過日数を絞り込む constraints を指定してドキュメントを要求します。

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

この例では、受け付けるドキュメントの種類、形式、経過日数を制限します。サポートされるすべてのドキュメント制約は Create sandbox task を参照してください。

data.id を TASK_ID、data.revision を TASK_REVISION、現在の data.requirements[0].id を REQUIREMENT_ID として保存します。POST /v3/customers/{customerId}/tasks/{taskId}/submissions を呼び出すときは、作成した項目のタイプに回答を合わせます。

説明の回答
ドキュメントの回答

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

POST /v3/customers/{customerId}/documents で条件に合うファイルをアップロードし、返された data.id を DOCUMENT_ID として保存して、ドキュメント回答として送信します。

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

次に、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"}'

POST /v3/sandbox/tasks で作成したタスクと、Swipelux が収集するケイパビリティの受付タスクはレビューできます。Operations または別のワークフローが所有するタスクをレビューすると、409 task_not_sandbox_reviewable が返されます。そのタスクはタスクエンドポイントから引き続き読み取ることができ、所有者によるレビューを待ちます。404 task_not_found は、タスク ID が不明であるか、別のマーチャントに属していることを意味します。本番のタスク完了パターンには、ケイパビリティとタスクを使用してください。

サンドボックスウォレットに入金する

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

シミュレートされた入金トランスファーを調べたい場合は、返された data.id を TRANSFER_ID として保存してください。 topup の id はトランスファー id です。GET /v3/transfers/{transferId} で取得するか、GET /v3/transfers でリスト表示して、サンドボックスの topup に対してインバウンド入金の処理経路を試してください。トランスファーのプロジェクションは origin: "inbound_deposit"、method: "stablecoin_transfers"、direction: "stablecoin_move" を持つ完了済みのインバウンドステーブルコイン入金として返され、対応する accountId、origin、method、direction のリストフィルターでも返されます。

送金を完了または失敗させる

POST /v3/sandbox/transfers/{transferId}/state で結果を設定します。

完了
失敗

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

次に、サンドボックスで入金、支払い、または発行済み銀行口座のフローを実行してください。

はじめに

顧客のオンボーディング

資金フローの構築

ローンチ

サンドボックステスト

ケイパビリティの ready 状態をテストする

オープンタスクをテストする

サンドボックスウォレットに入金する

送金を完了または失敗させる

​ケイパビリティの ready 状態をテストする

​オープンタスクをテストする

​サンドボックスウォレットに入金する

​送金を完了または失敗させる

ケイパビリティの ready 状態をテストする

オープンタスクをテストする

サンドボックスウォレットに入金する

送金を完了または失敗させる