Design / Transaction Use Cases / Search Transactions
Search Transactions
Overview
In this use case, we’ll walk through searching for transactions based on filters such as the provider, status, requestor, and receiver. For example, you could retrieve all transactions for a specific Business Account or Recipient Account, or retrieve all transactions with a specific status.
Note The search is limited to transactions for the Business Account associated with the API key included in the request.
API Operation
Steps
Send a request to the following endpoint:
GET /api/external/v1/transactions
- Filter the results based on fields such as provider, requestorId, receiverId, amountFrom, amountTo, and latestStatus. For a full list of possible filters, see the API Reference.
- Use the sort query parameter to sort the results.
- Use the page and size query parameters to limit the number of results returned.
- Request body is not required.
- Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.
Sample Response
Returns a paginated response with an array of transaction objects. Details are returned for each transaction.
{
"totalElements": 100,
"totalPages": 100,
"number": 1,
"numberOfElements": 1,
"hasNext": true,
"content": [
{
"id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"createdAt": "2021-07-01T17:40:22.601Z",
"debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"debitFinancialAccountSnapshotId": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
"maskedDebitAccountNumber": "**** 5784",
"creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"creditFinancialAccountSnapshotId": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
"maskedCreditAccountNumber": "**** 6999",
"paymentReasonId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"paymentReason": "Loan payouts",
"amount": 1000.00,
"provider": "MC_SEND",
"currency": "USD",
"countryCode": "CAN",
"requestorId": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
"requestorType": "BUSINESS_ACCOUNT",
"requestedSendDate": "",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"receiverId": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
"receiverType": "RECIPIENT",
"recipientDto": {
"id": "9kj43t32-2956-2886-x7dy-6r821w39kra3",
"requestorId": "8hb21a87-3985-9217-a6zq-5y643x47hsa7",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2021-07-01T17:40:22.601Z",
"businessRefId": "6ja43q62-0978-2536-b5ap-4i872q65kjt3",
"createdSource": "SDK iOS",
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"secondLastName": "",
"email": "jsmith@xyz.com",
"phoneNumber": "4161234567",
"nationality": "Canadian",
"dateOfBirth": "1970-07-08",
"additionalInformation": "",
"recipientType": "INDIVIDUAL",
"businessName": ""s
"state": "ACTIVE"
},
"latestStatus": {
"id": "7wd40g39-2150-2435-c3hy-3c216e28bzj0",
"createdAt": "2021-07-01T17:40:22.601Z",
"transactionId": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"status": "NEW",
"message": "Transaction creation successful"
}
}
]
}
