Sandbox testing

Sandbox वही API host उपयोग करता है जो production करता है। एक sandbox API key test environment का चयन करती है, जहाँ helpers वास्तविक funds स्थानांतरित किए बिना outcomes को simulate करते हैं। Key को अपने backend पर रखें। Sandbox helpers production compliance या onboarding का स्थान नहीं लेते। Sandbox operations द्वारा लौटाए गए validation, state, और retryable platform failures को आपका integration कैसे संभालता है, इसका परीक्षण करने के लिए Errors और retries का उपयोग करें।

Environment variables

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

Capability readiness का परीक्षण करें

Sandbox में, ACH, Wire, और SWIFT capabilities, named और pooled दोनों, केवल JPMorgan Chase (jpmorgan) पर उपलब्ध होती हैं। इनमें से किसी capability का request करते समय institutions छोड़ दें, तो Swipelux jpmorgan चुनता है। किसी अन्य bank का नाम देने पर 422 capability_institutions_unsupported लौटता है। Sandbox में supported-capabilities list इन methods के लिए केवल jpmorgan दिखाती है। Production routing और अन्य methods, जैसे 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"]}'

एक capability का अनुरोध करने के बाद, इसकी sandbox status को 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"}'

Helper का उपयोग करने के बाद capability को पुन: प्राप्त करें। इसके वर्तमान status और openTaskIds को उस परिणाम के रूप में मानें जिसे आपके product को संभालना है। 200 response में भी open work दिख सकता है, जैसे customer tasks या pending review। जब capability किसी ऐसे कारण से requested status तक नहीं पहुँच सकती जिसे आप sandbox में clear नहीं कर सकते, जैसे approval_scope_review_required, कोई operational hold, या terminal status, तब helper 409 capability_status_blocked लौटाता है। Problem का statusReason capability का reason code और message रखता है, साथ में retryable: false। Reason का resolution जानने के लिए capability पढ़ें। किसी named capability को दूसरी बार rejected पर force करने से वही capability बिना बदलाव के लौटती है। किसी rejected capability को restricted या ready पर force करने से 422 invalid_capability लौटता है। उन statuses को test करने के लिए इसके बजाय एक नया sandbox customer बनाएँ।

एक open task का परीक्षण करें

POST /v3/sandbox/tasks के साथ sandbox task बनाएँ। इसे उस resource तक scope करें जिसका workflow आप test कर रहे हैं और customer को क्या submit करना है यह बताने के लिए items का उपयोग करें। यह guide capability और transfer workflows दिखाती है; API Reference customer scope और पूर्ण request schema परिभाषित करती है। Text response के लिए explanation item और file upload के लिए document item उपयोग करें। नए profile items को profilePointer भी चाहिए, जो customer field का JSON Pointer है। अन्य item types और fields के लिए Create sandbox task देखें। Transfer उदाहरण के लिए पहले pay-in या payout flow से sandbox transfer बनाएँ, फिर लौटाए गए data.id को export करें:

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

Capability + 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

Task को समीक्षाधीन transfer तक scope करें और constraints के साथ एक document का अनुरोध करें जो स्वीकृत types, formats, और आयु को सीमित करते हैं।

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

उदाहरण accepted document type, format और age को सीमित करता है। सभी supported document constraints के लिए Create sandbox task देखें।

data.id को TASK_ID, data.revision को TASK_REVISION, और वर्तमान data.requirements[0].id को REQUIREMENT_ID के रूप में store करें। POST /v3/customers/{customerId}/tasks/{taskId}/submissions call करते समय answer को बनाए गए item type से match करें:

Explanation answer
Document answer

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 से matching file upload करें, लौटाए गए data.id को DOCUMENT_ID के रूप में store करें और उसे document answer के रूप में submit करें:

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

फिर वर्तमान submission को 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 द्वारा बनाए गए tasks और Swipelux द्वारा collect किए जाने वाले capability intake tasks को review कर सकते हैं। Operations या किसी अन्य workflow के स्वामित्व वाले task को review करने पर 409 task_not_sandbox_reviewable लौटता है। वह task task endpoints के माध्यम से readable रहता है और अपने owner द्वारा review किए जाने की प्रतीक्षा करता है। 404 task_not_found का अर्थ है कि task ID अज्ञात है या किसी अन्य merchant का है। Production task-completion pattern के लिए Capabilities और tasks का उपयोग करें।

Sandbox wallet को fund करें

एक issued wallet को POST /v3/sandbox/accounts/{accountId}/topup के साथ credit करें:

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

जब आप simulated funding transfer का निरीक्षण करना चाहें, तो लौटाए गए data.id को TRANSFER_ID के रूप में संग्रहीत करें। Topup id एक transfer id है। अपने inbound-deposit code path को sandbox topups के विरुद्ध परीक्षण करने के लिए इसे GET /v3/transfers/{transferId} के माध्यम से fetch करें या GET /v3/transfers के माध्यम से list करें। Transfer projection एक completed inbound stablecoin deposit है जिसमें origin: "inbound_deposit", method: "stablecoin_transfers", और direction: "stablecoin_move" होते हैं, और यह संबंधित accountId, origin, method, और direction list filters द्वारा लौटाया जाता है।

एक transfer को पूरा या fail करें

Outcome को POST /v3/sandbox/transfers/{transferId}/state के साथ सेट करें:

Complete
Fail

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

आगे, sandbox में एक pay-in, payout, या issued bank account flow चलाएँ।

शुरू करें

ग्राहकों को शामिल करें

धन प्रवाह बनाएँ

लॉन्च

Capability readiness का परीक्षण करें

एक open task का परीक्षण करें

Sandbox wallet को fund करें

एक transfer को पूरा या fail करें

​Capability readiness का परीक्षण करें

​एक open task का परीक्षण करें

​Sandbox wallet को fund करें

​एक transfer को पूरा या fail करें

Capability readiness का परीक्षण करें

एक open task का परीक्षण करें

Sandbox wallet को fund करें

एक transfer को पूरा या fail करें