PATCH
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
bank-accounts
/
{bank_account_id}
Patch Employee Bank Account
curl --request PATCH \
  --url https://api.example.com/organizations/{organization_id}/employees/{employee_id}/bank-accounts/{bank_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "financialInstitutionName": "Deutsche Bank",
  "accountNumber": "DE: DE89370400440532013000",
  "routingNumber": "DE: 370400440",
  "iban": "DE: DE89370400440532013000",
  "swiftCode": "DE: COBADEFFXXX",
  "isActive": true,
  "isPrimary": true
}
'
{
  "financialInstitutionName": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "accountNumber": "DE: DE89370400440532013000",
  "routingNumber": "DE: 370400440",
  "iban": "DE: DE89370400440532013000",
  "swiftCode": "DE: COBADEFFXXX",
  "isActive": true,
  "isPrimary": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization_id
required
​
employee_id
required
​
bank_account_id
required

Body

application/json

Schema for updating bank accounts - all fields are optional

​
financialInstitutionName
string | null
Example:

"Deutsche Bank"

​
accountNumber
string | null
Example:

"DE: DE89370400440532013000"

​
routingNumber
string | null
Required string length: 9
Example:

"DE: 370400440"

​
iban
string | null
Maximum string length: 34
Example:

"DE: DE89370400440532013000"

​
swiftCode
string | null
Required string length: 8 - 11
Example:

"DE: COBADEFFXXX"

​
isActive
boolean | null
​
isPrimary
boolean | null

Response

Successful Response

Schema for bank account responses

​
financialInstitutionName
string
required
Examples:

"Deutsche Bank"

"Lloyds Bank"

​
id
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
accountNumber
string | null
Example:

"DE: DE89370400440532013000"

​
routingNumber
string | null
Required string length: 9
Example:

"DE: 370400440"

​
iban
string | null
Example:

"DE: DE89370400440532013000"

​
swiftCode
string | null
Example:

"DE: COBADEFFXXX"

​
isActive
boolean
default:true
​
isPrimary
boolean
default:false