INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Transaction Use Cases  /  Retrieve Details for a Transaction

Retrieve Details for a Transaction

Overview

In this use case, we’ll walk through retrieving the details for a transaction.

Tip  You can also search for transactions based on filters such as the provider, status, requestor, and receiver.

API Operation

Steps

Send a request to the following endpoint:

GET /api/external/v1/transactions/{id}

  • Use the {id} path parameter to specify the ID of the transaction you want to retrieve.
  • Filter the results by the provider facilitating the transaction.
  • 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

The transaction details are returned, including the transaction’s current status.

				
					{
  "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": "",
    "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"
  },
  "debitFinancialAccountSnapshot": {
    "id": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
    "createdAt": "2021-07-07T00:43:53.571Z",
    "financialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
    "maskedAccountNumber": "**** 5784",
    "bankAccount": {
      "token": "8f8ee4f9-826d-43fe-bb15-3d737f4c2b58",
      "type": "CHECKING",
      "businessName": "ACME",
      "bankName": "CIBC",
      "routingNo": "001032352",
      "accountNumber": "12345678",
      "nameOnAccount": "Bill Smith"
    }
  },
  "creditFinancialAccountSnapshot": {
    "id": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
    "createdAt": "2021-07-07T00:43:53.572Z",
    "financialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
    "maskedAccountNumber": "**** 6999",
    "card": {
      "id": "20b109f3-a339-46b3-881f-0f849aa022b1",
      "token": "ac586ef8-af78-4e94-8f87-2c9e48f274d8",
      "firstName": "Mark",
      "middleName": "David",
      "lastName": "Strong",
      "type": "DEBIT",
      "cardNumber": "84563876999",
      "expiry": {
        "year": 2022,
        "month": "JANUARY",
        "monthValue": 1,
        "leapYear": false
      },
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    }
  }
}
				
			
ON THIS PAGE