Intraday Statement

GET /remittance-middleware/statement/intraday

This endpoint retrieves the intraday statement for the authenticated partner, providing a detailed breakdown of their payout transactions for the current day. A partner would call this endpoint to obtain a real-time snapshot of their payout activity. The endpoint returns a JSON object containing the partner's account information, transaction details, and balance updates.

Query parameters

startTime string

Window start, inclusive. RFC-3339 UTC.
endTime string

Window end, exclusive. RFC-3339 UTC.
page integer

1-based page number.
pageSize integer

Rows per page, 1-500.
currencyCode string

ISO-4217 ledger currency. Optional when the partner holds exactly one.

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

successss boolean

Indicates whether the request was successful
data object13 fields

Contains the remittance statement data
- accountNumber string
  
  The account number associated with the remittance statement
- currency string
  
  The currency of the remittance statement
- openingBalanceDate string
  
  The date of the opening balance
- closingBalanceDate string
  
  The date of the closing balance
- openingBalanceAmount number
  
  The opening balance amount
- closingBalanceAmount number
  
  The closing balance amount
- details array23 fields
  
  An array of transaction details
  - systemReference string
    
    The system reference of the transaction
  - originalSystemReference string
    
    The original system reference of the transaction
  - direction string
    
    The direction of the transaction (e.g. credit or debit)
  - transactionType string
    
    The type of transaction
  - amount number
    
    The amount of the transaction
  - currency string
    
    The currency of the transaction
  - completedTime string
    
    The time the transaction was completed
  - beneficiaryAccountNumber string
    
    The account number of the beneficiary
  - beneficiaryName string
    
    The name of the beneficiary
  - beneficiaryBankName string
    
    The name of the beneficiary's bank.
  - beneficiaryBankSwiftCode string
    
    The SWIFT code of the beneficiary's bank.
  - beneficiaryPhoneNumber string
    
    The phone number of the beneficiary.
  - beneficiaryAddress string
    
    The address of the beneficiary.
  - beneficiaryCountryCode string
    
    The country code of the beneficiary.
  - payerName string
    
    The name of the payer.
  - payerAddress string
    
    The address of the payer.
  - payerPhoneNumber string
    
    The phone number of the payer.
  - payerEmailAddress string
    
    The email address of the payer.
  - payerCountryCode string
    
    The country code of the payer.
  - payerCurrency string
    
    The currency of the payer.
  - payerBankName string
    
    The name of the payer's bank.
  - remark string
    
    A remark or description of the transaction.
  - valueDate string
    
    The date on which the transaction value is valid.
- currentPage integer
  
  The current page number of the statement.
- totalPages integer
  
  The total number of pages in the statement.
- totalRecords integer
  
  The total number of records in the statement.
- hasMore boolean
  
  A boolean indicating whether there are more records to retrieve.
- netMovementAmount number
  
  The net movement amount used for payout
- balanceReconciled boolean
  
  A boolean indicating if the balance was reconciled
error object2 fields
- code string
  
  The error code returned if an error was encountered
- message string
  
  The error message returned if an error was encountered