GET payment_cancellations/configuration/types/list
This method returns the payment cancellation types that are allowed to be used in the system. Multiple payment cancellation types are returned by each call
Resource URL
Parameters
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 |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved financial transaction type |
name | String | The name of the retrieved financial transaction type |
alternative_code | String | The alternative code of the retrieved financial transaction type |
| description | String | A description of the retrieved financial transaction type |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| log_information | Log Information Object | The log information of the retrieved financial transaction type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_date_1": null,
"udf_float_4": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "Payment Cancellation 1",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2014-07-18T15:31:44",
"created_date": "2014-05-14T10:22:26",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "g_neocleous",
"username": "g_neocleous",
"id": "80D37EB91123AE12EEABA6232ADA654F"
}
},
"udf_string_8": null,
"id": "094D8FE66ED969DABF5FF5749A9F7BD0",
"description": "Payment Cancellation 1",
"alternative_code": "PC1"
},
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_date_1": null,
"udf_float_4": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "Payment Cancellation 2",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2015-02-17T12:37:51",
"created_date": "2014-05-14T10:23:06",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "p_demou",
"username": "p_demou",
"id": "4927E7EE8BBB4047A35F4F313D0EC6D3"
}
},
"udf_string_8": null,
"id": "EF78D7B2920F69CE124ED56FEC845512",
"description": "Payment Cancellation 2",
"alternative_code": "PC2"
}
]
}
GET payment_cancellations/configuration/categories/list
This method returns the payment cancellation categories that are allowed to be used by payment cancellations of a specific type. Multiple payment cancellation categories are returned by each call
Resource URL
Parameters
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 |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved category |
name | String | The name of the retrieved category |
code | String | The code of the retrieved category |
| description | String | The description of the retrieved category |
| parent_id | String | The id of the retrieved category's parent category |
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"parent_id": null,
"id": "2D995444B68EE62F64957BAEFF037713",
"name": "Payment Cancellation Categories",
"description": "Payment Cancellation Categories",
"code": "PCC"
},
{
"id": "118B7863942C6FB89A630FA11FF94CCD",
"name": "Payment Category 1",
"description": "Payment Category 1",
"code": "PC1"
},
{
"parent_id": null,
"id": "A2BC929D02D8CA9E6C2C639A91DFBE4B",
"name": "Global Categories",
"description": "Global Categories",
"code": "GC"
}
]
}
GET 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
| Name | Type | Description |
|---|---|---|
| default | Boolean | Determines if the rejection reason is the default rejection reason or not |
Rejection Reason Object | The supported rejection reason |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response: