The Account object

This is an object representing a Zoneless account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to receive transfers and USDC payouts to their Solana wallet.

Stripe API equivalent
ENDPOINTS
POST /v1/accounts
POST /v1/accounts/:id
GET /v1/accounts/:id
GET /v1/accounts
DELETE /v1/accounts/:id
POST /v1/accounts/:id/reject
Key concept: Zoneless accounts receive USDC payouts to their Solana wallet. Create an account for each seller/recipient on your platform, then send them payouts.

Attributes

id string

Unique identifier for the object. Zoneless account IDs are prefixed with acct_z_.

object string

String representing the object's type. Objects of the same type share the same value.

business_profilenullable object

Business information about the account.

business_typenullable enum

The business type. Most connected accounts are individual.

Possible enum values
individualA person selling goods or services.
companyA registered business entity.
capabilitiesnullable object

A hash containing the set of capabilities that was requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

Difference from Stripe: Zoneless has two capabilities: transfers and usdc_payouts. Stripe's payment method capabilities (card_payments, etc.) are not applicable since Zoneless uses USDC on Solana.

charges_enabled boolean

Whether the account can receive charges/payments. Defaults to false until the account completes onboarding.

Difference from Stripe: In Stripe, this indicates whether the account can process card payments. In Zoneless, this field is retained for API compatibility but is less relevant since Zoneless handles USDC payouts rather than card processing.

controllernullable object

Configuration for who manages the account. For Express accounts, this is automatically configured.

country string

The account's country.

created timestamp

Time at which the account was connected. Measured in seconds since the Unix epoch.

default_currency string

The default currency for the account. For Zoneless accounts, this is always usdc.

Difference from Stripe: Always usdc instead of fiat currency codes like usd.

details_submitted boolean

Whether account details have been submitted. Accounts with Zoneless Dashboard access, which includes Express accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.

emailnullable string

An email address associated with the account. It's not used for authentication. This field is available for the platform to use for communication purposes.

external_accounts object

External accounts (Solana wallets) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true.

Difference from Stripe: Contains Solana wallet addresses instead of bank accounts and debit cards. These wallets receive USDC payouts.

future_requirementsnullable object

Details about the upcoming new requirements for the account, including what information needs to be collected, verified, or reviewed, and by when.

individualnullable object

Information about the person represented by the account. This property is null unless business_type is set to individual. After you create an Account Link to start Zoneless Onboarding, only a subset of this property is returned for accounts where controller.requirement_collection is zoneless, which includes Express accounts.

metadatanullable object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

payouts_enabled boolean

Whether the funds in this account can be paid out.

platform_account string

The platform account that owns this account. For connected accounts, this is the platform's account ID. For platform accounts, this is self-referential (equals the account's own id).

Zoneless extension: This field is not present in Stripe's API. It enables multi-tenant operation where multiple platforms can each have their own connected accounts.

requirementsnullable object

Details about the requirements for the account, including what information needs to be collected, verified, or reviewed, and by when. After a requirement is collected, verified, or reviewed, it is considered resolved. Most requirements can be addressed programmatically, however, some must be completed through a form or challenge using the Zoneless Interface.

More attributes

THE ACCOUNT OBJECT
{
  "id": "acct_z_1Nv0FGQ9RKHgCVdK",
  "object": "account",
  "business_profile": {
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null
  },
  "business_type": "individual",
  "capabilities": {
    "transfers": "pending",
    "usdc_payouts": "pending"
  },
  "charges_enabled": false,
  "controller": {
    "fees": {
      "payer": "application_express"
    },
    "is_controller": true,
    "losses": {
      "payments": "application"
    },
    "requirement_collection": "zoneless",
    "zoneless_dashboard": {
      "type": "express"
    },
    "type": "application"
  },
  "country": "US",
  "created": 1704067200,
  "default_currency": "usdc",
  "details_submitted": false,
  "email": "seller@example.com",
  "external_accounts": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "individual": {
    "id": "person_z_1Nv0FGQ9RKHgCVdK",
    "object": "person",
    "account": "acct_z_1Nv0FGQ9RKHgCVdK",
    "address": null,
    "created": 1704067200,
    "dob": null,
    "email": "seller@example.com",
    "first_name": null,
    "future_requirements": null,
    "id_number_provided": false,
    "last_name": null,
    "metadata": {},
    "phone": null,
    "relationship": {
      "representative": true
    },
    "requirements": null,
    "ssn_last_4_provided": false,
    "verification": {
      "additional_document": null,
      "details": null,
      "details_code": null,
      "document": {
        "back": null,
        "details": null,
        "details_code": null,
        "front": null
      },
      "status": "unverified"
    }
  },
  "login_links": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../login_links"
  },
  "metadata": {},
  "payouts_enabled": false,
  "platform_account": "acct_z_Platform123abc",
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "pending_verification": []
  },
  "settings": {
    "branding": {
      "icon": null,
      "logo": null,
      "primary_color": null,
      "secondary_color": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "payouts": {
      "debit_negative_balances": true,
      "schedule": {
        "delay_days": 2,
        "interval": "daily"
      },
      "statement_descriptor": null
    }
  },
  "tos_acceptance": {
    "date": null,
    "ip": null,
    "service_agreement": null,
    "user_agent": null
  },
  "type": "express"
}

