get_client_payment_method_m Sample Call and Response
This example shows an administrative client retrieving the payment reminder day settings configured for each payment method available to client number 400218, based on the get_client_payment_method_m method defined in methods_m_r73.yml.
This example covers the full scope of the method: a client-level lookup with no filtering arguments, returning payment reminder day settings for every payment method the client has configured. It does not cover configuring or changing those reminder days, which is handled by a separate method.
Sample call
{
"rest_call": "get_client_payment_method_m",
"output_format": "json",
"client_no": 400218,
"auth_key": "7f3a9c1d2e4b5f6a8c9d0e1f2a3b4c5d"
}
The call takes only the two account-identifying arguments, client_no and auth_key, both of which are required and defined in the shared param_defaults block for this API family. The method accepts no additional filtering arguments; it always returns settings for every payment method type the client has enabled.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"all_pay_methods": [
{
"pay_method_type": 1,
"pay_method_name": "Credit Card",
"days_until_payment_reminder_01": 3,
"days_until_payment_reminder_02": 7,
"days_until_payment_reminder_03": 14
},
{
"pay_method_type": 2,
"pay_method_name": "Electronic Check (ACH)",
"days_until_payment_reminder_01": 5,
"days_until_payment_reminder_02": 10,
"days_until_payment_reminder_03": null
},
{
"pay_method_type": 9,
"pay_method_name": "Net Terms 30",
"days_until_payment_reminder_01": null,
"days_until_payment_reminder_02": null,
"days_until_payment_reminder_03": null
}
]
}
An error_code of zero with an error_msg of “OK” indicates the request succeeded. The all_pay_methods array shows three representative payment methods out of the full set the method can return, which the yml documents as covering up to twenty-one named payment method types; a real response includes one entry for every payment method type configured for the client, not only these three. The pay_method_type and pay_method_name pairings shown here (Credit Card, Electronic Check (ACH), and Net Terms 30) are illustrative; the yml documents the allowable integer values and the allowable name strings as two separate lists without stating an explicit mapping between them, so the exact integer Aria assigns to each named method may differ from what is shown here. A null value in a days_until_payment_reminder field, as shown for Electronic Check (ACH) and Net Terms 30 above, means that particular reminder has not been configured for that payment method.