externalReferenceId is a reference ID assigned by the originator system for tracking and reconciliation.

This value is not required to be unique and may be reused across multiple credit and debit payment requests. The API does not enforce uniqueness.

externalReferenceId does not provide idempotency. Clients must use the Idempotent-Key request header to prevent duplicate processing.

Payment amount. The payment amount are validated as per the limit set by the payment rails or by the bank for the customer. For the Fedwire payment this will be mapped to {2000} tag.The payment rail limit per transaction are RTP upto 1M$, FedNow upto $500K, Fedwire upto $9,999,999,999.99, Same Day ACH upto 1M$.

Sender payment currency code. The valid country currency code should be per ISO 4217 standard.

This is an optional field. It signifies the payment date on which the Finzly system will pick up the payment to process. The payment date will be default to the current date if it is empty. The valid date format is in [MM-dd-yyyy]. User can set the payment date as current date or future date however, for the payment sets to the current date, the Finzly system may change the date based upon the bank/FI configuration for-instance, If the payment SPEED associated with the ACH [SAMEDAY/REGULAR], FEDWIRE and the last submission cutoff time is passed then the payment date will be set to the next business date, or the payment request will be rejected [as per the bank chosen behavior].

Speed associated with the payment based on the delivery time and fee. The Speed names and associated payment rail can be configured or defined by the bank/financial institutions. The supported payment rails in FinzlyOS are ACH, Fedwire, RTP or FedNow. The following are the standard speed names and payment rails configured by default Economy - [ACH-REGULAR], Economy Plus [ACH-SAMEDAY], Express [FEDWIRE], Instant [FEDNOW or RTP].

Payment notes provided by the payment originator. These notes will be truncated to the maximum allowed length. The notes are passed to the payment network as per the specification such as for ACH upto 10 chars, Fedwire upto 35 chars [Tag 6400 - Beneficiary information], SWIFT upto 140 chars [Tag 70], RTP/FedNow upto 140 chars [ISO 20022 - RmtInf Tag]. The value will be truncated if it exceeds the data length limit.

Payment creditor and account details to which the money will be deposited.

Optional. Party that ultimately originates the collection, when different from creditor. Used to convey an ultimate originator for third-party-originated debit requests (for example, a corporate collecting on behalf of its end customer).

This object is entirely optional. When omitted, the server treats the debit as not having a distinct ultimate creditor. When present, the following conditional rules apply:

• If name is provided, address.city and address.countryCode are required.
• If any address city or countryCode field is provided, name is required. Required when addressLine1 is provided. If addressLine1 is specified, city, state, postalCode, and country must also be provided.

Payment debtor and account details from which the money will be deducted.

Optional. Party that is ultimately debited, when different from debtor. Used to convey the ultimate account holder whose funds are being pulled when the immediate debtor is an intermediary.

This object is entirely optional. When omitted, the server treats the debit as not having a distinct ultimate debtor. When present, the following conditional rules apply:

• If name is provided, address.city and address.countryCode are required.
• If any address city or countryCode field is provided, name is required. Required when addressLine1 is provided. If addressLine1 is specified, city, state, postalCode, and country must also be provided.

Set the payment recurrence based on the available options.