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.

​
id
integer

Unique identifier for the object

​
account_type
enum<string>

Type of the account entity in Violet. This is either DEVELOPER or MERCHANT.

Available options:
MERCHANT,
DEVELOPER,
DEVELOPER,
MERCHANT
​
account_id
integer

Identifier of the account entity in Violet. This is either the Violet developer or merchant identifier.

​
merchant_id
integer

Identifier of the merchant entity in Violet.

​
app_id
integer

Identifier of the app entity in Violet that this Payout Account is associated with.

​
is_active
boolean

Field that denotes whether or not this Payout Account is active and being used for transactions. Only one Payout Account may be active for a merchant-app combination at a given point in time.

​
country_code
string

Two-letter country code of the bank that this Payout Account is associated to.

​
payment_provider
enum<string>

Payment Provider that the underlying payout account was created in. This is the provider that handles payment and payout processing for this entity.

Available options:
STRIPE,
NUVEI,
CREDOVA,
EXTERNAL
​
payment_provider_account_id
string

Identifier of the payout account in the payment provider system.

​
payment_provider_account_type
enum<string>

Type of account in the external payment provider. This field may not be present if the underlying payment provider does not have multiple account types.

Available options:
EXPRESS,
CUSTOM,
STANDARD,
PLATFORM
​
payment_provider_metadata
object

Metadata from the payment provider associated to this payout account.

​
payment_provider_account
object

Details about the underlying payout account in the payment provider.

​
date_deactivated
string

Time at which this payout account was deactivated. In ISO-8601 format.

​
errors
object[]

List of errors associated with this payout account. Not all errors block transacting on this payout account.

Error associated to a Payout Account

​
date_created
string

Time at which the object was created. In ISO-8601 format.

​
date_last_modified
string

Time at which the object was last modified. In ISO-8601 format.

Was this page helpful?