Get Payout Account
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
get
GET /v1/payments/{account_type}/{account_id}/payout_account 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
{
"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": "2025-07-30T07:56:05.946Z",
"errors": [
{
"id": 1,
"error_code": 1,
"error_message": "text",
"resolved": true,
"date_resolved": "2025-07-30T07:56:05.946Z",
"date_created": "2025-07-30T07:56:05.946Z",
"payout_account_id": 1
}
],
"date_created": "2025-07-30T07:56:05.946Z",
"date_last_modified": "2025-07-30T07:56:05.946Z"
}
Last updated
Was this helpful?