Create an account

With Zoneless, you can create accounts for your users. To do this, you'll first need to register your platform.

ENDPOINTS
POST /v1/accounts
Quick start: For most use cases, you only need to provide country and email. Zoneless will handle the rest via the onboarding flow.

Parameters

business_profile object

Business information about the account.

business_type enum

The business type. Most connected accounts are individual.

Possible enum values
individualA person selling goods or services.
companyA registered business entity.
capabilities object

The capabilities requested for this account and their status. Capabilities become active after the account completes onboarding.

controller object

Configuration for account control. For most Express accounts, you can omit this—sensible defaults are applied.

country string

The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use CA as the country for the account being created.

default_currency string

Three-letter ISO currency code representing the default currency for the account. For Zoneless accounts, this is typically usdc.

Difference from Stripe: Defaults to usdc instead of fiat currency codes.

email string

The email address of the account holder. This is only to make the account easier to identify to you. The platform controls all communication with connected accounts.

metadata object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More attributes

Returns

Returns an Account object if the call succeeds.

POST/v1/accounts
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.yourdomain.com');

const account = await zoneless.accounts.create({
  country: 'US',
  email: 'tom.jones@example.com',
  controller: {
    losses: { payments: 'application' },
    zoneless_dashboard: { type: 'express' },
  },
});
RESPONSE
{
  "id": "acct_z_1Nv0FGQ9RKHgCVdK",
  "object": "account",
  "business_profile": {
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null
  },
  "business_type": "individual",
  "capabilities": {
    "transfers": "pending",
    "usdc_payouts": "pending"
  },
  "charges_enabled": false,
  "controller": {
    "fees": {
      "payer": "application_express"
    },
    "is_controller": true,
    "losses": {
      "payments": "application"
    },
    "requirement_collection": "zoneless",
    "zoneless_dashboard": {
      "type": "express"
    },
    "type": "application"
  },
  "country": "US",
  "created": 1704067200,
  "default_currency": "usdc",
  "details_submitted": false,
  "email": "seller@example.com",
  "external_accounts": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "individual": {
    "id": "person_z_1Nv0FGQ9RKHgCVdK",
    "object": "person",
    "account": "acct_z_1Nv0FGQ9RKHgCVdK",
    "address": null,
    "created": 1704067200,
    "dob": null,
    "email": "seller@example.com",
    "first_name": null,
    "future_requirements": null,
    "id_number_provided": false,
    "last_name": null,
    "metadata": {},
    "phone": null,
    "relationship": {
      "representative": true
    },
    "requirements": null,
    "ssn_last_4_provided": false,
    "verification": {
      "additional_document": null,
      "details": null,
      "details_code": null,
      "document": {
        "back": null,
        "details": null,
        "details_code": null,
        "front": null
      },
      "status": "unverified"
    }
  },
  "login_links": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../login_links"
  },
  "metadata": {},
  "payouts_enabled": false,
  "platform_account": "acct_z_Platform123abc",
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "pending_verification": []
  },
  "settings": {
    "branding": {
      "icon": null,
      "logo": null,
      "primary_color": null,
      "secondary_color": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "payouts": {
      "debit_negative_balances": true,
      "schedule": {
        "delay_days": 2,
        "interval": "daily"
      },
      "statement_descriptor": null
    }
  },
  "tos_acceptance": {
    "date": null,
    "ip": null,
    "service_agreement": null,
    "user_agent": null
  },
  "type": "express"
}

