---
title: "Create a payee bank account"
method: POST
path: "/open-api/v3/payee"
tags: ["Payouts"]
---

# Create a payee bank account

`POST /open-api/v3/payee`

## Request

- Base URL: `https://api-sandbox.interlace.money`
- URL: `https://api-sandbox.interlace.money/open-api/v3/payee`
- Auth: API key in header `x-access-token`

Creates a new bank account for a payee under the current user, returning the account details upon success.

## Request body

- CreatePayeeReqDTO: Relevant fields for bank accounts.
  - `accountId` string, required: The UUID of the account.
  - `firstName` string: Recipient's first name. Example: John
  - `lastName` string, required: Recipient's last name. Example: Smith
  - `paymentType` 'COMPANY' | 'INDIVIDUAL', required: Payment to company or individual bank account.
  - `currency` 'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR', required: Currency code.
  - `accountNumber` string, required: Account number.
  - `bankName` string: Bank name.
  - `routingCodeList` RoutingCodeDTO[], required: Routing code.
    - `routingCodeType` 'ROUTING_NUMBER' | 'ACH_CODE' | 'BSB_CODE' | 'SORT_CODE' | 'IBAN' | 'BANK_CODE' | 'BRANCH_CODE' | 'PHONE_NUMBER' | 'SWIFT_CODE', required: Routing code
    - `routingCodeValue` string, required: Routing code value
  - `bankAddress` PaymentPayeeBankAddressDTO, required: Payee's bank address.
    - `country` string, required: Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
    - `city` string: City. English letters only.
    - `state` string: State / County / Province / Region. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision. English letters only.
    - `postalCode` string: Postal / ZIP code of the address.
    - `addressLine1` string: Line one of the street address.
    - `addressLine2` string: Line two of the street address.
  - `payeeAddress` Address, required: Payee Address
    - `country` string: Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
    - `city` string: City. English letters only.
    - `state` string: State / County / Province / Region. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision. English letters only.
    - `postalCode` string: Postal / ZIP code of the address.
    - `addressLine1` string: Primary address line (Street address / PO Box / Company name). English letters only, numbers and common symbols allowed.
    - `addressLine2` string: Secondary address line (Apartment / Suite / Unit / Building). English letters only, numbers and common symbols allowed.
  - `paymentMethod` 'ACH' | 'EFT' | 'SEPA' | 'FPS' | 'CHATS' | 'LOCAL' | 'IBG' | 'FAST' | 'AUS_PAY_NET' | 'FED_WIRE' | 'SWIFT', required: Payment method. This parameter belongs to LOCAL except SWIFT, For example, ACH is a local in the United States.
  - `comments` string: Remark

## Response `200`

OK

- PayoutPayeeRespDTO
  - `code` string: Error code
  - `message` string: Error message
  - `data` PayoutPayee, required: result
    - `id` string, required: Unique ID generated for the entity.
    - `firstName` string: Recipient's first name. When paymentType is COMPANY, return empty
    - `lastName` string, required: Recipient's last name.
    - `userName` string, required: Recipient's username, automatically generated by concatenating first name and last name. Example: JohnSmith
    - `accountId` string, required: The UUID of the account.
    - `paymentType` 'COMPANY' | 'INDIVIDUAL': Payment to company or individual bank account.
    - `currency` string, required: Currency code.
    - `accountNumber` string, required: Account number
    - `bankName` string: Bank name
    - `routingCodeList` RoutingCodeDTO[], required: Routing code
      - `routingCodeType` 'ROUTING_NUMBER' | 'ACH_CODE' | 'BSB_CODE' | 'SORT_CODE' | 'IBAN' | 'BANK_CODE' | 'BRANCH_CODE' | 'PHONE_NUMBER' | 'SWIFT_CODE', required: Routing code
      - `routingCodeValue` string, required: Routing code value
    - `bankAddress` PaymentPayeeAddressDTO, required: Bank address
      - `country` string, required: Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
      - `city` string: City. English letters only.
      - `state` string: State / County / Province / Region. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision. English letters only.
      - `postalCode` string: Postal / ZIP code of the address.
      - `addressLine1` string: Line one of the street address.
      - `addressLine2` string: Line two of the street address.
    - `payeeAddress` Address: Payee Address
      - `country` string: Two-letter country code, as defined in ISO 3166-1 alpha-2. Example: US
      - `city` string: City. English letters only.
      - `state` string: State / County / Province / Region. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision. English letters only.
      - `postalCode` string: Postal / ZIP code of the address.
      - `addressLine1` string: Primary address line (Street address / PO Box / Company name). English letters only, numbers and common symbols allowed.
      - `addressLine2` string: Secondary address line (Apartment / Suite / Unit / Building). English letters only, numbers and common symbols allowed.
    - `comments` string: Remark
    - `status` string: Possible status values: PENDING: Processing REQUEST: Requires additional information REVIEWING: Under review PASSED: Approved CANCELED: Canceled BLACK_LISTED: Blocked NA: Not applicable ACTIVE: Active DELETED: Deleted INACTIVE: Disabled TO_BE_MODIFIED: Requires modification

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/interlace/apis/business-transfer.md) - [All operations](https://skmtc.dev/interlace/apis/business-transfer/llms.txt) - [OpenAPI document](https://skmtc.dev/interlace/apis/business-transfer/revisions/9bf171b6fb7f?raw)