Search Multi-Leg Transactions

createdDateFrom

string (date), format: yyyy-MM-dd

Date the multi-leg transaction (MLT) was created in the RocketKOR system. This filter will return MLTs created on or after this date.

Note  The date is interpreted using the time zone specified in the timeZone filter. UTC format is used if timeZone is not provided.

createdDateTo

string (date), format: yyyy-MM-dd

Date the multi-leg transaction (MLT) was created in the RocketKOR system. This filter will return MLTs created on or before this date.

Note  The date is interpreted using the time zone specified in the timeZone filter. UTC format is used if timeZone is not provided.

timeZone

string (timeZone), default value: UTC

Time zone for the createdDateFrom and createdDateTo filters. The following values are supported:

• Z, UTC or GMT  UTC
• {+,-}N(N)(:MM)  Zone offset in hours and minutes
• UTC+<offset>, UTC-<offset>, GMT+<offset>, GMT-<offset>
• IANA Time Zone Database region ID (example: the value for America/New_York is -04)

debitFinancialAccountId

string (UUID)

ID of the debit Financial Account. This account is used in the MLT funding leg.

creditFinancialAccountId

string (UUID)

ID of the credit Financial Account. This account is used in the MLT disbursement leg.

maskedDebitAccountNumber

string

Masked account number of the debit Financial Account. This account is used in the MLT funding leg.

maskedCreditAccountNumber

string

Masked account number of the credit Financial Account. This account is used in the MLT disbursement leg.

totalAmountFrom

number

Total amount of the multi-leg transaction (MLT). This filter will return MLTs with an amount equal to or greater than this amount.

totalAmountTo

number

Total amount of the multi-leg transaction (MLT). This filter will return MLTs with an amount equal to or less than this amount.

name

string

Descriptive name for the multi-leg transaction (MLT).

stage

string enum, values: FUNDING, DISBURSING, CANCELLING

Current stage of the multi-leg transaction (MLT). The following values are supported:

• FUNDING  A new MLT has been created in RocketKOR. The MLT will remain in the FUNDING stage until all of the debit (funding leg) transactions have cleared or the MLT is cancelled.
• DISBURSING  The debit (funding leg) transactions have cleared, and the MLT has transitioned to the disbursement leg.
• CANCELLING  The MLT has been cancelled.

status

string enum, values: PENDING, PROCESSING, FAILED, CANCELLED, COMPLETE

Current status of the multi-leg transaction (MLT). The following values are supported:

• PENDING  The MLT is waiting to be processed.
• PROCESSING  The MLT debit (funding leg) and credit (disbursement leg) transactions are being processed.
• FAILED  One or more of the MLT transactions has failed. Other transactions may in process or completed. For possible ways to resolve a failed MLT, see the Update an MLT and Cancel an MLT APIs.
• CANCELLED  The MLT has been cancelled.
• COMPLETE  The MLT credit (disbursement leg) transactions have been completed.

parentId

string (UUID)

ID of the schedule that created the multi-leg transaction (MLT). Applies to scheduled MLTs only.

embed

string, values: fromAccountHolderId, fromFinancialAccount, toAccountHolderId, toFinancialAccount

Specify subresources to embed in the response. The following subresources can be requested:

• fromAccountHolderId  ID of the account holder for the debit Financial Account.
• fromFinancialAccount  Details for the debit Financial Account.
• toAccountHolderId  ID of the account holder for the credit Financial Account.
• toFinancialAccount  Details for the credit Financial Account.

Use a comma-separated list to return multiple subresources (example: fromAccountHolderId,toAccountHolderId).

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.