Menu
Menu
Menu
Retrieve details for a transaction. You can also request the following subresources for the transaction: the credit Financial Account details, the credit Financial Account balances, the debit Financial Account details, the credit Financial Account balances, the Recipient Account that owns the debit Financial Account, and the Provider details.
GET /v1/transactions/{transactionId}
Authorization: Bearer <access_token>
transactionId REQUIRED
string (UUID)
ID of the transaction in the RocketKOR system.
embed
string, values: creditFinancialAccount, creditFinancialAccount.balances, debitFinancialAccount, debitFinancialAccount.recipient, transactionProviderDetails
Specify subresources to embed in the response. The subresources are returned in the _embedded object. The following subresources can be requested:
Use a comma-separated list to return multiple subresources (example: creditFinancialAccount,creditFinancialAccount.balances).
None
Returns the Transaction object. This object contains the transaction details, including a unique ID for the transaction.
The _embedded object contains any requested subresources, including:
SAMPLE RESPONSE
{
"id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"transactionType": "SEND",
"solution": "ach",
"paymentReasonId": "loan-payouts",
"paymentReason": "Loan Payouts",
"amount": "1000.00",
"currency": "USD",
"settlementPriority": "SAME_DAY",
"latestStatus": {
"status": "NEW",
"message": "Transaction creation successful",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z"
},
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z",
"reversalReason": "",
"description": "",
"memo": ""
"_embedded": {
"creditFinancialAccount": {
"id": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"name": "Savings",
"defaultFlag": true,
"currency": "USD",
"state": "ACTIVE",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-08T21:10:51.610Z",
"updatedBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"updatedAt": "2021-07-09T21:10:51.610Z",
"accountType": "EXTERNAL",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "RECIPIENT",
"bankAccount": {
"type": "CHECKING",
"bankName": "CitiBank",
"routingNo": "321171184",
"accountNumber": "89674523",
"nameOnAccount": "Mark Strong",
"businessName": "GLOBAL"
},
"_embedded": {
"balances": {
"USD": {
"accountBalance": "1000.00",
"availableBalance": "800.00",
"pendingWithdrawals": "200.00",
"pendingDeposits": "500.00"
},
"CAD": {
"accountBalance": "600.00",
"availableBalance": "550.00",
"pendingWithdrawals": "50.00",
"pendingDeposits": "300.00"
}
}
}
},
"debitFinancialAccount": {
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"businessAccountId": "d7e3d57b-c2e2-4964-95a0-29ad87ab0f05",
"name": "Debit Card",
"defaultFlag": true,
"currency": "USD",
"state": "ACTIVE",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-08T21:10:51.610Z",
"updatedBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"updatedAt": "2021-07-09T21:10:51.610Z",
"accountType": "EXTERNAL",
"accountHolderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accountHolderType": "RECIPIENT",
"card": {
"firstName": "Mark",
"middleName": "David",
"lastName": "Strong",
"type": "DEBIT",
"expiry": "2027-12",
"billingAddress": {
"addressLine1": "625 Queen St",
"addressLine2": "",
"addressLine3": "",
"city": "Vancouver",
"state": "BC",
"country": "Canada",
"postalCode": "V5K 0A1"
},
"cardNumber": "84563876999",
},
"_embedded": {
"balances": {
"USD": {
"accountBalance": "1500.00",
"availableBalance": "1300.00",
"pendingWithdrawals": "200.00",
"pendingDeposits": "100.00"
},
"CAD": {
"accountBalance": "1600.00",
"availableBalance": "1200.00",
"pendingWithdrawals": "400.00",
"pendingDeposits": "300.00"
}
}
},
"_embedded": {
"recipient": {
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessRefId": "RECIP001",
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"secondLastName": "",
"email": "jsmith@xyz.com",
"phoneNumber": "4161234567",
"nationality": "Canadian",
"dateOfBirth": "1970-07-08",
"additionalInformation": "",
"recipientType": "INDIVIDUAL",
"businessName": "",
"state": "ACTIVE",
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"createdAt": "2021-09-20T22:09:31.947Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"updatedAt": "2021-10-20T22:09:31.947Z",
"requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3"
}
}
},
"transactionProviderDetails": {
"mastercard-send": {
"disbursementId": "string",
"paymentType": "BDB",
"mcc": "6536",
"cardAcceptorId": "CardAcceptor123",
"network": "MasterCard",
"networkStatusCode": "00",
"networkStatusDescription": "Approved",
"fundsAvailability": "IMMEDIATE",
"statementDescriptor": "CLAIM 12345"
}
}
}
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.