Update an account

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

ENDPOINTS
POST /v1/accounts/:id

Parameters

business_profile object

Business information about the account.

business_type enum

The business type. Most connected accounts are individual.

Possible enum values
individualA person selling goods or services.
companyA registered business entity.
capabilities object

The capabilities requested for this account and their status. Capabilities become active after the account completes onboarding.

default_currency string

Three-letter ISO currency code representing the default currency for the account. For Zoneless accounts, this is typically usdc.

Difference from Stripe: Defaults to usdc instead of fiat currency codes.

email string

The email address of the account holder. This is only to make the account easier to identify to you. The platform controls all communication with connected accounts.

metadata object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More attributes

Returns

Returns an Account object if the call succeeds. If the account ID does not exist or another issue occurs, this call raises an error. Some validations will not raise an error but will instead populate the requirements.errors array.

POST/v1/accounts/:id
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.yourdomain.com');

const account = await zoneless.accounts.update(
  'acct_z_1Nv0FGQ9RKHgCVdK',
  {
    metadata: {
      order_id: '6735',
    },
  }
);
RESPONSE
{
  "id": "acct_z_1Nv0FGQ9RKHgCVdK",
  "object": "account",
  "business_profile": {
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null
  },
  "business_type": "individual",
  "capabilities": {
    "transfers": "pending",
    "usdc_payouts": "pending"
  },
  "charges_enabled": false,
  "controller": {
    "fees": {
      "payer": "application_express"
    },
    "is_controller": true,
    "losses": {
      "payments": "application"
    },
    "requirement_collection": "zoneless",
    "zoneless_dashboard": {
      "type": "express"
    },
    "type": "application"
  },
  "country": "US",
  "created": 1704067200,
  "default_currency": "usdc",
  "details_submitted": false,
  "email": "seller@example.com",
  "external_accounts": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "individual": {
    "id": "person_z_1Nv0FGQ9RKHgCVdK",
    "object": "person",
    "account": "acct_z_1Nv0FGQ9RKHgCVdK",
    "address": null,
    "created": 1704067200,
    "dob": null,
    "email": "seller@example.com",
    "first_name": null,
    "future_requirements": null,
    "id_number_provided": false,
    "last_name": null,
    "metadata": {},
    "phone": null,
    "relationship": {
      "representative": true
    },
    "requirements": null,
    "ssn_last_4_provided": false,
    "verification": {
      "additional_document": null,
      "details": null,
      "details_code": null,
      "document": {
        "back": null,
        "details": null,
        "details_code": null,
        "front": null
      },
      "status": "unverified"
    }
  },
  "login_links": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../login_links"
  },
  "metadata": {
    "order_id": "6735"
  },
  "payouts_enabled": false,
  "platform_account": "acct_z_Platform123abc",
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "pending_verification": []
  },
  "settings": {
    "branding": {
      "icon": null,
      "logo": null,
      "primary_color": null,
      "secondary_color": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "payouts": {
      "debit_negative_balances": true,
      "schedule": {
        "delay_days": 2,
        "interval": "daily"
      },
      "statement_descriptor": null
    }
  },
  "tos_acceptance": {
    "date": null,
    "ip": null,
    "service_agreement": null,
    "user_agent": null
  },
  "type": "express"
}

Retrieve account

Retrieves the details of an account.

ENDPOINTS
GET /v1/accounts/:id

Parameters

No parameters.

Returns

Returns an Account object if the call succeeds. If the account ID does not exist, this call raises an error.

GET/v1/accounts/:id
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.yourdomain.com');

