v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Accounts

Create account by customer

Creates an account for a particular customer using the customer’s ID as a reference

post/customers/{customerId}/accounts

Path parameters

customerIdstring required

ID of customer to create account for

Request body

externalReferencestring

External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long

currency'GBP' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'SHP' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

productCodestring

Product associated with the account. Contact your account manager for correct code to use.

Response

Created

idstring

Unique id for the account

namestring

Name for the account

balancestring

Balance of the account in format 'NN.NN'

availableBalancestring

The current available balance of the Account. Calculated by subtracting any pending payments from the current balance

currencystring

Currency of the account in ISO 4217 format

statusstring

Status of the account. Accounts must be 'ACTIVE' to make and receive payments. Can be one of

customerIdstring

Unique id of the Customer

customerNamestring

Customer Name

externalReferencestring

Your reference for an account

accessGroupsstring[]

Ids of Access Groups this account belongs to

createdDatestring date-time

Datetime when the account was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

directDebitboolean

Direct Debit Enabled

securedFundingLimitstring

Limit of funds available below a balance of zero

Example response

{
  "id": "A0000001",
  "balance": "10000.00",
  "availableBalance": "10000.00",
  "currency": "GBP",
  "status": "ACTIVE",
  "identifiers": [
    {
      "accountNumber": "12345678",
      "sortCode": "000000",
      "iban": "GB20MODR04001401100000",
      "bic": "MODRGB21",
      "currency": "GBP",
      "countrySpecificDetails": {
        "bankName": "Apple Bank",
        "bankAddress": "2100 Broadway",
        "bankCity": "New York City",
        "bankBranchName": "New York",
        "bankBranchCode": "44-04",
        "chineseId": "01101201901018889",
        "province": "Zhejiang",
        "business": true,
        "bankCodeType": "ABA",
        "bankCountry": "US",
        "abaRoutingNumber": "123456789"
      },
      "productId": "O2100001"
    }
  ],
  "customerId": "C0000001",
  "externalReference": "aReference_00001",
  "createdDate": "2017-01-28T01:01:01+0000"
}