Bank Account Configuration

These endpoints let you manage bank account configurations for employees in the system. It allows you to retrieve, create, update, and delete bank account configuration records.

Get Bank Account Configurations

get

Get all bank account configurations with pagination

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	:	Equal operator Support multiple values with each value separated by the ; delimiter
employee.id	:	Equal operator Support multiple values with each value separated by the ; delimiter

Example: employee.id:62b529c7-0cfb-4d34-8ef8-3be3ef0f911d

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/bank-account-configurations

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/bank-account-configurations?page=0&size=10&query=employee.id%3A62b529c7-0cfb-4d34-8ef8-3be3ef0f911d" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
      "employee": {
        "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
        "identificationNumber": "123456789abc",
        "name": "John Doe",
        "active": true
      },
      "paymentMethod": "TRANSFER",
      "updatedDate": 1700000000000,
      "effectiveDate": "2023-11-01",
      "distributionMethod": "PERCENTAGE",
      "defaultBankAccount": {
        "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
        "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "bank": {
          "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
          "code": "014",
          "name": "BCA",
          "llg": "146789"
        },
        "bankBranchId": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
        "bankBranch": {
          "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
          "code": "BCA01",
          "name": "BCA Wisma Asia",
          "address": "Wisma Asia",
          "bank": {
            "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
            "code": "014",
            "name": "BCA",
            "llg": "146789"
          }
        },
        "accountNumber": "68492818391829",
        "accountName": "Bagus Seto",
        "beneficiaryId": "BEN-001",
        "priority": 1,
        "currency": {
          "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
          "code": "IDR",
          "name": "Indonesian Rupiah",
          "baseCurrency": true
        },
        "percentage": 100,
        "amount": 0
      },
      "bankAccounts": [
        {
          "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
          "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
          "bank": {
            "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
            "code": "014",
            "name": "BCA",
            "llg": "146789"
          },
          "bankBranchId": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
          "bankBranch": {
            "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
            "code": "BCA01",
            "name": "BCA Wisma Asia",
            "address": "Wisma Asia",
            "bank": {
              "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
              "code": "014",
              "name": "BCA",
              "llg": "146789"
            }
          },
          "accountNumber": "68492818391829",
          "accountName": "Bagus Seto",
          "beneficiaryId": "BEN-001",
          "priority": 1,
          "currency": {
            "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
            "code": "IDR",
            "name": "Indonesian Rupiah",
            "baseCurrency": true
          },
          "percentage": 100,
          "amount": 0
        }
      ]
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Bank Account Configuration by Id

get

Return the bank account configuration by Id.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: 62b529c7-0cfb-4d34-8ef8-3be3ef0f911d

Responses

200

OK

application/json

idstringOptional

paymentMethodstring · enumOptionalPossible values:

updatedDateinteger · timestamp in millisecondsOptional

effectiveDatestring · dateOptional

YYYY-MM-DD

distributionMethodstringOptional

approvalStatusstring · enumOptionalPossible values:

400

Bad Request

get

/core/v1/bank-account-configurations/{id}

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/bank-account-configurations/62b529c7-0cfb-4d34-8ef8-3be3ef0f911d" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
  "employee": {
    "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
    "identificationNumber": "123456789abc",
    "name": "John Doe",
    "active": true
  },
  "paymentMethod": "TRANSFER",
  "updatedDate": 1700000000000,
  "effectiveDate": "2023-11-01",
  "distributionMethod": "PERCENTAGE",
  "defaultBankAccount": {
    "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
    "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
    "bank": {
      "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "code": "014",
      "name": "BCA",
      "llg": "146789"
    },
    "bankBranchId": "",
    "bankBranch": {
      "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
      "code": "BCA01",
      "name": "BCA Wisma Asia",
      "address": "Wisma Asia"
    },
    "accountNumber": "68492818391829",
    "accountName": "Bagus Seto",
    "beneficiaryId": "",
    "priority": 1,
    "currency": {
      "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
      "code": "IDR",
      "name": "Indonesian Rupiah",
      "baseCurrency": true
    },
    "percentage": 100,
    "amount": 0
  },
  "bankAccounts": [
    {
      "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
      "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "bank": {
        "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "code": "014",
        "name": "BCA",
        "llg": "146789"
      },
      "bankBranchId": "",
      "bankBranch": {
        "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
        "code": "BCA01",
        "name": "BCA Wisma Asia",
        "address": "Wisma Asia"
      },
      "accountNumber": "68492818391829",
      "accountName": "Bagus Seto",
      "beneficiaryId": "",
      "priority": 1,
      "currency": {
        "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
        "code": "IDR",
        "name": "Indonesian Rupiah",
        "baseCurrency": true
      },
      "percentage": 100,
      "amount": 0
    }
  ]
}

Create Bank Account Configuration Approval

post

Replacement for /v1/employees/{employeeId}/bank-account-configurations.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

effectiveDatestring · dateOptional

YYYY-MM-DD

paymentMethodstring · enumRequiredPossible values:

distributionMethodstring · enumOptionalPossible values:

Responses

201

OK

application/json

400

Bad Request

post

/core/v1/bank-account-configurations/approvals

cURLPython SDK

curl -X POST \
  "https://api.catapa.com/core/v1/bank-account-configurations/approvals" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '...'

