Force sandbox capability status

Forces a sandbox capability to ready, rejected, or restricted.

cURL

ready

curl --request POST \
  --url https://platform.swipelux.com/v3/sandbox/customers/{customerId}/capabilities/{capabilityId}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "ready"
}
'

200

{
  "data": {
    "id": "<string>",
    "customerId": "<string>",
    "method": "ach",
    "accountType": "pooled",
    "status": "ready",
    "openTaskIds": [
      "<string>"
    ],
    "applications": [
      {
        "id": "<string>",
        "institution": {
          "id": "<string>",
          "name": "<string>",
          "bic": "<string>"
        },
        "status": "requested",
        "statusReason": {
          "code": "<string>",
          "message": "<string>",
          "actor": "customer",
          "retryable": true
        },
        "openTaskIds": [
          "<string>"
        ],
        "submittedAt": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "submittedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "statusReason": "<unknown>"
  }
}

Authorizations

X-API-Key · string · header · required

Path Parameters

customerId · string · required

capabilityId · string · required

Body

application/json

status · enum<string> · required

Capability status implemented by the sandbox simulator.

Available options: ready, rejected, restricted

Response

200

application/json

Sandbox capability status forced

data · object · required

Capability.

Option 1

Option 2

Show child attributes