Versions Compared

Old Version 4

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 5

changes.mady.by.user George Rossides

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip
Tip

Available from CRM.COM R9.0.0

Table of Contents
maxLevel2

...

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 refund type. The group is filtered against the refund types' allowed organisational units. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the refund type. The unit is filtered against the refund types' allowed organisational units. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

refund_type_identifier

(mandatory)

Financial Transaction Type Identifier

The identifier of the type of the refund 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:

Include Page
v4:financial_transaction_type_identifier
v4:financial_transaction_type_identifier

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

...

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "rejection_reason":
            {
                "id": "CE833230AAD6D276E30DEA53F166CB8F",
                "name": "Reject Due to Business Request",
                "description": "Reject Due to Business Request",
                "alternative_code": "RDTBR"
            }
        },
        {
            "default": true,
            "rejection_reason":
            {
                "id": "86082D82A5C8D93D048ED95161C554A7",
                "name": "Reject Due to Error",
                "description": "Reject Due to Error",
                "alternative_code": "RDTE"
            }
        },
        {
            "default": false,
            "rejection_reason":
            {
                "id": "B5407A536ACD49B58192D4C19325D2CA",
                "name": "Rejection Reason Modal 1",
                "description": null,
                "alternative_code": "RRM1"
            }
        }
    ]
}

GET refunds/configuration/refund_methods/list

Tip

Available from CRM.COM R13.0.0

This method returns the refund methods that are allowed to be used by refunds of a specific type. Multiple refund methods are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

refund_type_identifier

(mandatory)

Financial Transaction Type Identifier

The identifier of the type of the refund that will be using the refund methods. The refund methods are filtered against the allowed refund methods of the specified type. The allowed financial transaction type identifier fields are the following:

Include Page
v4:financial_transaction_type_identifier
v4:financial_transaction_type_identifier

 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
V4:refund_type_refund_method_complete
V4:refund_type_refund_method_complete

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

 

Code Block
themeConfluence
languagejavascript
linenumberstrue