GET refunds/configuration/rejection_reasons/list

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R17.0.0

This method returns the rejection reasons that can be used while rejecting a draft refund, 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

NameType Description
defaultBooleanDetermines if the rejection reason is the default rejection reason or not

rejection_reason

Rejection Reason Object

The supported rejection reason

Referred Objects Response Data

 rejection_reason response data object
NameType Description
IdStringThe ID of the retrieved financial transaction rejection reason
nameStringThe Name of the retrieved financial transaction rejection reason
alternative_codeStringThe Alternative code of the retrieved financial transaction rejection reason
descriptionStringThe Description of the retrieved financial transaction rejection reason

Examples

 Example 1

HTTP Method: GET


Request:

Response:


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