API product catalogTreasury, Cash Management & FX Settlement

List payout requests

Treasury, Cash Management & FX Settlement

GET

/payout

Sandbox availablelistPayout

Returns all payout requests from your master wallet.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

payoutsobject[]

payouts[].idstring

payouts[].amountnumber

payouts[].statuspending | approved | rejected

payouts[].createdAtstring

Response codes

200Payout request list.

Sandbox playground

Read-only sandbox request

Sandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "payouts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "rejected"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/payout' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /float

POST /payout