const account = await zoneless.accounts.retrieve('acct_z_1Nv0FGQ9RKHgCVdK');
RESPONSE
{
  "id": "acct_z_1Nv0FGQ9RKHgCVdK",
  "object": "account",
  "business_profile": {
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null
  },
  "business_type": "individual",
  "capabilities": {
    "transfers": "pending",
    "usdc_payouts": "pending"
  },
  "charges_enabled": false,
  "controller": {
    "fees": {
      "payer": "application_express"
    },
    "is_controller": true,
    "losses": {
      "payments": "application"
    },
    "requirement_collection": "zoneless",
    "zoneless_dashboard": {
      "type": "express"
    },
    "type": "application"
  },
  "country": "US",
  "created": 1704067200,
  "default_currency": "usdc",
  "details_submitted": false,
  "email": "seller@example.com",
  "external_accounts": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "individual": {
    "id": "person_z_1Nv0FGQ9RKHgCVdK",
    "object": "person",
    "account": "acct_z_1Nv0FGQ9RKHgCVdK",
    "address": null,
    "created": 1704067200,
    "dob": null,
    "email": "seller@example.com",
    "first_name": null,
    "future_requirements": null,
    "id_number_provided": false,
    "last_name": null,
    "metadata": {},
    "phone": null,
    "relationship": {
      "representative": true
    },
    "requirements": null,
    "ssn_last_4_provided": false,
    "verification": {
      "additional_document": null,
      "details": null,
      "details_code": null,
      "document": {
        "back": null,
        "details": null,
        "details_code": null,
        "front": null
      },
      "status": "unverified"
    }
  },
  "login_links": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../login_links"
  },
  "metadata": {},
  "payouts_enabled": false,
  "platform_account": "acct_z_Platform123abc",
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.mcc",
      "business_profile.url",
      "external_account",
      "individual.first_name",
      "individual.last_name",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "pending_verification": []
  },
  "settings": {
    "branding": {
      "icon": null,
      "logo": null,
      "primary_color": null,
      "secondary_color": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "payouts": {
      "debit_negative_balances": true,
      "schedule": {
        "delay_days": 2,
        "interval": "daily"
      },
      "statement_descriptor": null
    }
  },
  "tos_acceptance": {
    "date": null,
    "ip": null,
    "service_agreement": null,
    "user_agent": null
  },
  "type": "express"
}

List all connected accounts

Returns a list of accounts connected to your platform via Zoneless. This endpoint requires a platform API key.

ENDPOINTS
GET /v1/accounts

Parameters

No required parameters.

More attributes

Returns

A dictionary with a data property that contains an array of up to limit accounts, starting after account starting_after. Each entry in the array is a separate Account object. If no more accounts are available, the resulting array is empty.

GET/v1/accounts
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.yourdomain.com');

const accounts = await zoneless.accounts.list({
  limit: 3,
});
RESPONSE
{
  "object": "list",
  "url": "/v1/accounts",
  "has_more": false,
  "data": [
    {
      "id": "acct_z_1Nv0FGQ9RKHgCVdK",
      "object": "account",
      "business_profile": {
        "mcc": null,
        "name": null,
        "product_description": null,
        "support_email": null,
        "support_phone": null,
        "support_url": null,
        "url": null
      },
      "business_type": "individual",
      "capabilities": {
        "transfers": "pending",
        "usdc_payouts": "pending"
      },
      "charges_enabled": false,
      "controller": {
        "fees": {
          "payer": "application_express"
        },
        "is_controller": true,
        "losses": {
          "payments": "application"
        },
        "requirement_collection": "zoneless",
        "zoneless_dashboard": {
          "type": "express"
        },
        "type": "application"
      },
      "country": "US",
      "created": 1704067200,
      "default_currency": "usdc",
      "details_submitted": false,
      "email": "seller@example.com",
      "future_requirements": {
        "alternatives": [],
        "current_deadline": null,
        "currently_due": [],
        "disabled_reason": null,
        "errors": [],
        "eventually_due": [],
        "past_due": [],
        "pending_verification": []
      },
      "metadata": {},
      "payouts_enabled": false,
      "platform_account": "acct_z_Platform123abc",
      "requirements": {
        "alternatives": [],
        "current_deadline": null,
        "currently_due": [
          "business_profile.mcc",
          "business_profile.url",
          "external_account",
          "individual.first_name",
          "individual.last_name",
          "tos_acceptance.date",
          "tos_acceptance.ip"
        ],
        "disabled_reason": "requirements.past_due",
        "errors": [],
        "eventually_due": [
          "business_profile.mcc",
          "business_profile.url",
          "external_account",
          "individual.first_name",
          "individual.last_name",
          "tos_acceptance.date",
          "tos_acceptance.ip"
        ],
        "past_due": [],
        "pending_verification": []
      },
      "settings": {
        "branding": {
          "icon": null,
          "logo": null,
          "primary_color": null,
          "secondary_color": null
        },
        "dashboard": {
          "display_name": null,
          "timezone": "Etc/UTC"
        },
        "payouts": {
          "debit_negative_balances": true,
          "schedule": {
            "delay_days": 2,
            "interval": "daily"
          },
          "statement_descriptor": null
        }
      },
      "tos_acceptance": {
        "date": null,
        "ip": null,
        "service_agreement": null,
        "user_agent": null
      },
      "type": "express"
    }
  ]
}

