Create a new account

POST

/agents/v1/accounts/{clientId}

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Account created

Bodyapplication/json

🟠400

🟠401Unauthorized

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://demo-api.payswix.com/agents/v1/accounts/' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Payouts"
}'

Response Example

200 - Success

{
    "is_success": true,
    "data": {
        "account": {
            "number": "94643305553",
            "type": 0,
            "clientType": 1,
            "cards": [],
            "status": 6,
            "primary": false,
            "name": "Payouts",
            "provider": {
                "cardIssuer": false,
                "name": "litas_sepa",
                "currency": null,
                "currencies": null,
                "externalId": null
            },
            "providerNumber": null,
            "createdAt": "2026-04-07T10:41:29+00:00",
            "dormant": false,
            "default_fee_activation_date": 0,
            "balances": [],
            "totalEquivalentBalance": null,
            "prohibitedOperations": [],
            "discriminator": 0,
            "clientName": "UAB Baltic Trading",
            "iban": null,
            "beneficiaryType": 2,
            "metadata": [],
            "providerCurrency": "",
            "external": false,
            "dynamicPayment": false,
            "providerRequisites": []
        }
    },
    "message": null
}

Get specific company details

Get all user accounts