Retrieve details for a multi-leg transaction (MLT). The response includes details for the overall MLT as well as the debit (funding leg) and credit (disbursement leg) transactions created for the MLT. You can also request details for the Financial Accounts used in the MLT debit and credit transactions.
The response includes an ETag (entity tag) header with an identifier that represents the current status of the resource. This identifier must be provided when updating a multi-leg transaction.
GET /v1/multi-leg-transactions/{mltId}
Authorization: Bearer <access_token>
mltId REQUIRED
string (UUID)
ID of the multi-leg transaction (MLT) in the RocketKOR system.
embed
string, values: fromAccountHolderId, fromFinancialAccount, toAccountHolderId, toFinancialAccount
Specify subresources to embed in the response. The following subresources can be requested:
Use a comma-separated list to return multiple subresources (example: fromAccountHolderId,toAccountHolderId).
None
Returns an ETag (entity tag) header with an identifier that represents the current status of the resource. This identifier must be provided when updating the multi-leg transaction.
Returns the Multi-Leg Transaction Detail object. This object contains detailed information for the multi-leg transaction (MLT), including information about the MLT, details for the individual debit and credit transactions, and detailed information for the Financial Accounts used in the debit and credit transactions.
SAMPLE RESPONSE
{
"currency": "USD",
"totalAmount": "1200.00",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"name": "MLT-123",
"description": "",
"memo": "",
"id": "9b4aff10-ad49-4f72-ae77-204a28f60196",
"businessAccountId": "32edfac0-edbd-47f5-aff9-a030b1883cce",
"stage": "FUNDING",
"status": "PENDING",
"debitAmountPending": "1200.00",
"debitAmountCleared": "",
"creditAmountPending": "1200.00",
"creditAmountSettled": "",
"debits": [
{
"sequence": 0,
"financialAccountId": "89947c99-1ef5-4b30-ba9c-c1103196b0c9",
"maskedAccountNumber": "******6790",
"paymentReasonId": "funds_transfer",
"amount": "1200.00",
"amountPercentage": "",
"settlementPriority": "SAME_DAY",
"transactionId": "c0555c1a-0699-4ff4-aa9d-cd2724832be4",
"solution": "ach",
"latestStatus": {
"status": "NEW",
"message": "2023-12-11T01:09:27.246Z",
"createdBy": {
"id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
"type": "employee"
},
"createdAt": "2023-12-11T01:09:27.246Z"
},
"_embedded": {
"financialAccount": {
"name": "Checking",
"category": "EXTERNAL",
"accountHolderType": "CUSTOMER",
"type": "BANK",
"subtype": "CHECKING",
"bankAccount": {
"bankName": "Citibank",
"nameOnAccount": "Mark Strong"
},
"maskedAccountNumber": "******6790"
},
"accountHolderId": "99b501a9-37c9-4868-ae3e-34ffbd28a1c8"
},
"financialAccount": {
"name": "Checking",
"category": "EXTERNAL",
"accountHolderType": "CUSTOMER",
"type": "BANK",
"subtype": "CHECKING",
"bankAccount": {
"bankName": "Citibank",
"nameOnAccount": "Mark Strong",
"routingNo": "321171184",
"accountNumber": "17-123-6790",
"accountNumberTail": "6790",
"businessName": "ABC Corporation",
"address": {
"addressLine1": "625 Queen St",
"addressLine2": "Suite 201",
"addressLine3": "South Building",
"city": "Vancouver",
"stateCode": "BC",
"countryCode": "CAN",
"postalCode": "V5K 0A1"
}
},
"maskedAccountNumber": "******6790",
"token": "efvm5t4cw43ef4rfvcr",
"provider": "provider",
"currency": "USD",
"id": "89947c99-1ef5-4b30-ba9c-c1103196b0c9",
"state": "ACTIVE",
"sponsorFinancialAccountId": "",
"financialInstitutionId": "",
"parentId": "67874324-2c1e-4764-8712-f47600f5d402",
"accountRoles": "DEFAULT",
"accountHolderId": "99b501a9-37c9-4868-ae3e-34ffbd28a1c8",
"businessAccountId": "32edfac0-edbd-47f5-aff9-a030b1883cce",
"version": "1",
"externalBalanceAmount": "",
"externalBalanceEffectiveAt": "",
"restrictions" {
"solution": "",
"transactionType": "",
"withholdingPeriod": "",
"inherited": false,
}
},
"paymentReason": "Funds Transfer",
"provider": "ACH Provider",
"metadata": {
"description": "my description"
}
}
],
"credits": [
{
"sequence": 0,
"financialAccountId": "4c076ddc-0bf0-4c7c-a62d-079d7672cbec",
"maskedAccountNumber": "******4325",
"paymentReasonId": "funds_transfer",
"amount": "1200.00",
"amountPercentage": "",
"settlementPriority": "SAME_DAY",
"transactionId": "f0e04c6d-d293-47a1-bdec-dc56ccef8de4",
"solution": "ach",
"latestStatus": {
"status": "NEW",
"message": "2023-12-11T01:09:27.246Z",
"createdBy": {
"id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
"type": "employee"
},
"createdAt": "2023-12-11T01:09:27.246Z"
},
"_embedded": {
"financialAccount": {
"name": "Checking",
"category": "EXTERNAL",
"accountHolderType": "CUSTOMER",
"type": "BANK",
"subtype": "CHECKING",
"bankAccount": {
"bankName": "Citibank",
"nameOnAccount": "Jane Smith"
},
"maskedAccountNumber": "******4325"
},
"accountHolderId": "64fff1fb-619e-4a07-80ad-ac484f2c1087"
},
"financialAccount": {
"name": "Checking",
"category": "EXTERNAL",
"accountHolderType": "CUSTOMER",
"type": "BANK",
"subtype": "CHECKING",
"bankAccount": {
"bankName": "Citibank",
"nameOnAccount": "Jane Smith",
"routingNo": "321171184",
"accountNumber": "17-123-4325",
"accountNumberTail": "4325",
"businessName": "XYZ Company",
"address": {
"addressLine1": "100 Main St",
"addressLine2": "Suite 100",
"addressLine3": "",
"city": "Toronto",
"stateCode": "ON",
"countryCode": "CAN",
"postalCode": "M4B 2J8"
}
},
"maskedAccountNumber": "******4325",
"token": "klom5t4mn73ef5rfdvd",
"provider": "provider",
"currency": "USD",
"id": "4c076ddc-0bf0-4c7c-a62d-079d7672cbec",
"state": "ACTIVE",
"sponsorFinancialAccountId": "",
"financialInstitutionId": "",
"parentId": "26b872fe-7e59-4a8e-871c-ae6543acdd85",
"accountRoles": "DEFAULT",
"accountHolderId": "64fff1fb-619e-4a07-80ad-ac484f2c1087",
"businessAccountId": "32edfac0-edbd-47f5-aff9-a030b1883cce",
"version": "1",
"externalBalanceAmount": "",
"externalBalanceEffectiveAt": "",
"restrictions" {
"solution": "",
"transactionType": "",
"withholdingPeriod": "",
"inherited": false,
}
},
"paymentReason": "Funds Transfer",
"provider": "ACH Provider",
"metadata": {
"description": "my description"
}
}
],
"createdBy": {
"id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
"type": "employee"
},
"createdAt": "2023-12-11T01:09:27.246Z",
"updatedBy": {
"id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
"type": "employee"
},
"updatedAt": "2023-12-12T01:09:27.246Z",
"version": 2,
"parentId": "01dc88fc-9e9a-47c0-b5c2-139d20356785"
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
