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"
}
'{
"data": {
"id": "<string>",
"customerId": "<string>",
"method": "ach",
"accountType": "pooled",
"accountProvisioning": "not_applicable",
"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>"
}
}{
"type": "https://docs.swipelux.com/errors/validation-error",
"title": "<string>",
"status": 400,
"code": "validation_error",
"detail": "<string>",
"correlationId": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/unauthorized",
"title": "<string>",
"status": 401,
"code": "unauthorized",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/forbidden",
"title": "<string>",
"status": 403,
"code": "forbidden",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/not-found",
"title": "<string>",
"status": 404,
"code": "not_found",
"detail": "<string>",
"correlationId": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/capability-application-stale",
"title": "<string>",
"status": 409,
"code": "capability_application_stale",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"transferId": "<string>",
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"actor": "customer",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"type": "account",
"id": "<string>",
"requiredAction": "archive_account"
}
]
}{
"type": "https://docs.swipelux.com/errors/invalid-capability",
"title": "<string>",
"status": 422,
"code": "invalid_capability",
"detail": "<string>",
"correlationId": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/internal-error",
"title": "<string>",
"status": 500,
"code": "internal_error",
"detail": "<string>",
"correlationId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"transferId": "<string>",
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"actor": "customer",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"type": "account",
"id": "<string>",
"requiredAction": "archive_account"
}
]
}Sandbox
Force sandbox capability status
Forces a sandbox capability to ready, rejected, or restricted, then returns the resulting capability; its status and statusReason show customer tasks still to complete or a review still underway. When a simulated shared case cannot bring the capability to the requested status for any other reason, such as approval_scope_review_required, the route returns 409 capability_status_blocked with that statusReason. The simulated case outcome stays recorded.
POST
/
v3
/
sandbox
/
customers
/
{customerId}
/
capabilities
/
{capabilityId}
/
status
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"
}
'{
"data": {
"id": "<string>",
"customerId": "<string>",
"method": "ach",
"accountType": "pooled",
"accountProvisioning": "not_applicable",
"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>"
}
}{
"type": "https://docs.swipelux.com/errors/validation-error",
"title": "<string>",
"status": 400,
"code": "validation_error",
"detail": "<string>",
"correlationId": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/unauthorized",
"title": "<string>",
"status": 401,
"code": "unauthorized",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/forbidden",
"title": "<string>",
"status": 403,
"code": "forbidden",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/not-found",
"title": "<string>",
"status": 404,
"code": "not_found",
"detail": "<string>",
"correlationId": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/capability-application-stale",
"title": "<string>",
"status": 409,
"code": "capability_application_stale",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"transferId": "<string>",
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"actor": "customer",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"type": "account",
"id": "<string>",
"requiredAction": "archive_account"
}
]
}{
"type": "https://docs.swipelux.com/errors/invalid-capability",
"title": "<string>",
"status": 422,
"code": "invalid_capability",
"detail": "<string>",
"correlationId": "<string>",
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/internal-error",
"title": "<string>",
"status": 500,
"code": "internal_error",
"detail": "<string>",
"correlationId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"transferId": "<string>",
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"actor": "customer",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"type": "account",
"id": "<string>",
"requiredAction": "archive_account"
}
]
}Authorizations
Your Swipelux API key. Obtain this from the Swipelux Dashboard.
Body
application/json
Capability status implemented by the sandbox simulator.
Available options:
ready, rejected, restricted Response
Sandbox capability status forced
Capability.
- Option 1
- Option 2
Show child attributes
Show child attributes