Design / Transaction Use Cases / Retrieve Transaction Details

Retrieve Transaction Details

Overview

In this use case, we’ll walk through retrieving the details for a transaction. You can also request the following subresources for the transaction:

credit Financial Account details
credit Financial Account balances
debit Financial Account details
credit Financial Account balances
Recipient Account that owns the debit Financial Account
Provider details

Tip You can also search for transactions based on filters such as the creation date, amount, and status.

API Operation

Retrieve a Transaction

Steps

Send a request to the following endpoint:

GET /v1/transactions/{transactionId}

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {transactionId} to specify the ID of the transaction you want to retrieve.
Use the embed query parameter to embed subresources in the request. For details, see the API Reference.
Request body is not required.

Sample Response

The transaction details are returned, including the transaction’s current status and any embedded resources. For details, see the Transaction object.

				
					{
  "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",
    "createdAt": "2021-07-01T17:40:22.601Z"
  },
  "createdAt": "2021-07-01T17:40:22.601Z",
  "createdBy": {
    "id": "3a3d03c0-bdff-464d-9220-7cc198b11bba",
    "type": "EMPLOYEE"
  },
  "reversalReason": "",
  "_embedded": {
    "creditFinancialAccount": {
      "id": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
      "businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
      "name": "Savings",
      "defaultFlag": true,
      "currency": "USD",
      "state": "ACTIVE",
      "createdAt": "2021-07-08T21:10:51.610Z",
      "updatedAt": "2021-07-08T21: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",
      "createdAt": "2021-07-08T21:10:51.610Z",
      "updatedAt": "2021-07-08T21: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",
          "createdAt": "2021-07-08T20:56:35.219Z",
          "updatedAt": "2021-07-08T20:56:35.219Z",
          "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"
      }
    }
  }
}

Retrieve Transaction Details

Overview

API Operation

Steps

Sample Response

ON THIS PAGE