1. Accounts
Payswix | Agents API
  • Finance account
    • Getting started
    • Validation rules
    • Virtual IBANs
      • NACE codes
      • Create vIBAN for person or company
      • Get a list of vIBANs
    • Transactions
      • Create a SEPA transfer
      • Get transfer fee
      • Get all existing recipients
      • Get transaction information
      • Get a filtered list of transactions
    • Companies
      • Get specific company details
    • Accounts
      • Create a new account
        POST
      • Get all user accounts
        GET
      • Get user account information by account number
        GET
    • Other
      • Check if the server is alive
    • Webhooks
      • Transaction webhook
    • Schemas
      • Company vIBAN
      • Person vIBAN
      • Transaction
  • Standard account
    • Transactions
      • Create a SEPA transfer
      • Create a SWIFT transfer
    • Schemas
      • Transaction
  1. Accounts

Get all user accounts

GET
/agents/v1/accounts/{clientId}

Request

Authorization
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
or
Path Params

Responses

🟢200OK
application/json
Returns the user accounts
Bodyapplication/json

🟠401Unauthorized
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://demo-api.payswix.com/agents/v1/accounts/' \
--header 'X-API-KEY: <api-key>'
Response Response Example
200 - Success
{
    "is_success": true,
    "data": {
        "accounts": [
            {
                "number": "59208239802",
                "type": 1,
                "clientType": 1,
                "status": 1,
                "primary": true,
                "name": "Primary account",
                "providerNumber": "LT743880009208239802",
                "createdAt": "2026-04-07T10:21:22+00:00",
                "dormant": false,
                "default_fee_activation_date": 0,
                "balances": [],
                "totalEquivalentBalance": null,
                "prohibitedOperations": [],
                "discriminator": 0,
                "clientName": "UAB Baltic Trading",
                "iban": "LT743880009208239802",
                "beneficiaryType": 2,
                "providerCurrency": "",
                "external": false,
                "dynamicPayment": false,
                "providerRequisites": {
                    "": {
                        "bankCode": null,
                        "bankAccountNumber": "LT173880005087983371"
                    }
                }
            },
            {
                "number": "94643305553",
                "type": 0,
                "clientType": 1,
                "status": 6,
                "primary": false,
                "name": "Payouts",
                "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,
                "providerCurrency": "",
                "external": false,
                "dynamicPayment": false,
                "providerRequisites": []
            }
        ]
    },
    "message": null
}
Previous
Create a new account
Next
Get user account information by account number
Built with