Skip to main content
Aria Knowledge Central

move_payment_m Guide

The move_payment_m API applies and/or unapplies a specified payment transaction associated with an account.

API Specification: move_payment_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <payment_id>
  • <unapply_trans_id> AND/OR <apply_trans_id>

Additional Guidance

  • Your use case dictates the <unapply_trans_id> and <apply_trans_id> requirement:
    1. Simple unapplication of payment identified by <payment_id>, increasing the balance due on the subscription the payment was associated with while retaining the payment for future application: <unapply_trans_id> is required.
    2. Simple application of payment identified by <payment_id>, applying an existing unapplied payment and to a transaction: <apply_trans_id> is required.
    3. Full movement of a payment identified by <payment_id>, unapplying it from one transaction <unapply_trans_id> and applying it to another <apply_trans_id>: both <unapply_trans_id> and <apply_trans_Id> are required.
Input Fields
Field Name Notes
<unapply_trans_id>, <apply_trans_id>

If you include the same value for these two fields, creating a request to both apply and unapply the same transaction id, Aria returns Error 1016: Invalid input: unapply_trans_id and apply_trans_id cannot be the same.

<do_write>
Allowable Values
Values Description
true true
false false

Error Codes

Error Code/Description Associated Inputs

1016: invalid input

Additional Comments:  This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.

<unapply_trans_id>, <apply_trans_id>

 

  • Was this article helpful?