Skip to main content
Aria Knowledge Central

record_external_payment_m

  1. Last updated
  2. Save as PDF

Summary

API Name record_external_payment_m
Class transaction_services_m
Update Version 68

Description

Records a payment that was collected from an account holder through a system external to Aria (e.g., a check, wire transfer, cash payment, or a payment processed through a non-integrated payment gateway). This creates a payment transaction in Aria's ledger to keep the account balance accurate without Aria initiating the actual payment collection. The payment is applied to the account's outstanding balance per the configured payment application method.

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 No

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
reference_code string 32 Yes

This code provides a reference correlation to the external payment. This field must be unique for every payment submitted by the client.
payment_amount double 12 Yes

The amount of the payment being/to-be made against the outstanding account balance
comments string 500 No

Additional explanatory text relating to this API call.
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions
external_destination_id long 38 No

The external system from which this payment originated
external_id string 38 No

The ID of the corresponding record to this payment in the external system
payment_received_date string 10 No

Date that the payment was received in yyyy-mm-dd format. This is specified for backdated external payments.
specific_charge_transaction_id object   No

A list of specific charges, see below

See fields below
invoice_no object   No

The Invoice numbers applied to this payment

See fields below
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
payment_application_method long   No

Possible values are 1, 2, 3, 4 or NULL. 1 is FIFO. 2 is FDFO. 3 is None (future manual allocation). 4 is Statement FIFO. If NULL, defaults will be taken from the client parameter DEFAULT_PAYMENT_COLLECTION_METHOD.
specific_master_plan_instances_list object   No

A list of specific master plan instance charges, see below

See fields below
specific_statement object   No

Array of specific statements; applicable only when payment application method or default payment collection method is statement First-In-First-Out (FIFO), see below

See fields below
specific_installment_message_id object   No

Note: This field is deprecated. Aria no longer supports specific_installment_message_id.
payoff_installment_ind long   No

Indicates if payment should be allocated to payoff future installment or future payment plan due. Allowable values are : 0 - Pay only installment due (default), 1 - Payoff installment or payment plan including amount not due yet. If Null, it's treated as the default.
payment_source_description string 40 No

Can be used to populate the actual payment methods (e.g., Visa, Cash) used outside of Aria. If populated, it will also impact what is displayed in the Aria UI Source column for external payments.
client_payment_plan_id string 100 No

Client-defined unique payment plan id. When specified, it will take precedence over other input fields, i.e., invoice_no or statement_no.

Alternative field: payment_plan_no
payment_plan_no long 22 No

Aria-assigned payment plan no. When specified, it will take precedence over other input fields, i.e., invoice_no or statement_no.

Alternative field: client_payment_plan_id
specific_message_id_list object   No

A list of specific email message ID; applicable only when payment application method or default payment collection method is statement First-In-First-Out (FIFO).

See fields below

specific_charge_transaction_id fields

Name Type Length Required Description
specific_charge_transaction_id long 32 No

Unique transaction IDs for specific charges, usually when the account holder makes a purchase that is not part of their normal recurring charges.

invoice_no fields

Name Type Length Required Description
invoice_no long   No

Account holder makes a payment and the check can be applied to specific invoices.

specific_master_plan_instances_list fields

Name Type Length Required Description
master_plan_instance_no long 22 No

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.
client_master_plan_instance_id string 100 No

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.

specific_statement fields

Name Type Length Required Description
statement_no long   No

Statement number
sequential_statement_no string   No

Sequential statement no

specific_message_id_list fields

Name Type Length Required Description
message_id long   No

Unique identifier of message due reminder sent.

Outputs

Name Type Length Required Description
transaction_id long   No

The unique identifier for a given transaction.
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.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.