GET accounts_receivable/configuration/payment_preferences/list

This method returns the payment preferences that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple payment preferences 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
id	String	The id of the retrieved payment preference
name	String	The name of the retrieved payment preference
alternative_code	String	The alternative code of the retrieved payment preference
type	Sting	The type of the payment preference, such as DIRECT_DEBIT, STRIPE_PAYMENT_GATEWAY, PAYPAL_PAYMENT_GATEWAY, BRAINTREE_PAYMENT_GATEWAY GENERIC_PAYMENT_GATEWAY, CUSTOM_PAYMENT_GATEWAY, WALLET, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5 BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0 WALLET available from CRM.COM R17.0.0
description	Sting	The description of the retrieved payment preference
default	Boolean	It determines if the presentment payment is set as the default in the accounts receivable definition

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "Bitcoin",
            "id": "CE63B8EB21357E21EDCCC9D3283ABBF6",
            "description": null,
            "alternative_code": "BTC"
        },
        {
            "default": true,
            "type": "DIRECT_DEBIT",
            "name": "Direct Debit Payment",
            "id": "3810C9BF3F92876803441E2EE0D8451A",
            "description": null,
            "alternative_code": "DDP"
        },
        {
            "default": false,
            "type": "OTHER",
            "name": "Other",
            "id": "93B637021350715FD1A6BCBBAE1259CA",
            "description": null,
            "alternative_code": "CASH"
        },
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "Bank Transfer Payment",
            "id": "0135CB827A97DC1ECDA7EEA993A8ED09",
            "description": "Bank Transfer Payment",
            "alternative_code": "BTP"
        },
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "PayPal",
            "id": "99900EE62E8049E226C317F9B25C35EC",
            "description": null,
            "alternative_code": "PP"
        },
        {
            "default": false,
            "type": "DIRECT_DEBIT",
            "name": "G.N",
            "id": "AA26876BA4DD67142250843E3A360439",
            "description": null,
            "alternative_code": "G.N"
        },
        {
            "default": false,
            "type": "STRIPE_PAYMENT_GATEWAY",
            "name": "Stripe Payment Gateway",
            "id": "E7758C9A298EB68C993D2F0AEEE326F6",
            "description": null,
            "alternative_code": "SPG"
        }
    ]
}