curl --request POST \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/payout-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-api-key: <api-key>' \
  --data '
{
  "methodType": "bank_hk",
  "currency": "HKD",
  "bankAccount": {
    "accountHolderName": "Chan Tai Man",
    "bankCode": "004",
    "branchCode": "123",
    "accountNumber": "12345678901"
  },
  "isPrimary": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "methodType": "<string>",
  "category": "<string>",
  "displayName": "<string>",
  "countryCode": "<string>",
  "currency": "<string>",
  "providerType": "<string>",
  "isPrimary": true,
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Payout Accounts

Create member payout account

Creates a payout account and provisions a real Stripe Connect account for the member. The account is created with the transfers capability enabled, allowing the platform to send payouts.

Identity + Country Requirements

Identity and country are not provided in this request. They are derived from the member’s stored profile (typically populated/verified during KYC).

Before calling this endpoint:

Ensure the member profile has countryCode (ISO alpha-3) and address fields set via PATCH /api/v1/members/{userId}/profile.
For Stripe, ensure the profile also has identity fields required for verification.

Selecting `methodType` and building `bankAccount`

Call GET /api/v1/payout-methods?country=XX.
Choose a method from methods[].
Use methods[].id as methodType.
Populate bankAccount using the selected method’s fields[] (each field’s key becomes a key in bankAccount).

POST

api

members

{userId}

payout-accounts

curl --request POST \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/payout-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-api-key: <api-key>' \
  --data '
{
  "methodType": "bank_hk",
  "currency": "HKD",
  "bankAccount": {
    "accountHolderName": "Chan Tai Man",
    "bankCode": "004",
    "branchCode": "123",
    "accountNumber": "12345678901"
  },
  "isPrimary": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "methodType": "<string>",
  "category": "<string>",
  "displayName": "<string>",
  "countryCode": "<string>",
  "currency": "<string>",
  "providerType": "<string>",
  "isPrimary": true,
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-tenant-api-key

string

header

required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Path Parameters

userId

string<uuid>

required

Body

application/json

methodType

string

required

Payout method ID. Must match a value from GET /api/v1/payout-methods?country=XX response methods[].id.

currency

string

required

ISO 4217 currency code. Must match the selected payout method.

Required string length: 3

bankAccount

object

Bank account details. Required fields depend on the selected methodType. Use GET /api/v1/payout-methods?country=XX to get field definitions for each method.

Common fields by country:

HK: bankCode, branchCode, accountNumber
US: routingNumber, accountNumber
GB: sortCode, accountNumber
EU (SEPA): iban

Show child attributes

details

object

deprecated

Deprecated: Use bankAccount instead. Provider-agnostic key/value map of method-specific fields. Keys and validation rules are defined by the selected payout method's fields[] from GET /api/v1/payout-methods.

Show child attributes

accountHolderName

string

deprecated

Deprecated: Use bankAccount.accountHolderName instead. Name of the payout account holder as registered with the provider.

isPrimary

boolean

If true, marks this account as the member's primary payout account

Response

Created payout account

string<uuid>

methodType

string

API Reference

Authorizations

Path Parameters

Body

Response