Tip
Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

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)

...

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)

...

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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "classification": "PAYMENT_CANCEL",
            "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,
            "classification": "PAYMENT_CANCEL",
            "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)

...

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

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

      {
    "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

...

Examples

HTTP Method: GET

Request:

Response:

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

Panel

name	blue

Child pages (Children Display)

excerpt	true

Versions Compared

Old Version 4

New Version Current

Key

GET payment_cancellations/configuration/types/list

Resource URL

Parameters

Response Data

Examples

GET payment_cancellations/configuration/categories/list

Resource URL

Parameters

Response Data

Examples

GET payment_cancellations/configuration/rejection_reasons/list

Resource URL

Parameters

Response Data

Examples

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

GET payment_cancellations/configuration/types/list

Resource URL

Parameters

Response Data

Examples

GET payment_cancellations/configuration/categories/list

Resource URL

Parameters

Response Data

Examples

GET payment_cancellations/configuration/rejection_reasons/list

Resource URL

Parameters

Response Data

Examples