Get all Payout Accounts for a Merchant

Retrieve all payout accounts linked to a specific merchant.

get

Path parameters

account_typestringRequired

account_idinteger · int32Required

Query parameters

extendedbooleanOptionalDefault: false

app_idinteger · int32Optional

App ID used to target the target payout account for merchant account types

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

default

default response

application/json

app_idinteger · int32Optional

Identifier of the application that this merchant payout account is associated with.

app_namestringOptional

Name of the application that this merchant payout account is associated with.

is_migration_originbooleanOptional

Indicates if this payout account is the account from which an active migration is taking place.

is_migration_targetbooleanOptional

Indicates if this payout account is the target account in an ongoing migration process.

get

/payments/{account_type}/{account_id}/payout_accounts

HTTPcURLJavaScriptPython

GET /v1/payments/{account_type}/{account_id}/payout_accounts HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

default

default response

[
  {
    "app_id": 1,
    "app_name": "text",
    "payout_account": {
      "id": 1,
      "account_type": "MERCHANT",
      "account_id": 1,
      "merchant_id": 1,
      "app_id": 1,
      "is_active": true,
      "country_code": "text",
      "payment_provider": "STRIPE",
      "payment_provider_account_id": "text",
      "payment_provider_account_type": "EXPRESS",
      "payment_provider_metadata": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "payment_provider_account": {},
      "date_deactivated": "2026-03-05T20:24:43.706Z",
      "errors": [
        {
          "id": 1,
          "error_code": 1,
          "error_message": "text",
          "resolved": true,
          "date_resolved": "2026-03-05T20:24:43.706Z",
          "date_created": "2026-03-05T20:24:43.706Z",
          "payout_account_id": 1
        }
      ],
      "date_created": "2026-03-05T20:24:43.706Z",
      "date_last_modified": "2026-03-05T20:24:43.706Z"
    },
    "is_migration_origin": true,
    "is_migration_target": true
  }
]