Welcome to Xendit’s latest documentation. For legacy content, access the previous documentation here or the previous API reference here.

Get Account

Prev Next
Get
/v2/accounts/{id}

The Get Account API allows you to retrieve a sub-account's information.

Security
HTTP
Type basic
Path parameters
id
stringRequired
Example5cafeb170a2b18519b1b8761
Responses
200
Owned Sub-account
{
  "id": "5cafeb170a2b18519b1b8761",
  "created": "2021-01-01T10:00:00Z",
  "updated": "2021-01-01T10:00:00Z",
  "type": "OWNED",
  "email": "angie@pinkpanther.com",
  "public_profile": {
    "business_name": "Angie's lemonade stand"
  },
  "status": "LIVE"
}
Custom Sub-account
{
  "id": "5cafeb170a2b18519b1b8761",
  "created": "2021-01-01T10:00:00Z",
  "updated": "2021-01-01T10:00:00Z",
  "type": "CUSTOM",
  "email": "angie@pinkpanther.com",
  "public_profile": {
    "business_name": "Angie's customized stand"
  },
  "status": "LIVE",
  "configurations": {
    "has_dashboard": true,
    "payment_settings_follow_platform": true,
    "has_withdrawal": false
  }
}
Expand All
object
id
string

ID of your Account, use this in the for-user-id header to create transactions on behalf of your Account

created
string

Timestamp of when the object was created

updated
string

Timestamp of when the object was updated

type
string

The type of account created

Valid values[ "MANAGED", "OWNED", "CUSTOM" ]
email
string (email)

A valid email address associated with the object

Max length255
Exampletest@example.co
public_profile
object (xenPlatform_public_profile)
name
string

Public name of the account.

description
string

Additional description visible publicly.

country
string

The country (based on ISO 3166-1 Alpha-2) of incorporation for a business, or the country of residence for an individual.

Valid values[ "ID", "PH", "VN", "MY", "TH" ]
status
string

Status of the Account you are creating.

Valid values[ "INVITED", "REGISTERED", "AWAITING_DOCS", "LIVE", "SUSPENDED" ]
configurations
object (xenPlatform_configurations)

Contains the configurations for CUSTOM sub-accounts. Parameters available: payment_settings_follow_platform, has_withdrawal, has_dashboard

payment_settings_follow_platform
boolean

Indicates if payment settings follow the platform.

has_withdrawal
boolean

Indicates if the account has withdrawal enabled.

has_dashboard
boolean

Indicates if the account has access to the dashboard.

404

Not found error

DATA_NOT_FOUND
{
  "error_code": "DATA_NOT_FOUND",
  "message": "Could not find payout with the corresponding ID. Please try again with a valid ID.",
  "errors": [
    "Detailed description here"
  ]
}
object

The object being referenced does not exist

error_code
string
Valid values[ "DESTINATION_ACCOUNT_NOT_FOUND", "DATA_NOT_FOUND" ]
message
string
errors
Array
OneOf
string
string
object
object