Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
dunning_processes | array | |||
![]() |
int | The unique identifier of the dunning process. | ||
OR | ||||
![]() |
string | The client-defined identifier of the dunning process. | ||
pay_method_types | int array | Will return all dunning processes associated with the payment method type specified. Allowable Values | ||
master_plans | array | |||
![]() |
int | 12 | The unique identifier of the master plan associated with a dunning process. | |
OR | ||||
![]() |
string | The client-defined identifier of the master plan associated with a dunning process. |
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error |
error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
dunning_process_details | hash | |
![]() |
int | The unique identifier of the dunning process. |
![]() |
string | The client-defined identifier of the dunning process. |
![]() |
string | The name of the dunning process |
![]() |
string | The description associated with the dunning process. |
![]() |
int | Indicator of whether the dunning process has been defined as the client default dunning process.0 = False, 1 = True Allowable Values |
![]() |
int | Number of steps (including the final dunning notification) defined for the dunning process. |
![]() |
hash | |
![]() |
int | The unique identifier of the plan associated with the dunning process. |
![]() |
string | The client-defined identifier of the plan associated with the dunning process. |
![]() |
string | The name of the plan associated with the dunning process. |
![]() |
hash | |
![]() |
int | The unique identifier of the payment method type associated with the dunning process. |
![]() |
string | The name of the payment method type associated with the dunning process. |