Delete an account

With Zoneless, you can delete accounts you manage.

ENDPOINTS
DELETE /v1/accounts/:id

Parameters

No parameters.

Returns

Returns an object with a deleted parameter if the call succeeds. If the account ID does not exist, this call raises an error.

DELETE/v1/accounts/:id
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.yourdomain.com');

const deleted = await zoneless.accounts.del('acct_z_1Nv0FGQ9RKHgCVdK');
RESPONSE
{
  "id": "acct_z_1Nv0FGQ9RKHgCVdK",
  "object": "account",
  "deleted": true
}

Reject an account

With Zoneless, you can reject accounts that you have flagged as suspicious. Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Accounts can only be rejected after all balances are zero.

ENDPOINTS
POST /v1/accounts/:id/reject

Parameters

reason enum Required

The reason for rejecting the account. This will be stored in requirements.disabled_reason as rejected.{reason}.

Possible enum values
fraudThe account was rejected due to suspected fraud.
terms_of_serviceThe account violated the terms of service.
otherThe account was rejected for another reason.

Returns

Returns an Account object with payouts_enabled and charges_enabled set to false on success. The requirements.disabled_reason will be set to rejected.{reason} (e.g., rejected.fraud). If the account ID does not exist, this call raises an error.

POST/v1/accounts/:id/reject
import { Zoneless } from '@zoneless/node';
const zoneless = new Zoneless('sk_live_z_YOUR_API_KEY', 'https://api.yourdomain.com');

const account = await zoneless.accounts.reject(
  'acct_z_1Nv0FGQ9RKHgCVdK',
  {
    reason: 'fraud',
  }
);
RESPONSE
{
  "id": "acct_z_1Nv0FGQ9RKHgCVdK",
  "object": "account",
  "business_profile": {
    "mcc": null,
    "name": null,
    "product_description": null,
    "support_email": null,
    "support_phone": null,
    "support_url": null,
    "url": null
  },
  "business_type": "individual",
  "capabilities": {
    "transfers": "inactive",
    "usdc_payouts": "inactive"
  },
  "charges_enabled": false,
  "controller": {
    "fees": {
      "payer": "application_express"
    },
    "is_controller": true,
    "losses": {
      "payments": "application"
    },
    "requirement_collection": "zoneless",
    "zoneless_dashboard": {
      "type": "express"
    },
    "type": "application"
  },
  "country": "US",
  "created": 1704067200,
  "default_currency": "usdc",
  "details_submitted": true,
  "email": "seller@example.com",
  "external_accounts": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../external_accounts"
  },
  "future_requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": null,
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "individual": {
    "id": "person_z_1Nv0FGQ9RKHgCVdK",
    "object": "person",
    "account": "acct_z_1Nv0FGQ9RKHgCVdK",
    "address": null,
    "created": 1704067200,
    "dob": null,
    "email": "seller@example.com",
    "first_name": "Tom",
    "future_requirements": null,
    "id_number_provided": false,
    "last_name": "Jones",
    "metadata": {},
    "phone": null,
    "relationship": {
      "representative": true
    },
    "requirements": null,
    "ssn_last_4_provided": false,
    "verification": {
      "additional_document": null,
      "details": null,
      "details_code": null,
      "document": {
        "back": null,
        "details": null,
        "details_code": null,
        "front": null
      },
      "status": "unverified"
    }
  },
  "login_links": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/accounts/acct_z_1Nv0.../login_links"
  },
  "metadata": {},
  "payouts_enabled": false,
  "platform_account": "acct_z_Platform123abc",
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [],
    "disabled_reason": "rejected.fraud",
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "settings": {
    "branding": {
      "icon": null,
      "logo": null,
      "primary_color": null,
      "secondary_color": null
    },
    "dashboard": {
      "display_name": null,
      "timezone": "Etc/UTC"
    },
    "payouts": {
      "debit_negative_balances": true,
      "schedule": {
        "delay_days": 2,
        "interval": "daily"
      },
      "statement_descriptor": null
    }
  },
  "tos_acceptance": {
    "date": 1704067200,
    "ip": "192.168.1.1",
    "service_agreement": "full",
    "user_agent": "Mozilla/5.0"
  },
  "type": "express"
}