curl --request POST \
--url https://platform.swipelux.com/v3/sandbox/transfers/{transferId}/state \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"state": "completed"
}
'{
"data": {
"id": "<string>",
"customerId": "<string>",
"openTaskIds": [
"<string>"
],
"method": "<string>",
"stateDetail": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"amounts": {
"in": {
"amount": "<string>",
"currency": "<string>"
},
"out": {
"amount": "<string>",
"currency": "<string>"
},
"settled": {
"amount": "<string>",
"currency": "<string>"
}
},
"fees": [
{
"beneficiary": "developer",
"amount": "<string>",
"currency": "<string>",
"rule": {
"fixed": "<string>",
"bips": 123
}
}
],
"source": {
"type": "external"
},
"destination": {
"type": "account",
"id": "<string>"
},
"references": {
"returnedTransferId": "<string>",
"transactionHash": "<string>",
"traceNumber": "<string>",
"imad": "<string>",
"uetr": "<string>",
"explorerUrl": "<string>"
},
"instructions": {
"type": "bank",
"amount": {
"amount": "<string>",
"currency": "<string>"
},
"details": {},
"accountHolderName": "<string>",
"bankName": "<string>",
"reference": {
"value": "<string>",
"required": true
},
"localAmount": {
"amount": "<string>",
"currency": "<string>"
},
"expiresAt": "<string>"
},
"timestamps": {
"createdAt": "<string>",
"updatedAt": "<string>",
"fundsReceivedAt": "<string>",
"completedAt": "<string>",
"failedAt": "<string>",
"returnedAt": "<string>",
"settledAt": "<string>"
},
"quoteId": "<string>",
"capabilityId": "<string>",
"institutionId": "<string>",
"externalId": "<string>",
"memo": "<string>",
"supportingDocuments": [
"<string>"
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}sandbox
Force sandbox transfer state
Forces an existing sandbox transfer to completed or failed.
curl --request POST \
--url https://platform.swipelux.com/v3/sandbox/transfers/{transferId}/state \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"state": "completed"
}
'{
"data": {
"id": "<string>",
"customerId": "<string>",
"openTaskIds": [
"<string>"
],
"method": "<string>",
"stateDetail": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"amounts": {
"in": {
"amount": "<string>",
"currency": "<string>"
},
"out": {
"amount": "<string>",
"currency": "<string>"
},
"settled": {
"amount": "<string>",
"currency": "<string>"
}
},
"fees": [
{
"beneficiary": "developer",
"amount": "<string>",
"currency": "<string>",
"rule": {
"fixed": "<string>",
"bips": 123
}
}
],
"source": {
"type": "external"
},
"destination": {
"type": "account",
"id": "<string>"
},
"references": {
"returnedTransferId": "<string>",
"transactionHash": "<string>",
"traceNumber": "<string>",
"imad": "<string>",
"uetr": "<string>",
"explorerUrl": "<string>"
},
"instructions": {
"type": "bank",
"amount": {
"amount": "<string>",
"currency": "<string>"
},
"details": {},
"accountHolderName": "<string>",
"bankName": "<string>",
"reference": {
"value": "<string>",
"required": true
},
"localAmount": {
"amount": "<string>",
"currency": "<string>"
},
"expiresAt": "<string>"
},
"timestamps": {
"createdAt": "<string>",
"updatedAt": "<string>",
"fundsReceivedAt": "<string>",
"completedAt": "<string>",
"failedAt": "<string>",
"returnedAt": "<string>",
"settledAt": "<string>"
},
"quoteId": "<string>",
"capabilityId": "<string>",
"institutionId": "<string>",
"externalId": "<string>",
"memo": "<string>",
"supportingDocuments": [
"<string>"
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}Authorizations
Your Swipelux API key. Obtain this from the Swipelux Dashboard.
Path Parameters
Body
application/json
Response
Sandbox transfer state forced
Show child attributes
Show child attributes
Related topics
Force sandbox capability statusSandboxCredit a sandbox accountCreate sandbox taskReview sandbox task submission⌘I