GET
/
payments
/
{account_type}
/
{account_id}
/
payout_account
curl --request GET \
  --url https://sandbox-api.violet.io/v1/payments/{account_type}/{account_id}/payout_account
{
  "id": 123,
  "account_type": "MERCHANT",
  "account_id": 123,
  "merchant_id": 123,
  "app_id": 123,
  "is_active": true,
  "country_code": "<string>",
  "payment_provider": "STRIPE",
  "payment_provider_account_id": "<string>",
  "payment_provider_account_type": "EXPRESS",
  "payment_provider_metadata": {},
  "payment_provider_account": {},
  "date_deactivated": "2023-11-07T05:31:56Z",
  "errors": [
    {
      "id": 123,
      "error_code": 123,
      "error_message": "<string>",
      "resolved": true,
      "date_resolved": "2023-11-07T05:31:56Z",
      "date_created": "2023-11-07T05:31:56Z",
      "payout_account_id": 123
    }
  ],
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z"
}

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

account_type
string
required
account_id
integer
required

Query Parameters

extended
boolean
default:false
fetch_migrated_account
boolean
default:false

Indicate whether to fetch the analogous in-progress migration account instead

app_id
integer

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

Response

default - application/json
default response

Violet Payout Account that stores underlying payment provider account information to be used for disbursing funds during Order processing.