Payment Block

Payment Block - Get

HTTP Request

GET /api/v1/payment-blocks/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific payment block within the financial organization structure, identified by the provided ID, to facilitate understanding of the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Update

HTTP Request

PUT /api/v1/payment-blocks/{id}

Interactive Demo

📋 Description: Updates the details of a specific payment block within the financial organization structure, identified by the provided ID, to reflect changes in the hierarchy or organizational requirements. This operation ensures that the payment block aligns with the current financial entity’s structure.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PaymentBlockDto	true	Request body containing the updated financial entity structure data, including organization hierarchy details and relevant metadata for the specified payment block.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Delete

HTTP Request

DELETE /api/v1/payment-blocks/{id}

Interactive Demo

📋 Description: Deletes a specified payment block from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial entity management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Delete Or Decommission

HTTP Request

PUT /api/v1/payment-blocks/remove/{id}

Interactive Demo

📋 Description: Removes a specified payment block from the financial organization structure, ensuring that the hierarchy and organizational integrity of the financial entity are maintained.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Delete Or Decommission All

HTTP Request

PUT /api/v1/payment-blocks/remove/bulk

Interactive Demo

📋 Description: Removes multiple payment blocks from the financial organization structure, allowing for efficient management of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers to facilitate the bulk removal of payment blocks within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Decommission

HTTP Request

PUT /api/v1/payment-blocks/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified payment block within the financial organization structure, effectively removing it from the active hierarchy and ensuring that it is no longer utilized in financial transactions.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/payment-blocks/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions payment blocks in the financial organization structure that were modified before the specified date, ensuring the hierarchy remains up-to-date and compliant with organizational standards.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning payment blocks, ensuring that only those modified before this date are affected within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Decommission Before Now

HTTP Request

PUT /api/v1/payment-blocks/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions payment blocks that were modified before the current date, ensuring the financial organization structure remains up-to-date and compliant with operational standards. This operation supports the maintenance of an organized hierarchy within financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Decommission All

HTTP Request

PUT /api/v1/payment-blocks/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple payment blocks in a financial organization’s structure, allowing for efficient management of financial entities within the hierarchy. This operation streamlines the process of removing outdated or unnecessary payment blocks in bulk.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and their corresponding decommissioning details to facilitate the bulk removal of payment blocks within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Create Or Update Bulk

HTTP Request

PUT /api/v1/payment-blocks/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple payment blocks within the financial organization structure, enabling efficient management of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PaymentBlockDto	true	Request body containing a bulk array of payment block configurations, including details on the financial entities and their hierarchical relationships within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Create Or Update

HTTP Request

PUT /api/v1/payment-blocks/createOrUpdate

Interactive Demo

📋 Description: Creates or updates payment blocks within the financial organization structure, enabling efficient management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	PaymentBlockDto	true	Request body containing the financial entity details, including organization hierarchy and structure information, for creating or updating payment blocks.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Bulk Update

HTTP Request

PUT /api/v1/payment-blocks/bulk

Interactive Demo

📋 Description: Updates multiple payment blocks within the financial organization structure, allowing for efficient management of hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PaymentBlockDto	true	Request body containing an array of payment block configurations, including details on financial entities and their hierarchical relationships within the organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Bulk Create

HTTP Request

POST /api/v1/payment-blocks/bulk

Interactive Demo

📋 Description: Facilitates the bulk creation of payment blocks within the financial organization structure, allowing users to efficiently manage and enforce payment hierarchies across multiple financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PaymentBlockDto	true	Request body containing an array of payment block configurations for multiple financial entities within the organizational structure, including relevant hierarchy details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Bulk Delete

HTTP Request

DELETE /api/v1/payment-blocks/bulk

Interactive Demo

📋 Description: Deletes multiple payment blocks within the financial organization structure, allowing for efficient management of financial entities and their hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of payment block identifiers for bulk deletion within the financial organization’s structure and hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Search

HTTP Request

POST /api/v1/payment-blocks/search

Interactive Demo

📋 Description: Submits a search request for payment blocks within the financial organization structure, enabling users to efficiently locate and analyze hierarchical financial entities.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	PaymentBlockDtoFilter	false	Request body containing search criteria for financial entities within the organizational structure, including parameters for hierarchy and specific attributes.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePaymentBlockDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Find All

HTTP Request

GET /api/v1/payment-blocks

Interactive Demo

📋 Description: Retrieves a list of payment blocks within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the payment blocks query should be returned in a paginated format, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePaymentBlockDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Create

HTTP Request

POST /api/v1/payment-blocks

Interactive Demo

📋 Description: Creates a new payment block within the financial organization structure, enabling the management of hierarchical financial entities and their associated payment processes.

Parameters

Name	In	Type	Required	Description
body	body	PaymentBlockDto	true	Request body containing the financial entity’s organizational structure data, including hierarchy details and associated attributes for payment block management.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentBlockDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Get Metadata

HTTP Request

GET /api/v1/payment-blocks/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, including details on hierarchy and relationships among financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Payment Block - Find All By System ID

HTTP Request

GET /api/v1/payment-blocks/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves payment block details for a specified ERP system within the financial organization structure, enabling users to understand the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of financial organization structure data within the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePaymentBlockDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---