Master Data Write API
This is included in the Master Data REST API (PL-AO-006). The available endpoints for this add-on package are listed below:
Region
| Region | Type | Link V1 | Link V2 |
|---|---|---|---|
| Create a region | POST | /rest/api/bam/regions | /rest/api/v2/bam/regions |
| Deactivate a region | POST | /rest/api/bam/regions/{regionId}/deactivate | /rest/api/v2/bam/regions/{regionId}/deactivate |
| Update a region | PUT | /rest/api/bam/regions/{regionId} | /rest/api/v2/bam/regions/{regionId} |
| Delete a region | DELETE | /rest/api/bam/regions/{regionId} | /rest/api/v2/bam/regions/{regionId} |
Legal Entity
Bank
| Bank | Type | Link V1 | Link V2 |
|---|---|---|---|
| Create a bank | POST | /rest/api/bam/banks | /rest/api/v2/bam/banks |
| Update a bank | PUT | /rest/api/bam/banks/{bankId} | /rest/api/v2/bam/banks/{bankId} |
| Delete a bank | DELETE | /rest/api/bam/banks/{bankId} | /rest/api/v2/bam/banks/{bankId} |
Bank Account
| Bank Account | Type | Link V1 | Link V2 |
|---|---|---|---|
| Create a bank account | POST | /rest/api/bam/bank-accounts | /rest/api/v2/bam/bank-accounts |
| Close a bank account | POST | /rest/api/bam/bank-accounts/{bankAccountId}/close | /rest/api/v2/bam/bank-accounts/{bankAccountId}/close |
| Update a bank account | PUT | /rest/api/bam/bank-accounts/{bankAccountId} | /rest/api/v2/bam/bank-accounts/{bankAccountId} |
| Delete a bank account | DELETE | /rest/api/bam/bank-accounts/{bankAccountId} | /rest/api/v2/bam/bank-accounts/{bankAccountId} |
Bank Group
| Bank Group | Type | Link V1 | Link V2 |
|---|---|---|---|
| Create a bank group | POST | /rest/api/bam/bank-groups | /rest/api/v2/bam/bank-groups |
| Update a bank group | PUT | /rest/api/bam/bank-groups/{bankGroupId} | /rest/api/v2/bam/bank-groups/{bankGroupId} |
| Delete a bank group | DELETE | /rest/api/bam/bank-groups/{bankGroupId} | /rest/api/v2/bam/bank-groups/{bankGroupId} |
Global Partner
Summary of changes
| # | Area | v1 | v2 |
|---|---|---|---|
| 1 | Base path | /bam/… | /v2/bam/… |
| 2 | Pagination parameters | page_number, page_size | pageNumber, pageSize |
| 3 | Page size bounds | Not documented | 1–100, default 50 |
| 4 | Error response format | Custom error object, application/json | RFC 7807 problem detail, application/problem+json |
| 5 | Error identifier | error — free-text code | type — stable, documented key |
| 6 | Validation errors | Nested complexError object | Flat errors[] array, each entry typed |
| 7 | DELETE response | 200 with IdObject body; 404 if absent | 204 No Content, empty body |
| 8 | Create response | 201 with body | 201 with body and Location header |
Query parameters that v2 does not recognize are ignored rather than rejected, so the v1 pagination parameter names have no effect in v2. v1 remains available. Retirement will be announced separately, in advance.
Error keys introduced in v2
| Group | Keys |
|---|---|
MASTER_DATA.ERRORS. | BAD_REQUEST (400), INPUT_VALIDATION_FAILED (400), UNAUTHORIZED (401), FORBIDDEN (403), NOT_FOUND (404), CONFLICT (409), INTERNAL_SERVER_ERROR (500) |
MASTER_DATA.INPUT_VALIDATION. | FIELD_REQUIRED, VALUE_TOO_SHORT, VALUE_TOO_LONG, INVALID_FORMAT, DUPLICATE_VALUE |
Every error response includes a traceId that identifies the request in support enquiries.
Updated 6 days ago
Did this page help you?