Multigate
  1. 💸 Payments
Multigate
  • 🚀 Getting Started
  • 🔓 Authentication
    • Get Token
    • Refresh Token
    • Logout User
  • 👋 Onboarding
    • Create Subclient
    • Get All Subclients
    • Get Subclient
    • Update Subclient
    • Create Subclient Shareholder
    • Get Subclient Shareholders
    • Update Subclient Shareholder
    • Upload Subclient Documents
    • Get Subclient Documents
    • Delete Subclient
    • Submit Subclient
  • 💰 Accounts
    • 📄 Statements
      • Get Statement
    • Create Virtual Account
    • Get Account
    • Get Accounts By
    • Get All Accounts
    • Simulate Inflow (UAT only)
  • 🔃 Conversions
    • Get Quote
    • Lock Rate
    • Get Trade
    • Get All Trades
  • 💸 Payments
    • 🏦 Banks
      • Get Bank Details
    • 👤 Beneficiaries
      • Create Beneficiary
      • Get All Beneficiaries
      • Get Beneficiary
      • Update Beneficiary
      • Validate Beneficiary Account (NGN only)
    • Create Single Transfer
      POST
    • Get Purpose Codes
      GET
    • Get Transfer Fields & Fees
      POST
    • Find Transfers
      GET
  • 📩 Webhooks / Push Notifications
    • Add a New Client Configuration
    • Update Client Configuration Current Mode
    • Get Client Configuration
  1. 💸 Payments

Find Transfers

GET
/payment-service/api/v1/transaction/report
Transaction
Filter transactions based on provided filter criteria and return paginated results.

Request

Query Params
onBehalfOf
string 
optional
transactionId
string 
optional
uniqueRequestId
string 
optional
batchId
string 
optional
internalStatus
string 
optional
status
string 
optional
sourceCurrencyIso3Code
string 
optional
isApprovalNeeded
boolean 
optional
startDate
string <date-time>
optional
endDate
string <date-time>
optional
pageNumber
integer 
optional
Default:
1
pageSize
integer 
optional
Default:
10

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/payment-service/api/v1/transaction/report?onBehalfOf&transactionId&uniqueRequestId&batchId&internalStatus&status&sourceCurrencyIso3Code&isApprovalNeeded&startDate&endDate&pageNumber&pageSize'

Responses

🟢200OK
application/json
Filtered transactions successfully fetched
Body
totalItems
integer 
optional
currentPage
integer 
optional
pageSize
integer 
optional
totalPages
integer 
optional
data
array[object (SingleTransferResponse) {20}] 
optional
onBehalfOf
string  | null 
optional
uniqueRequestId
string 
optional
sourceBankBicOrCode
string 
optional
transferType
string 
optional
sourceAccountNumber
string 
optional
sourceCurrencyIso3Code
string 
optional
sourceCountryIso3Code
string 
optional
beneficiaryDetails
object (BeneficiaryDetails) 
optional
approvedBy
string  | null 
optional
totalAmount
number 
optional
amount
number 
optional
charge
number 
optional
chargesType
string 
optional
transactionId
string 
optional
status
string 
optional
createdAt
string <date-time>
optional
updatedAt
string <date-time>
optional
responseMessage
string 
optional
responseCode
string 
optional
reference
string 
optional
Example
{
  "totalItems": 0,
  "currentPage": 0,
  "pageSize": 0,
  "totalPages": 0,
  "data": [
    {
      "onBehalfOf": "string",
      "uniqueRequestId": "string",
      "sourceBankBicOrCode": "string",
      "transferType": "string",
      "sourceAccountNumber": "string",
      "sourceCurrencyIso3Code": "string",
      "sourceCountryIso3Code": "string",
      "beneficiaryDetails": {
        "accountNumber": "string",
        "accountName": "string",
        "bankName": "string",
        "bankCode": "string",
        "intermediaryBank": {
          "bankName": "string",
          "bankCode": "string",
          "swiftCode": "string"
        }
      },
      "approvedBy": "string",
      "totalAmount": 0,
      "amount": 0,
      "charge": 0,
      "chargesType": "string",
      "transactionId": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "responseMessage": "string",
      "responseCode": "string",
      "reference": "string"
    }
  ]
}
🟠400Bad Request
🟠404Record Not Found
Previous
Get Transfer Fields & Fees
Next
📩 Webhooks / Push Notifications
Built with