Payment Method

Payment Method - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific payment method associated with a financial entity within the organizational structure, identified by the provided ID.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentMethodDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "type": "string"
  }
}

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

Payment Method - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the details of a specified payment method within the financial organization structure, ensuring alignment with the entity’s hierarchical requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PaymentMethodDto	true	Request body containing the updated payment method details, including financial entity identifiers and associated hierarchical attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentMethodDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "type": "string"
  }
}

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

Payment Method - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified payment method from the financial organization’s structure, ensuring the hierarchy remains accurate and up-to-date.

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 Method - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified payment method from the financial organization structure, ensuring that the hierarchy and organization of financial entities remain accurate and up-to-date.

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 Method - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple payment methods in bulk from the financial organization structure, ensuring efficient management of payment options within the hierarchical framework of the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of payment method identifiers to be removed in bulk from the financial organization’s structure, ensuring streamlined management of payment options within the entity’s 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 Method - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified payment method within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or unused payment methods are no longer available for 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	ResponsePaymentMethodDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "type": "string"
  }
}

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

Payment Method - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions payment methods that have been modified before the specified date, ensuring the financial organization maintains an updated and efficient payment structure within its hierarchy.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning payment methods that were modified before the given date, ensuring alignment with the organization’s financial structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "string"
    }
  ]
}

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

Payment Method - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions payment methods that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with operational requirements. This operation helps maintain the integrity of the organization’s payment hierarchy by removing outdated payment options.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "string"
    }
  ]
}

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

Payment Method - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple payment methods in bulk for a specified financial entity, ensuring the organization’s payment structure remains up-to-date and compliant with operational requirements.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of payment method identifiers to be decommissioned in bulk, reflecting changes in the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "string"
    }
  ]
}

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

Payment Method - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple payment methods in bulk for a specified financial organization, ensuring alignment with the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	PaymentMethodDto	true	Request body containing bulk payment method data for financial entities, including details on organization structure and hierarchy for efficient processing.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "string"
    }
  ]
}

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

Payment Method - Create Or Update

HTTP Request

PUT /api/v1/payment-methods/createOrUpdate

Interactive Demo

📋 Description: Updates or creates a payment method within the financial organization structure, ensuring alignment with the existing hierarchy of financial entities. This operation facilitates efficient management of payment options for streamlined financial transactions.

Parameters

Name	In	Type	Required	Description
body	body	PaymentMethodDto	true	Request body containing the financial entity’s payment method details, including identification, type, and associated organizational hierarchy for creation or update purposes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentMethodDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "type": "string"
  }
}

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

Payment Method - Bulk Update

HTTP Request

PUT /api/v1/payment-methods/bulk

Interactive Demo

📋 Description: Updates multiple payment methods for a financial entity within the organization’s structure, allowing for efficient management of payment options in bulk.

Parameters

Name	In	Type	Required	Description
body	body	PaymentMethodDto	true	Request body containing a collection of payment method updates, including associated financial entity identifiers and hierarchical organization structure details.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "string"
    }
  ]
}

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

Payment Method - Bulk Create

HTTP Request

POST /api/v1/payment-methods/bulk

Interactive Demo

📋 Description: Submits multiple payment methods in bulk for a financial entity, facilitating efficient updates to the organization’s payment structure within its hierarchical framework.

Parameters

Name	In	Type	Required	Description
body	body	PaymentMethodDto	true	Request body containing a list of payment method configurations for multiple financial entities within the organizational structure, including relevant hierarchy details and attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "string"
    }
  ]
}

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

Payment Method - Bulk Delete

HTTP Request

DELETE /api/v1/payment-methods/bulk

Interactive Demo

📋 Description: Deletes multiple payment methods associated with the specified financial organization, streamlining the management of payment options within the organizational structure.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of payment method identifiers to be deleted in bulk from the financial organization’s 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 Method - Search

HTTP Request

POST /api/v1/payment-methods/search

Interactive Demo

📋 Description: Submits a request to search for payment methods within the financial organization structure, allowing users to identify and retrieve relevant financial entities based on specified criteria.

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	PaymentMethodDtoFilter	false	Request body containing the search criteria for identifying payment methods within the financial organization structure, including relevant attributes and filters.

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",
  "countryIdEqual": 0,
  "countryDisplayIdLike": "string",
  "typeLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "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 Method - Detach Country

HTTP Request

POST /api/v1/payment-methods/detach/country/{country_id}

Interactive Demo

📋 Description: Detaches a specified payment method from the financial entity associated with the given country ID, facilitating the management of payment structures within the organization’s hierarchy.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country within the financial organization structure, used to specify the country from which a payment method is being detached.
body	body	PaymentMethodDto	true	Request body containing the financial entity’s payment method details to be detached from the specified country within the organizational structure.

Body Parameters

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

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 Method - Attach Country

HTTP Request

POST /api/v1/payment-methods/attach/country/{country_id}

Interactive Demo

📋 Description: Attaches a specified payment method to a financial entity within the organizational structure based on the provided country identifier, facilitating streamlined payment processing across different regions.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country within the financial organization structure, used to attach specific payment methods to the designated country.
body	body	PaymentMethodDto	true	Request body containing the financial entity’s payment method details to be attached to the specified country within the organizational structure.

Body Parameters

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

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 Method - Find All

HTTP Request

GET /api/v1/payment-methods

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently navigate through the list of payment methods within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "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 Method - Create

HTTP Request

POST /api/v1/payment-methods

Interactive Demo

📋 Description: Creates a new payment method within the financial organization structure, enabling the integration of diverse payment options into the entity’s hierarchical framework.

Parameters

Name	In	Type	Required	Description
body	body	PaymentMethodDto	true	Request body containing the financial entity’s payment method details, including organization hierarchy and structure information.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePaymentMethodDto

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",
    "countryId": 0,
    "countryDisplayId": "string",
    "type": "string"
  }
}

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

Payment Method - Get Metadata

HTTP Request

GET /api/v1/payment-methods/meta

Interactive Demo

📋 Description: Retrieves metadata related to available payment methods within the financial organization structure, providing insights into the hierarchy and configuration of 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 Method - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the payment methods associated with a specified ERP system identified by {systemId}, facilitating the integration of financial entities within the organizational structure and hierarchy.

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, allowing users to efficiently retrieve payment methods associated with a specific financial entity within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePaymentMethodDto

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",
      "countryId": 0,
      "countryDisplayId": "string",
      "type": "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

---