# Create Payout Account

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/businessExternalAccount/:
    post:
      summary: Create Payout Account
      deprecated: false
      description: Creates a payout account for a merchant.
      tags:
        - API Documentation/Payout Accounts
      parameters:
        - name: x-api-key
          in: header
          description: ''
          required: true
          example: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed
          schema:
            type: string
        - name: x-api-secret
          in: header
          description: ''
          required: true
          example: >-
            CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                accountNumber:
                  type: string
                  description: The bank account number
                  x-apidog-mock: '9876543210'
                accountHolderName:
                  type: string
                  description: The bank account holder full name
                  x-apidog-mock: Alice Johnson
                bankName:
                  type: string
                  description: The account' bank name
                  x-apidog-mock: Global Trust Bank
                swiftCode:
                  type: string
                  description: The bank account SWIFT code
                  x-apidog-mock: GTBABC45XXX
                iban:
                  type: string
                  description: The bank account IBAN
                  x-apidog-mock: GB29NWBK60161331926819
                routingNumber:
                  type: string
                  description: The bank account ABA / Routing number
                  x-apidog-mock: '021000021'
                countryIso:
                  type: string
                  description: The bank's address country ISO2
                  x-apidog-mock: US
                address:
                  type: string
                  description: The bank's street address
                  x-apidog-mock: Main Street
                streetNumber:
                  type: string
                  description: The bank's address street number
                  x-apidog-mock: '123'
                city:
                  type: string
                  description: The bank's address city
                  x-apidog-mock: New York
                state:
                  type: string
                  description: The bank's address state ISO2
                  x-apidog-mock: NY
                zipCode:
                  type: string
                  description: The bank's address zip code
                  x-apidog-mock: '10001'
                businessId:
                  type: integer
                  description: The account's owner merchant ID
                  x-apidog-mock: '1'
                currencySymbol:
                  type: string
                  description: The account's currency
                  x-apidog-mock: USD
                invoiceUrl:
                  type: string
                  description: >-
                    URL to an example invoice for the bank account. Supported
                    file formats: PDF (preferred), PNG, JPG
                  x-apidog-mock: >-
                    https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                GTBABC45XXX:
                  type: string
                  x-apidog-mock: GTBABC45XXX
                  description: Intermediary Bank SWIFT/BIC
              required:
                - accountNumber
                - accountHolderName
                - bankName
                - swiftCode
                - countryIso
                - address
                - streetNumber
                - city
                - zipCode
                - businessId
                - currencySymbol
                - invoiceUrl
              x-apidog-orders:
                - businessId
                - currencySymbol
                - accountNumber
                - accountHolderName
                - bankName
                - swiftCode
                - GTBABC45XXX
                - iban
                - routingNumber
                - countryIso
                - state
                - city
                - address
                - streetNumber
                - zipCode
                - invoiceUrl
              x--orders:
                - accountNumber
                - accountHolderName
                - bankName
                - swiftCode
                - iban
                - routingNumber
                - countryIso
                - address
                - streetNumber
                - city
                - state
                - zipCode
                - businessId
                - currencySymbol
                - invoiceUrl
                - GTBABC45XXX
              x--ignore-properties: []
            example:
              businessId: 1
              currencySymbol: USD
              accountNumber: '9876543210'
              accountHolderName: Alice Johnson
              bankName: Global Trust Bank
              swiftCode: GTBABC45XYZ
              iban: GB29NWBK60161331926819
              routingNumber: '021000021'
              countryIso: US
              state: NY
              city: New York
              address: Main Street
              streetNumber: '123'
              zipCode: '10001'
              invoiceUrl: >-
                https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout%20Account'
              example:
                id: 1
                creationTime: 1741013991817
                lastUpdateTime: 1741013991817
                accountNumber: '9876543210'
                accountHolderName: Alice Johnson
                bankName: Global Trust Bank
                swiftCode: GTBABC45XXX
                iban: GB29NWBK60161331926819
                routingNumber: '021000021'
                countryIso: US
                address: Main Street
                streetNumber: '123'
                city: New York
                state: NY
                zipCode: '10001'
                businessId: 1
                currencySymbol: USD
                accountStatus: PENDING
          headers: {}
          x-apidog-name: OK
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API%20Error'
              examples:
                '2':
                  summary: IP Not Whitelisted
                  value:
                    exception:
                      errorCode: API_IP_NOT_WHITELISTED
                      message: Access Denied - IP not whitelisted
                '3':
                  summary: Resource Not Found
                  value:
                    exception:
                      errorCode: RESOURCE_NOT_FOUND
                      message: Business with id [1] not found
          headers: {}
          x-apidog-name: Error
      security: []
      x-apidog-folder: API Documentation/Payout Accounts
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/669455/apis/api-14463681-run
components:
  schemas:
    Payout Account:
      type: object
      properties:
        id:
          type: integer
          x-apidog-mock: '{{$number.int(min=1)}}'
          description: The receiver account's ID
        creationTime:
          type: integer
          x-apidog-mock: '1741013991817'
          description: The entity creation time in UNIX timestamp
        lastUpdateTime:
          type: integer
          x-apidog-mock: '1741013991817'
          description: The entity last update time in UNIX timestamp
        accountNumber:
          type: string
          x-apidog-mock: '9876543210'
          description: The bank account number
        accountHolderName:
          type: string
          x-apidog-mock: Alice Johnson
          description: The bank account holder full name
        bankName:
          type: string
          x-apidog-mock: Global Trust Bank
          description: The account' bank name
        swiftCode:
          type: string
          x-apidog-mock: GTBABC45XXX
          description: The bank account SWIFT code
        iban:
          type: string
          x-apidog-mock: GB29NWBK60161331926819
          description: The bank account IBAN
        routingNumber:
          type: string
          x-apidog-mock: '021000021'
          description: The bank account ABA / Routing number
        countryIso:
          type: string
          x-apidog-mock: US
          description: The bank's address country ISO2
        address:
          type: string
          x-apidog-mock: Main Street
          description: The bank's street address
        streetNumber:
          type: string
          x-apidog-mock: '123'
          description: The bank's address street number
        city:
          type: string
          x-apidog-mock: New York
          description: The bank's address city
        state:
          type: string
          x-apidog-mock: NY
          description: The bank's address state ISO2
        zipCode:
          type: string
          x-apidog-mock: '10001'
          description: The bank's address zip code
        businessId:
          type: integer
          x-apidog-mock: '1'
          description: The account's owner merchant ID
        currencySymbol:
          type: string
          x-apidog-mock: USD
          description: The account's currency
        accountStatus:
          type: string
          x-apidog-mock: PENDING
          enum:
            - PENDING
            - ACTIVE
            - FROZEN
            - CLOSED
          x-apidog-enum:
            - value: PENDING
              name: Pending
              description: 'Waiting for approval or activation  '
            - value: ACTIVE
              name: Active
              description: 'Currently in use and operational  '
            - value: FROZEN
              name: Frozen
              description: 'Temporarily restricted from transactions  '
            - value: CLOSED
              name: Closed
              description: 'Account is permanently closed  '
          description: The current verification status of the account
        intermediateSwiftCode:
          type: string
          x-apidog-mock: GTBABC45XXX
          description: Intermediary Bank SWIFT/BIC
      required:
        - id
        - creationTime
        - lastUpdateTime
        - accountNumber
        - accountHolderName
        - bankName
        - swiftCode
        - countryIso
        - address
        - streetNumber
        - city
        - state
        - zipCode
        - businessId
        - currencySymbol
        - accountStatus
      x-apidog-orders:
        - id
        - creationTime
        - lastUpdateTime
        - businessId
        - currencySymbol
        - accountStatus
        - accountNumber
        - accountHolderName
        - bankName
        - swiftCode
        - intermediateSwiftCode
        - iban
        - routingNumber
        - countryIso
        - state
        - city
        - address
        - streetNumber
        - zipCode
      x--orders:
        - id
        - creationTime
        - lastUpdateTime
        - accountNumber
        - accountHolderName
        - bankName
        - swiftCode
        - iban
        - routingNumber
        - countryIso
        - address
        - streetNumber
        - city
        - state
        - zipCode
        - businessId
        - currencySymbol
        - accountStatus
        - intermediateSwiftCode
      x--ignore-properties: []
      x-apidog-folder: ''
    API Error:
      type: object
      properties:
        exception:
          type: object
          properties:
            errorCode:
              type: string
              enum:
                - INTERNAL_SERVER_ERROR
                - RATE_LIMIT_EXCEEDED
                - URL_INVALID
                - MOCK
                - API_KEY_MISSING
                - API_KEY_INVALID
                - API_KEY_NO_ACCESS
                - API_SECRET_MISSING
                - API_SECRET_INVALID
                - API_IP_NOT_WHITELISTED
                - RESOURCE_NOT_FOUND
                - REQUIRED_FIELD_MISSING
                - BAD_REQUEST
                - BUSINESS_KYC_NOT_VALID
                - BUSINESS_NOT_ACTIVE
                - BUSINESS_CANNOT_UPDATE_VALID
                - BUSINESS_REQUEST_CANCEL_FAILED
                - BUSINESS_REQUEST_ACTION_UNAVAILABLE
                - BUSINESS_REQUEST_ACTION_FAILED
                - BUSINESS_REQUEST_INVALID_TO_AMOUNT
                - CREDENTIALS_NOT_FOUND
                - CURRENCY_NOT_FOUND
                - INVALID_CURRENCY
                - BUSINESS_EXTERNAL_ACCOUNT_CANNOT_UPDATE_NON_PENDING_ACCOUNT
                - BUSINESS_INVOICE_FAILED_TO_DOWNLOAD_INVOICE
              x-apidog-enum:
                - value: INTERNAL_SERVER_ERROR
                  name: Internal Server Error
                  description: 'Internal server error  '
                - value: RATE_LIMIT_EXCEEDED
                  name: Rate Limit Exceeded
                  description: 'Rate limit exceeded  '
                - value: URL_INVALID
                  name: URL Invalid
                  description: 'Invalid URL  '
                - value: MOCK
                  name: Sandbox Error
                  description: 'Error in sandbox service  '
                - value: API_KEY_MISSING
                  name: API Key Missing
                  description: 'API key missing  '
                - value: API_KEY_INVALID
                  name: API Key Invalid
                  description: 'API key invalid  '
                - value: API_KEY_NO_ACCESS
                  name: API Key No Access
                  description: 'Access Denied  '
                - value: API_SECRET_MISSING
                  name: API Secret Missing
                  description: 'API secret missing  '
                - value: API_SECRET_INVALID
                  name: API Secret Invalid
                  description: 'API secret invalid  '
                - value: API_IP_NOT_WHITELISTED
                  name: API IP Not Whitelisted
                  description: 'Access Denied - IP not whitelisted  '
                - value: RESOURCE_NOT_FOUND
                  name: Resource Not Found
                  description: 'Resource not found  '
                - value: REQUIRED_FIELD_MISSING
                  name: Required Field Missing
                  description: 'Required field missing  '
                - value: BAD_REQUEST
                  name: Bad Request
                  description: 'Request body is invalid  '
                - value: BUSINESS_KYC_NOT_VALID
                  name: Merchant KYC Not Valid
                  description: 'Merchant KYC not valid  '
                - value: BUSINESS_NOT_ACTIVE
                  name: Merchant Not Active
                  description: 'Merchant not active  '
                - value: BUSINESS_CANNOT_UPDATE_VALID
                  name: Merchant Cannot Update Valid
                  description: 'Cannot update merchant after KYC status is valid  '
                - value: BUSINESS_REQUEST_CANCEL_FAILED
                  name: Transaction Cancel Failed
                  description: 'Failed to cancel request  '
                - value: BUSINESS_REQUEST_ACTION_UNAVAILABLE
                  name: Transaction Action Unavailable
                  description: 'Action unavailable  '
                - value: BUSINESS_REQUEST_ACTION_FAILED
                  name: Transaction Action Failed
                  description: 'Failed to perform action  '
                - value: BUSINESS_REQUEST_INVALID_TO_AMOUNT
                  name: Transaction Invalid To Amount
                  description: 'Invalid to amount  '
                - value: CREDENTIALS_NOT_FOUND
                  name: Credentials Not Found
                  description: 'Failed to find credentials  '
                - value: CURRENCY_NOT_FOUND
                  name: Currency Not Found
                  description: 'Currency not found  '
                - value: INVALID_CURRENCY
                  name: Invalid Currency
                  description: 'Invalid currency  '
                - value: BUSINESS_EXTERNAL_ACCOUNT_CANNOT_UPDATE_NON_PENDING_ACCOUNT
                  name: Receiver Account Cannot Update Non Pending Account
                  description: 'Cannot update non-pending account  '
                - value: BUSINESS_INVOICE_FAILED_TO_DOWNLOAD_INVOICE
                  name: Invoice Failed To Download Invoice
                  description: 'Failed to download invoice from URL  '
              description: The API error code
            message:
              type: string
              description: Exception message with additional details
          required:
            - errorCode
            - message
          x-apidog-orders:
            - errorCode
            - message
          description: Exception details
          x--orders:
            - errorCode
            - message
          x--ignore-properties: []
      required:
        - exception
      x-apidog-orders:
        - exception
      x--orders:
        - exception
      x--ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://partners-api.service.cedar.money/mock/bpapi
    description: Sandbox Partners API
  - url: https://partners-api.service.cedar.money/bpapi
    description: Live Partners API
security: []

```
