v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Internal Account

This endpoint enables you to create a new internal account, which can represent a bank account or a wallet. Internal Accounts can be used to originate payment orders and receive inbound payments. Please note that if you are bringing your own bank, this endpoint may not be supported for your bank.

post/internal_accounts

Request body

connection_idstring

The UUID of the Connection this account should be associated with. If you only have 1 connection, you do not need to supply this field.

namestring

The name of the account. Only required for bring your own bank integrations.

currencystring required

Follow ISO 4217 currency codes

metadatastring json

Set of key-value pairs that will be attached to the object and can be used to store additional data.

external_idstring

An optional user-defined 180 character unique identifier

legal_entity_idstring required

The Legal Entity associated to this account. Not required for bring your own bank integrations.

debitableboolean nullable

Whether this account can receive ACH debits. Defaults to false and is only configurable on creation. Please reach out to your customer success manager if you are interested in activating this functionality.

Response

201

idstring

objectstring

live_modeboolean

{"stackTrail":"paths:/internal_accounts:post:responses:201:content:application/json:schema:properties:account_type","oasType":"schema","type":"unknown"}

party_namestring

{"stackTrail":"paths:/internal_accounts:post:responses:201:content:application/json:schema:properties:party_type","oasType":"schema","type":"unknown"}

namestring

metadataobject

currencystring

parent_account_idstring

counterparty_idstring

created_atstring

updated_atstring

external_idstring nullable

debitableboolean nullable

Example response

{
  "id": "3389fcaa-78ad-4656-988a-e3b6f2b05529",
  "object": "internal_account",
  "party_name": "Modern Treasury",
  "party_address": {
    "id": "d71521e9-6c54-41e3-97fb-5e43bdba7e5a",
    "object": "address",
    "line1": "3450 Tremblay Shoal",
    "line2": "Suite 155",
    "locality": "North Shantae",
    "region": "OR",
    "postal_code": "13671",
    "country": "US",
    "created_at": "2021-12-21T15:06:39Z",
    "updated_at": "2021-12-21T15:06:39Z"
  },
  "account_details": [
    {
      "id": "14758ea7-4082-4760-8c82-ad88964869e2",
      "object": "account_detail",
      "account_number_safe": "6418",
      "account_number_type": "other",
      "created_at": "2021-12-21T15:06:39Z",
      "updated_at": "2021-12-21T15:06:39Z"
    }
  ],
  "routing_details": [
    {
      "id": "4860c76a-752d-43ac-ae4f-a1cdb5e8078f",
      "object": "routing_detail",
      "routing_number": "021000021",
      "routing_number_type": "aba",
      "bank_name": "JPMorgan Chase Bank, National Association",
      "bank_address": {
        "id": "8fd2389e-0678-4a42-8ec0-27919c894a85",
        "object": "address",
        "line1": "1111 Polaris Pkwy",
        "locality": "Columbus",
        "region": "OH",
        "postal_code": "43240",
        "country": "US",
        "created_at": "2021-12-21T15:06:39Z",
        "updated_at": "2021-12-21T15:06:39Z"
      },
      "created_at": "2021-12-21T15:06:39Z",
      "updated_at": "2021-12-21T15:06:39Z"
    }
  ],
  "name": "Bookings",
  "connection": {
    "id": "dac94e63-9f4a-46b9-ba6b-412acfbf4cc1",
    "object": "connection",
    "vendor_id": "example1",
    "vendor_name": "Gringotts Wizarding Bank",
    "created_at": "2018-07-24T23:43:49Z",
    "updated_at": "2018-07-24T23:43:49Z"
  },
  "currency": "USD",
  "parent_account_id": "2bb73f51-7ca2-4710-94f8-938f26c096a9",
  "counterparty_id": "8646ad4a-f582-454f-9928-148dcb445995",
  "created_at": "2021-12-21T15:06:39Z",
  "updated_at": "2021-12-21T15:06:39Z",
  "external_id": "111000025"
}