get_payment_unapplication_details_m
Summary
| API Name | get_payment_unapplication_details_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 67 |
Description
API to get the historic transaction unapplication details of a payment.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
|
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
| transaction_id | long | 38 | Yes |
transaction id or voiding transaction id of one of the following: 1. payment_transaction_id: Transaction id of a payment for which the historic unapplication details has to be fetched. 2. payment_void_transaction_id: Voiding transaction id of a payment for which the historic unapplication details has to be fetched. 3. charge_void_transaction_id: Voiding transaction id of a charge for which the historic payment unapplication details has to be fetched. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| orig_transaction_id | long | No |
The unique transaction identifier for the original transaction. |
|
| orig_transaction_date | string | No |
The creation date for the original transaction. |
|
| orig_transaction_amount | double | No |
The total amount for the original transaction. |
|
| orig_transaction_comments | string | No |
The Client-defined comments for the original transaction. |
|
| void_transaction_id | long | No |
The unique identifier for this void transaction. |
|
| void_transaction_date | string | No |
The date this transaction was voided. |
|
| void_transaction_comments | string | No |
Client-defined comments on this void transaction. |
|
| void_reason_code | long | No |
The reason code for why this transaction was voided, if it was voided. |
|
| impacted_charges | object | No |
List of charges from which the given payment was unapplied. |
|
| impacted_payments | object | No |
List of payments that got unapplied from the given charge. |
impacted_charges fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| unapplication_no | long | No |
Unique transaction number for unapplied action. |
|
| unapplication_date | string | No |
The date on which the impacted charge for an account was unapplied. |
|
| unapplication_amount | double | No |
Gross amount unapplied from the invoice line or other charge. |
|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| invoice_date | string | No |
The date on which the account was billed for an invoice. |
|
| invoice_amount | double | No |
Amount charged on an invoice. |
|
| charge_transaction_id | long | No |
The Aria assigned transaction ID of the charge. |
|
| charge_transaction_type | long | No |
Numeric Value of the type of transaction. |
|
| charge_transaction_desc | string | No |
Name of transaction type. |
impacted_payments fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| unapplication_no | long | No |
Unique transaction number for unapplied action. |
|
| unapplication_date | string | No |
The date on which the impacted payment for an account was unapplied. |
|
| unapplication_amount | double | No |
Gross amount unapplied from the invoice line or other charge. |
|
| payment_transaction_id | long | No |
The Aria assigned transaction ID of the payment. |
|
| payment_transaction_type | long | No |
Numeric Value of the type of transaction. |
|
| payment_transaction_desc | string | No |
Name of transaction type. |
|
| payment_id | long | No |
The Aria assigned ID of the payment. |
|
| payment_date | string | No |
Date on which the invoice was paid. |
|
| payment_amount | double | No |
The payment amount. |
|
| payment_comments | string | No |
Client-defined comments on this payment transaction. |
|
| payment_source | string | No |
The reference number of a payment. |
|
| proc_payment_id | string | No |
The payment processor assigned ID of the payment. |
|
| payment_method_no | long | 22 | No |
The name of the payment method used. |
| payment_method_type | long | No |
Integer values for the Aria supported payment method types. |
|
| payment_source_description | string | No |
Returns the description of the payment source associated with the payment, if previously provided. |