| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be providing the payment cancellation type. The group is filtered against the payment cancellation types' allowed organisational units. The allowed group identifier fields are the following:
| ||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be providing the payment cancellation type. The unit is filtered against the payment cancellation types' allowed organisational units. The allowed unit identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET
...
payment_cancellations/configuration/categories/list
This method returns the payment cancellation categories that are allowed to be used by payments of payment cancellations of a specific type. Multiple payment categories payment cancellation categories are returned by each call
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
payment_cancellation_type_identifier (mandatory) | Financial Transaction Type Identifier | The identifier of the type of the payment cancellation that will be using the categories. The categories are filtered against the allowed categories of the specified type. The allowed financial transaction type identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET
...
This method returns the payment methods that are allowed to be used by payments of a specific type. Multiple payment methods are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
payment_type_identifier
(mandatory)
...
The identifier of the type of the payment that will be using the payment methods. The payment methods are filtered against the allowed payment methods of the specified type. The allowed financial transaction type identifier fields are the following:
...
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
...
payment_cancellations/configuration/rejection_reasons/list
This method returns the rejection reasons that can be used while rejecting a draft payment cancellation, as defined through the active financial transactions definition. Multiple rejection reasons are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|