Force sandbox transfer state

Forces an existing sandbox transfer to completed or failed.

cURL

completed

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

200

{
  "data": {
    "id": "<string>",
    "origin": "quoted",
    "customerId": "<string>",
    "openTaskIds": [
      "<string>"
    ],
    "method": "<string>",
    "direction": "fiat_to_stablecoin",
    "state": "awaiting_funds",
    "stateDetail": {
      "code": "<string>",
      "message": "<string>",
      "actor": "customer",
      "retryable": true
    },
    "amounts": {
      "in": {
        "amount": "<string>",
        "currency": "<string>",
        "network": "polygon"
      },
      "out": {
        "amount": "<string>",
        "currency": "<string>",
        "network": "polygon"
      },
      "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",
      "method": "ach",
      "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>"
    ]
  }
}

Authorizations

X-API-Key · string · header · required

Path Parameters

transferId · string · required

Body

application/json

state · enum<string> · required

Transfer state implemented by the sandbox simulator.

Available options: completed, failed

stateDetail · object

Optional failure detail. Applied only when forcing a payin transfer to failed; ignored for completed states and payout transfers.

Show child attributes

Response

200

application/json

Sandbox transfer state forced

data · object · required

Show child attributes