Cancel a multi-leg transaction (MLT). Any funds that are currently being held for the cancelled MLT will be transferred from the Business Escrow Financial Account to the specified recovery Financial Account.
The response includes an ETag (entity tag) header with an identifier that represents the current status of the resource.
POST /v1/multi-leg-transactions/{mltId}/cancel
Authorization: Bearer <access_token>
mltId REQUIRED
string (UUID)
ID of the multi-leg transaction (MLT) in the RocketKOR system.
recoveryFinancialAccountId REQUIRED
string (UUID)
ID of the Business Financial Account to be used as the recovery account. Any funds being held for the MLT in the Business Escrow Financial Account will be transferred to this account.
Returns an ETag (entity tag) header with an identifier that represents the current status of the resource.
Returns the MLT object. This object contains the MLT details, including details for the individual debit and credit transactions.
SAMPLE REQUEST
{
"recoveryFinancialAccountId": "5993fe58-9d81-4ec4-a174-a04962e8e695"
}
SAMPLE RESPONSE
{
"currency": "USD",
"totalAmount": "1200.00",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"name": "MLT-123",
"description": "",
"memo": "",
"initiatorAccountHolderId": "ebfa3e16-63c4-48e3-ae59-a3194a867269",
"originatingChannel": "EXTERNAL",
"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",
"type": "BANK",
"subtype": "CHECKING",
"bankAccount": {
"bankName": "Citibank",
"nameOnAccount": "Bill Anderson"
},
"maskedAccountNumber": "******6790"
}
}
}
],
"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"
}
}
],
"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": 1,
"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.
