---
updatedAt: 2026-05-14T14:32:15.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/v0.1/llms.txt
---

# Create bank account

Creates a new bank account for an engagement. Returns newly created bank account

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v0.1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "bankAccount": {
        "type": "object",
        "properties": {
          "engagementId": {
            "type": "string"
          },
          "bankAccountId": {
            "type": "string"
          },
          "payoutUsage": {
            "type": "string",
            "nullable": true
          },
          "isPrimary": {
            "type": "boolean"
          },
          "currencyCode": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          },
          "details": {
            "type": "object",
            "properties": {
              "accountNumber": {
                "type": "string",
                "nullable": true
              },
              "iban": {
                "type": "string",
                "nullable": true
              },
              "swiftBicCode": {
                "type": "string",
                "nullable": true
              },
              "branchCode": {
                "type": "string",
                "nullable": true
              },
              "bankAccountName": {
                "type": "string",
                "nullable": true
              },
              "recipientCountry": {
                "type": "string",
                "nullable": true
              },
              "recipientCity": {
                "type": "string",
                "nullable": true
              },
              "recipientStreet": {
                "type": "string",
                "nullable": true
              },
              "recipientZipPostCode": {
                "type": "string",
                "nullable": true
              },
              "recipientStateOrProvince": {
                "type": "string",
                "nullable": true
              },
              "intermediaryIban": {
                "type": "string",
                "nullable": true
              },
              "intermediaryBranchCode": {
                "type": "string",
                "nullable": true
              },
              "intermediaryAccountNumber": {
                "type": "string",
                "nullable": true
              },
              "intermediarySwiftBicCode": {
                "type": "string",
                "nullable": true
              },
              "contactNotes": {
                "type": "string",
                "nullable": true
              },
              "contactEmail": {
                "type": "string",
                "nullable": true
              }
            }
          }
        },
        "required": [
          "engagementId",
          "bankAccountId",
          "currencyCode",
          "countryCode",
          "isPrimary",
          "details"
        ]
      }
    }
  },
  "paths": {
    "/v0.1/bank_accounts": {
      "post": {
        "summary": "Create bank account",
        "tags": [
          "Bank Accounts"
        ],
        "description": "Creates a new bank account for an engagement. Returns newly created bank account",
        "security": [
          {
            "bearer_auth": [
              "manage"
            ]
          }
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "responds with successful body",
            "content": {
              "application/json": {
                "examples": {
                  "responds with successful body": {
                    "value": {
                      "data": {
                        "engagementId": "A5540727",
                        "bankAccountId": "Af7b1993",
                        "payoutUsage": null,
                        "isPrimary": true,
                        "currencyCode": "USD",
                        "countryCode": "US",
                        "details": {
                          "bankAccountName": "David Wallas",
                          "accountNumber": "123456789",
                          "iban": null,
                          "swiftBicCode": null,
                          "branchCode": "123456789",
                          "bankCode": null,
                          "recipientCity": "New York",
                          "recipientStreet": "Street",
                          "recipientCountry": "US",
                          "recipientZipPostCode": "10001",
                          "recipientStateOrProvince": "NY",
                          "intermediaryAccountNumber": null,
                          "intermediaryIban": null,
                          "intermediaryBranchCode": null,
                          "intermediarySwiftBicCode": null,
                          "contactNotes": null,
                          "contactEmail": null
                        }
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/bankAccount"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable - rulesetId incorrect",
            "content": {
              "application/json": {
                "examples": {
                  "Unprocessable": {
                    "value": {
                      "errors": [
                        {
                          "message": "Invalid country code U!"
                        },
                        {
                          "message": "Invalid currency code US!"
                        }
                      ]
                    }
                  },
                  "Unprocessable - rulesetId incorrect": {
                    "value": {
                      "errors": [
                        {
                          "message": "Can't find ruleset with given ID"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "engagementId": {
                    "type": "string",
                    "minLength": 1,
                    "pattern": "^[\\w+\\-]{8,9}$"
                  },
                  "isPrimary": {
                    "type": "boolean"
                  },
                  "currencyCode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 3
                  },
                  "countryCode": {
                    "type": "string",
                    "minLength": 2,
                    "maxLength": 2
                  },
                  "details": {
                    "type": "object"
                  },
                  "useForExpenses": {
                    "type": "boolean"
                  },
                  "rulesetId": {
                    "type": "string"
                  }
                },
                "required": [
                  "engagementId",
                  "isPrimary",
                  "currencyCode",
                  "countryCode",
                  "details"
                ]
              },
              "examples": {
                "responds with successful body": {
                  "summary": "responds with successful body",
                  "value": {
                    "engagementId": "A5540727",
                    "isPrimary": true,
                    "countryCode": "US",
                    "currencyCode": "USD",
                    "rulesetId": "USD-US",
                    "details": {
                      "bankAccountName": "David Wallas",
                      "accountNumber": "123456789",
                      "branchCode": "123456789",
                      "recipientCity": "New York",
                      "recipientStateOrProvince": "NY",
                      "recipientZipPostCode": "10001",
                      "recipientCountry": "US",
                      "recipientStreet": "Street"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```