Guides

How to Use the Report Module

Suggest Edits

The Report Module provides endpoints for generating reports on beneficiaries, transfers, and transaction searches. This guide explains each endpoint, its parameters, and how to use it. The Report Module offers five endpoints:

  1. Get Beneficiary Report: Retrieves a list of beneficiaries based on specified filters.
  2. Get Transfer Report: Retrieves a list of transfers based on specified filters.
  3. Get Transfers Report By Beneficiary: Retrieves transfer details for a specific beneficiary.
  4. Search Transfer Methods: Searches for transfer methods associated with a beneficiary.
  5. Transaction Search: Searches for transactions based on provided criteria.

📘

Authentication

All API calls require authentication using an API key and a merchant identifier (GUID). Refer to the Authentication page for more details.

Get Beneficiary Report

This endpoint allows you to retrieve a list of beneficiaries based on various filters such as country, name, and email. It supports pagination, enabling you to manage large datasets by specifying the page number and size. Use the Get Beneficiary Report endpoint to generate detailed beneficiary reports matching your search criteria. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url "https://merchantapi.testewallet.com/api/v1//reports/beneficiaries?country=US&firstName=John&lastName=Doe&userName=johndoe&[email protected]&beneficiaryToken=3fa85f64-5717-4562-b3fc-2c963f66afa6&pageNumber=1&pageSize=10" \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Beneficiary report retrieved successfully.",
  "statusCode": 200,
  "logIdentifier": "abc123456789",
  "data": {
    "totalCount": 1,
    "pageNumber": 1,
    "pageSize": 10,
    "pageCount": 1,
    "beneficiaryDetails": [
      {
        "customerToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "username": "johndoe",
        "emailAddress": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Doe Enterprises",
        "phoneNumber": "+1-555-555-5555",
        "cellPhoneNumber": "+1-555-555-5556",
        "address": "123 Main St",
        "address2": "Apt 4B",
        "state": "NY",
        "city": "New York",
        "zipCode": "10001",
        "country": "US",
        "dateOfBirth": "1985-05-15T00:00:00.000Z",
        "preferredLanguage": "en",
        "isSuspended": false,
        "isInfoVerified": true,
        "isClosed": false,
        "createdDate": "2024-08-01T12:00:00.000Z",
        "customerID": 123456
      }
    ]
  }
}

Get Transfer Report

