Home > Aria Crescendo Documentation > Aria Crescendo core api > record_external_payment_m

record_external_payment_m

This API is used to record a payment transaction for a payment collected from an account holder without using Aria.

For information on error messages generated by this API, see record_external_payment_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
required-icon.png client_acct_id string 50 Client_defined account identifier.
required-icon.png reference_code string 32 This code provides a reference correlation to the external payment. This field must be unique for every payment submitted at the account level.
required-icon.png payment_amount double 12 The amount of the payment being/to-be made against the outstanding account balance.
  comments string 200 Additional explanatory text relating to this API call.
  client_receipt_id string 50

Client-defined unique alphanumeric identifier used to track related system actions.

Note: Use of special characters will result in an error.
  external_destination_id long 38 The external system from which this payment originated.
  external_id string 38 The ID of the corresponding record to this payment in the external system.
  payment_received_date string 10 Date that the payment was received in yyyy-mm-dd format. This is specified for backdated external payments. Choose a date between the last billed date, and today.
  specific_charge_transaction_id long array 32 Unique transaction IDs for specific charges, usually when the account holder makes a purchase that is not part of their normal recurring charges.
  OR      
  invoice_no long array 22 Account holder makes a payment and the check can be applied to specific invoices.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Field Length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 
 
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.
  payment_application_method long  

How the payment should be applied.

Note: The value that you pass into the this field will override your selection for the Default Payment Collection Method parameter (in the Aria application under Configuration > Payments > Payment Settings).


Allowable values for payment_application_method: 

Values Description
1 FIFO (First In, First Out). (default)
2 FDFO (First Due, First Out).
3 None (future manual allocation).
Start of specific_master_plan_instances_list array
  specific_master_plan_instances_list array   A list of specific master plan instance charges.
  Field Name Field Type Field Length Description
  brd_arrow.gif master_plan_instance_no long   The Aria-assigned unique identifier for master plan instances (MPI). If a single MPI is provided, collection will be attempted for the total or current balance due (based on the client parameter setting) of that MPI. If multiple MPIs are provided, one collection will be attempted for the combined total / current balance due for all MPIs specified. Payment will be automatically applied to the invoice line items for the MPIs provided (first-in, first-out). Note that invoice_no takes precedence over master_plan_instance_no, which in turn takes precedence over client_master_plan_instance_id.
  brd_arrow.gif client_master_plan_instance_id string   The client-defined unique identifier for master plan instances (MPI). If a single MPI is provided, collection will be attempted for the total or current balance due (based on the client parameter setting) of that MPI. If multiple MPIs are provided, one collection will be attempted for the combined total / current balance due for all MPIs specified. Payment will be automatically applied to the invoice line items for the MPIs provided (first-in, first-out). Note that invoice_no takes precedence over master_plan_instance_no, which in turn takes precedence over client_master_plan_instance_id.
End of specific_master_plan_instances_list array
 

Output Arguments

Field Name Field Type Description
transaction_id long The unique identifier for a given transaction.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®