API product catalogTreasury, Cash Management & FX Settlement

Request a credit-limit change

Treasury, Cash Management & FX Settlement

POST

/float

Sandbox availablecreateFloatCreditLimitRequest

Opens a MyStocks treasury review workflow for a partner credit-limit increase or decrease. Requires a full key and Idempotency-Key.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

requestedCreditLimitUsdnumberRequired

Example: 25000

expectedMonthlyVolumeUsdnumber

Example: 500000

reasonstring

Example: "Higher expected deposit volume after launch."

Response fields

requestIdstring

statusstring

Example: "PENDING"

currentCreditLimitUsdnumber

requestedCreditLimitUsdnumber

messagestring

Response codes

201Credit-limit request opened.

409A credit-limit request is already pending.

Request reference

Sandbox available

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/sandbox/v1/partner/float

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "example": "PENDING"
    },
    "currentCreditLimitUsd": {
      "type": "number"
    },
    "requestedCreditLimitUsd": {
      "type": "number"
    },
    "message": {
      "type": "string"
    }
  }
}

curl -X POST 'https://mystocks.africa/api/sandbox/v1/partner/float' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "requestedCreditLimitUsd": 25000,
  "expectedMonthlyVolumeUsd": 500000,
  "reason": "Higher expected deposit volume after launch."
}'

PATCH /float

GET /payout