This endpoint provides detailed transfer information filtered by criteria such as beneficiary token, transfer token, and merchant transaction ID. It supports pagination, making it easy to navigate through multiple transfer records. Use The Get Transfer Report Data endpoint to track and report on transfers within your system. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url "https://merchantapi.testewallet.com/api/v1/reports/transfers?beneficiaryToken=3fa85f64-5717-4562-b3fc-2c963f66afa6&transferToken=abc123def456&merchantTransactionId=txn789&destinationTypeId=1&sourceCurrency=USD&destinationCurrency=EUR&startDate=2024-08-01T00:00:00.000Z&endDate=2024-08-15T23:59:59.999Z&minSourceAmount=100.00&maxSourceAmount=1000.00&statusId=1&pageNumber=1&pageSize=10" \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Transfer report retrieved successfully.",
  "statusCode": 200,
  "logIdentifier": "log123456789",
  "data": {
    "totalCount": 1,
    "pageNumber": 1,
    "pageSize": 10,
    "pageCount": 1,
    "transfersDetails": [
      {
        "merchantTransactionID": "txn789",
        "customerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "destinationTypeID": 1,
        "sourceAmount": 500.00,
        "sourceCurrency": "USD",
        "destinationAmount": 450.00,
        "destinationCurrency": "EUR",
        "statusID": 1,
        "subStatusID": 0,
        "createdDateUTC": "2024-08-05T10:30:00.000Z",
        "updatedDateUTC": "2024-08-06T12:00:00.000Z",
        "expiryDateUTC": "2024-08-15T12:00:00.000Z",
        "comments": "Transfer completed successfully.",
        "token": "abc123def456",
        "fxRate": 0.9,
        "totalCustomerFee": 5.00,
        "totalMerchantFee": 10.00,
        "destinationToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }
}

Get Transfers Report By Beneficiary

Use the Get Transfer Report Dataendpoint to obtain transfer details for a specific beneficiary, identified by their unique token. It helps narrow down transfer records to a single beneficiary, helping you to focus on individual transactions. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url "https://merchantapi.testewallet.com/api/v1/report/transfers?transferToken=abc123def456&merchantTransactionId=txn789&destinationTypeId=1&sourceCurrency=USD&destinationCurrency=EUR&startDate=2024-08-01T00:00:00.000Z&endDate=2024-08-15T23:59:59.999Z&minSourceAmount=100.00&maxSourceAmount=1000.00&statusId=2&pageNumber=1&pageSize=10" \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Transfer report retrieved successfully.",
  "statusCode": 200,
  "logIdentifier": "log123456789",
  "data": {
    "totalCount": 1,
    "pageNumber": 1,
    "pageSize": 10,
    "pageCount": 1,
    "transfersDetails": [
      {
        "merchantTransactionID": "txn789",
        "customerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "destinationTypeID": 1,
        "sourceAmount": 500.00,
        "sourceCurrency": "USD",
        "destinationAmount": 450.00,
        "destinationCurrency": "EUR",
        "statusID": 1,
        "subStatusID": 0,
        "createdDateUTC": "2024-08-05T10:30:00.000Z",
        "updatedDateUTC": "2024-08-06T12:00:00.000Z",
        "expiryDateUTC": "2024-08-15T12:00:00.000Z",
        "comments": "Transfer completed successfully.",
        "token": "abc123def456",
        "fxRate": 0.9,
        "totalCustomerFee": 5.00,
        "totalMerchantFee": 10.00,
        "destinationToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }
}

Search Transfer Methods

The Get Beneficiary Transfers Methods endpoint lets you search for transfer methods associated with a specific beneficiary. It returns a list of methods, such as bank wires, that are linked to the beneficiary. Unlike other endpoints, this one does not support pagination due to the typically small number of transfer methods. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url "https://merchantapi.testewallet.com/api/v1/reports/transfer-methods?beneficiaryToken=3fa85f64-5717-4562-b3fc-2c963f66afa6&destinationToken=abc123def456&transferType=wireProfile" \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Transfer methods retrieved successfully.",
  "statusCode": 200,
  "logIdentifier": "log123456789",
  "data": {
    "wireProfile": [
      {
        "accountNickName": "John's Business Account",
        "beneficiaryFirstName": "John",
        "beneficiaryLastName": "Doe",
        "beneficiaryCompanyName": "Doe Enterprises",
        "accountNumber": "123456789012",
        "beneficiaryAddress1": "123 Main St",
        "beneficiaryAddress2": "Apt 4B",
        "beneficiaryCity": "New York",
        "beneficiaryState": "NY",
        "beneficiaryZipCode": "10001",
        "beneficiaryCountry": "US",
        "bankName": "Bank of America",
        "bankAddress1": "100 Wall St",
        "bankAddress2": "",
        "bankCity": "New York",
        "bankState": "NY",
        "bankZipCode": "10005",
        "bankCountry": "US",
        "routingNumber": "021000322",
        "swiftCode": "BOFAUS3N",
        "transitNumber": "",
        "financialInstitutionNumber": "",
        "bankCode": "",
        "branchCode": "",
        "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "bankAccount": [
      {
        "accountNickName": "John's Checking Account",
        "beneficiaryFirstName": "John",
        "beneficiaryLastName": "Doe",
        "accountNumber": "9876543210",
        "accountType2": "Checking",
        "beneficiaryAddress1": "123 Main St",
        "beneficiaryAddress2": "Apt 4B",
        "beneficiaryCity": "New York",
        "beneficiaryState": "NY",
        "beneficiaryZipCode": "10001",
        "beneficiaryCountry": "US",
        "bankName": "Chase Bank",
        "bankCountry": "US",
        "routingNumber": "021000021",
        "branchAddress": "123 5th Ave",
        "token": "abc123def456"
      }
    ],
    "creditCardAccount": [
      {
        "creditCardNumber": "4111111111111111",
        "creditCardExpirationDateMonth": "12",
        "creditCardExpirationDateYear": "2025",
        "beneficiaryAddress1": "123 Main St",
        "beneficiaryAddress2": "Apt 4B",
        "beneficiaryCity": "New York",
        "beneficiaryState": "NY",
        "beneficiaryZipCode": "10001",
        "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }
}

Transaction Search

The Search transaction endpoint enables you to search for transactions based on log transaction IDs or merchant reference IDs. It supports pagination, allowing you to browse through transaction logs efficiently. Use this endpoint to locate specific transactions and generate transaction reports. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url "https://merchantapi.testewallet.com/api/v1/reports/transactions?merchantReferenceId=ref123&merchantBatchId=batch456&logTransactionId=txn789&pageNumber=1&pageSize=10" \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Transaction search completed successfully.",
  "statusCode": 200,
  "logIdentifier": "log123456789",
  "data": {
    "totalCount": 1,
    "pageNumber": 1,
    "pageSize": 10,
    "pageCount": 1,
    "transactionLogDetails": [
      {
        "logTransactionId": 789,
        "currencyCode": "USD",
        "amount": 250.00,
        "toUsername": "recipientUser",
        "fromUsername": "senderUser",
        "tranDescription": "Payment for services",
        "tranType": 1,
        "feeType": 0,
        "tranStatus": 1,
        "customerFeeAmount": 5.00,
        "merchantFeeAmount": 10.00,
        "merchantReferenceId": "ref123",
        "merchantBatchId": "batch456",
        "userMemo": "Thank you for your business.",
        "managerComments": "Processed without issues.",
        "transactionTime": "2024-08-01T10:00:00.000Z",
        "lastUpdatedTime": "2024-08-01T10:15:00.000Z",
        "other": "Additional details",
        "globalProfileId": 1001,
        "globalProfileName": "Default Profile",
        "stopPayOnCheckStatus": 0,
        "stopPaymentOnCheckInitiatedBy": 0,
        "stopPaymentOnCheckInitiatedtime": "2024-08-01T10:05:00.000Z",
        "achSubmitDate": "2024-08-01T10:10:00.000Z"
      }
    ]
  }
}

Updated 24 days ago