{
  "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
  "employee": {
    "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
    "identificationNumber": "123456789abc",
    "name": "John Doe",
    "active": true
  },
  "paymentMethod": "TRANSFER",
  "updatedDate": 1700000000000,
  "effectiveDate": "2023-11-01",
  "distributionMethod": "PERCENTAGE",
  "defaultBankAccount": {
    "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
    "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
    "bank": {
      "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "code": "014",
      "name": "BCA",
      "llg": "146789"
    },
    "bankBranchId": "",
    "bankBranch": {
      "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
      "code": "BCA01",
      "name": "BCA Wisma Asia",
      "address": "Wisma Asia"
    },
    "accountNumber": "68492818391829",
    "accountName": "Bagus Seto",
    "beneficiaryId": "",
    "priority": 1,
    "currency": {
      "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
      "code": "IDR",
      "name": "Indonesian Rupiah",
      "baseCurrency": true
    },
    "percentage": 100,
    "amount": 0
  },
  "bankAccounts": [
    {
      "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
      "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "bank": {
        "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "code": "014",
        "name": "BCA",
        "llg": "146789"
      },
      "bankBranchId": "",
      "bankBranch": {
        "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
        "code": "BCA01",
        "name": "BCA Wisma Asia",
        "address": "Wisma Asia"
      },
      "accountNumber": "68492818391829",
      "accountName": "Bagus Seto",
      "beneficiaryId": "",
      "priority": 1,
      "currency": {
        "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
        "code": "IDR",
        "name": "Indonesian Rupiah",
        "baseCurrency": true
      },
      "percentage": 100,
      "amount": 0
    }
  ]
}

Update Bank Account Configuration

put

Approve the bank account configuration.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

idstringRequired

Unique identifier

Responses

200

OK

application/json

400

Bad Request

application/json

put

/core/v1/bank-account-configurations/approvals/approve

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/bank-account-configurations/approvals/approve" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
  },
  {
    "id": "6a4d1903-b453-4694-9806-65101f0aec64"
  }
]'

{
  "successes": [
    {
      "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
    },
    {
      "id": "6a4d1903-b453-4694-9806-65101f0aec64"
    }
  ],
  "failures": []
}

Reject Bank Account Configuration

put

Reject the bank account configuration.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

idstringRequired

Approval ID

reasonstringRequired

Reason of Rejection

Responses

200

OK

application/json

400

Bad Request

application/json

put

/core/v1/bank-account-configurations/approvals/reject

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/bank-account-configurations/approvals/reject" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "59a7fdc8-888c-437b-afec-44ffa490b160",
    "reason": "reason"
  },
  {
    "id": "032f6fd4-67d5-423f-9522-283f79391019",
    "reason": "reason"
  }
]'

{
  "successes": [
    {
      "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
    },
    {
      "id": "6a4d1903-b453-4694-9806-65101f0aec64"
    }
  ],
  "failures": []
}

Undo Bank Account Configuration

put

Undo the bank account configuration approval.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

idstringRequired

Unique identifier

Responses

200

OK

application/json

400

Bad Request

put

/core/v1/bank-account-configurations/approvals/undo

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/bank-account-configurations/approvals/undo" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
  },
  {
    "id": "6a4d1903-b453-4694-9806-65101f0aec64"
  }
]'

{
  "successes": [
    {
      "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
    },
    {
      "id": "6a4d1903-b453-4694-9806-65101f0aec64"
    }
  ],
  "failures": []
}

Update Bank Account Configuration Approval

put

Update the bank account configuration approval.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: 62b529c7-0cfb-4d34-8ef8-3be3ef0f911d

Body

application/json

effectiveDatestring · dateOptional

YYYY-MM-DD

paymentMethodstring · enumRequiredPossible values:

distributionMethodstring · enumOptionalPossible values:

Responses

200

OK

application/json

idstringOptional

paymentMethodstring · enumOptionalPossible values:

updatedDateinteger · timestamp in millisecondsOptional

effectiveDatestring · dateOptional

YYYY-MM-DD

distributionMethodstringOptional

approvalStatusstring · enumOptionalPossible values:

400

Bad Request

put

/core/v1/bank-account-configurations/approvals/{id}

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/bank-account-configurations/approvals/62b529c7-0cfb-4d34-8ef8-3be3ef0f911d" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '...'

{
  "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
  "employee": {
    "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
    "identificationNumber": "123456789abc",
    "name": "John Doe",
    "active": true
  },
  "paymentMethod": "TRANSFER",
  "updatedDate": 1700000000000,
  "effectiveDate": "2023-11-01",
  "distributionMethod": "PERCENTAGE",
  "defaultBankAccount": {
    "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
    "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
    "bank": {
      "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "code": "014",
      "name": "BCA",
      "llg": "146789"
    },
    "bankBranchId": "",
    "bankBranch": {
      "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
      "code": "BCA01",
      "name": "BCA Wisma Asia",
      "address": "Wisma Asia"
    },
    "accountNumber": "68492818391829",
    "accountName": "Bagus Seto",
    "beneficiaryId": "",
    "priority": 1,
    "currency": {
      "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
      "code": "IDR",
      "name": "Indonesian Rupiah",
      "baseCurrency": true
    },
    "percentage": 100,
    "amount": 0
  },
  "bankAccounts": [
    {
      "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
      "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "bank": {
        "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "code": "014",
        "name": "BCA",
        "llg": "146789"
      },
      "bankBranchId": "",
      "bankBranch": {
        "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
        "code": "BCA01",
        "name": "BCA Wisma Asia",
        "address": "Wisma Asia"
      },
      "accountNumber": "68492818391829",
      "accountName": "Bagus Seto",
      "beneficiaryId": "",
      "priority": 1,
      "currency": {
        "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
        "code": "IDR",
        "name": "Indonesian Rupiah",
        "baseCurrency": true
      },
      "percentage": 100,
      "amount": 0
    }
  ]
}

Cancel Bank Account Configuration

put

Cancel the bank account configuration approval.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Responses

200

OK

No content

400

Bad Request

put

/core/v1/bank-account-configurations/approvals/{id}/cancel

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/bank-account-configurations/approvals/f47ac10b-58cc-4372-a567-0e02b2c3d479/cancel" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

No content