GET refunds/configuration/refund_methods/list

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

Available from CRM.COM R13.0.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

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 refund type refund method
default	Boolean	Determines if the refund type refund method is the default refund method or not
refund_method	Refund Method Object	The actual refund method supported by the refund type

Referred Objects Response Data

refund_method object response data

Name	Type	Description
id	String	The id of the retrieved refund method
name	String	The name of the retrieved refund method
alternative_code	String	The alternative code of the retrieved refund method
description	String	The description of the retrieved refund method

Examples

Example 1

HTTP Method: GET

Request:

Response: