Proves de sandbox

El sandbox utilitza el mateix host d’API que la producció. Una clau d’API de sandbox selecciona l’entorn de proves, on els helpers simulen resultats sense moure fons reals. Manté la clau al teu backend. Els helpers de sandbox no substitueixen el compliment ni la incorporació de producció. Utilitza Errors i reintents per provar com la teva integració gestiona les fallades de validació, d’estat i de plataforma reintenables retornades per les operacions del sandbox.

Environment variables

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

Prova la preparació d’una capacitat

Al sandbox, les capacitats ACH, Wire i SWIFT, tant amb nom com agrupades, només es serveixen a JPMorgan Chase (jpmorgan). Omet institutions quan sol·licitis una d’aquestes capacitats i Swipelux selecciona jpmorgan. Indicar qualsevol altre banc retorna 422 capability_institutions_unsupported. La llista de capacitats admeses al sandbox només mostra jpmorgan per a aquests mètodes. L’encaminament de producció i altres mètodes, com RTP, Pix i SPEI, no canvien.

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

Després de sol·licitar una capacitat, estableix el seu estat al sandbox amb 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"}'

Torna a obtenir la capacitat després d’utilitzar el helper. Tracta el seu status i openTaskIds actuals com el resultat que el teu producte ha de gestionar. Una resposta 200 encara pot mostrar treball obert, com ara tasques del client o una revisió pending. El helper retorna 409 capability_status_blocked quan la capacitat no pot arribar a l’estat sol·licitat per un motiu que no pots resoldre al sandbox, com ara approval_scope_review_required, una retenció operativa o un estat terminal. El statusReason del problema inclou el codi i el missatge del motiu de la capacitat, amb retryable: false. Llegeix la capacitat per obtenir la resolution del motiu. Forçar una capacitat amb nom a rejected una segona vegada retorna la mateixa capacitat sense canvis. Forçar una capacitat rebutjada a restricted o ready retorna 422 invalid_capability. Crea un client de sandbox nou per provar aquests estats.

Prova una tasca oberta

Crea una tasca de sandbox amb POST /v3/sandbox/tasks. Assigna-la al recurs del flux de treball que estàs provant i utilitza items per descriure què ha d’enviar el client. Aquesta guia mostra fluxos de capacitat i transferència; la Referència de l’API defineix l’àmbit de client i l’esquema complet de la sol·licitud. Utilitza un element explanation per a una resposta de text i un element document per a una càrrega. Els elements profile nous també requereixen profilePointer, un punter JSON que identifica el camp del client. Consulta Crear tasca de sandbox per als altres tipus d’elements i camps. Per a l’exemple de transferència, primer crea una transferència de sandbox mitjançant un flux d’ingrés o de pagament i després exporta el seu data.id:

Transfer ID

export TRANSFER_ID='tr_replace_with_your_transfer_id'

Capacitat + explicació
RFI de transferència + 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

Estableix l’àmbit de la tasca a la transferència en revisió i sol·licita un document amb constraints que restringeixin els tipus, formats i antiguitat acceptats.

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

L’exemple limita el tipus, el format i l’antiguitat acceptats del document. Consulta Crear tasca de sandbox per a totes les restriccions de document admeses.

Emmagatzema data.id com a TASK_ID, data.revision com a TASK_REVISION i l’actual data.requirements[0].id com a REQUIREMENT_ID. Quan cridis POST /v3/customers/{customerId}/tasks/{taskId}/submissions, fes coincidir la resposta amb l’element que has creat:

Resposta d'explicació
Resposta de 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-submission-001" \
  --header "Content-Type: application/json" \
  --data @- <<JSON
{
  "taskRevision": ${TASK_REVISION},
  "answers": [
    {
      "requirementId": "${REQUIREMENT_ID}",
      "answer": {
        "type": "text",
        "value": "Sandbox requirement completed."
      }
    }
  ]
}
JSON

Puja un fitxer que compleixi els requisits amb POST /v3/customers/{customerId}/documents, desa el data.id retornat com a DOCUMENT_ID i envia’l com a resposta de document:

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

A continuació, accepta o rebutja l’enviament actual amb 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"}'

Pots revisar les tasques creades per POST /v3/sandbox/tasks i les tasques d’admissió de capacitats que Swipelux recull. Revisar una tasca que pertany a Operacions o a un altre flux de treball retorna 409 task_not_sandbox_reviewable. Aquesta tasca continua sent llegible mitjançant els endpoints de tasques i espera que el seu propietari la revisi. 404 task_not_found vol dir que l’ID de tasca és desconegut o pertany a un altre comerciant. Utilitza Capacitats i tasques per al patró de compleció de tasques en producció.

Finança una cartera de sandbox

Acredita una cartera emesa amb 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"}'

Emmagatzema el data.id retornat com a TRANSFER_ID quan vulguis inspeccionar la transferència de finançament simulada. L’id del topup és un id de transferència. Recupera’l mitjançant GET /v3/transfers/{transferId} o llista’l mitjançant GET /v3/transfers per exercir el teu codi de dipòsit entrant contra els topups del sandbox. La projecció de la transferència és un dipòsit entrant d’stablecoin completat amb origin: "inbound_deposit", method: "stablecoin_transfers" i direction: "stablecoin_move", i es retorna pels filtres de llista coincidents accountId, origin, method i direction.

Completa o falla una transferència

Estableix el resultat amb POST /v3/sandbox/transfers/{transferId}/state:

Completar
Fallar

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

A continuació, executa un flux de cobrament, pagament o compte bancari emès al sandbox.

Comença aquí

Incorpora clients

Construeix fluxos de diners

Llança

Proves de sandbox

Prova la preparació d’una capacitat

Prova una tasca oberta

Finança una cartera de sandbox

Completa o falla una transferència

​Prova la preparació d’una capacitat

​Prova una tasca oberta

​Finança una cartera de sandbox

​Completa o falla una transferència

Prova la preparació d’una capacitat

Prova una tasca oberta

Finança una cartera de sandbox

Completa o falla una transferència