Contents x
    List Remittance Runs
    • 21 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    List Remittance Runs

    • Updated on 21 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    This will return remittance runs for a merchant.

    URL

    GET /api/remittance/{merchantId}/runs 

    Path Parameters

    Merchant ID  

    Required 

    String [0..10] characters 

    The merchant ID 

    Query Parameters

    Name

    Description

    Example

    page 

    (optional) 

    Page No. (starting 0) 

    ?page=0 

    size 

    (optional) 

    Page size (starting 1) 

    ?size=1 

    bankAccountId 

    (optional) 

    Bank account guid collection 

    ?bankAccountId=0c6a36ba-10e4-438f-ba86-0d5b68a2bb15&bankAccountId=13270dcb-1e80-428e-a3c3-2bd5d1e0428d 

    status 

    (optional) 

    Following are the various status values that can be passed in 

    ON_HOLD (KYC/AML not approved/pre-approval)  

    PENDING (expected remittance date not reached)  

    GENERATED (remittance run has been generated)  

    TRANSFERRED (remittance file has been uploaded)  

    COMPLETED (remittance has been submitted or completed) 

    ?status=ON_HOLD 

    from 

    (optional) 

    From date 

    ?from=01-01-2023 

    to 

    (optional) 

    To date 

    ?to=31-12-2023 

    Page and size query parameters

    Page and size parameters can be used for navigating across large records. 
    The size query parameter restricts the number of records that the API can return for a given request. Page numbers can be increased to get the next set of records. 
    The total number of pages required can be calculated based on the total record count returned in the response header “X-Total-Count”. 
    The page number starts from 0. Pagination would be applied only when both page and size parameters are provided. 

    Example

    If page size is 200, and total records to be returned are 650, then records can be accessed by increasing page number from 0 to 3. 
    Total required pages can be calculated from formula like “(650/200) + (650%200) > 0? 1 :0 = 4” 
    page = 0, size = 200 => returns 200 records 
    page = 1, size = 200 => returns 200 records 
    page = 2, size = 200 => returns 200 records 
    page = 3, size = 200 => returns 50 records 

    Note

    With a filter of ‘page’ and ‘size’ it will be applied to COMPLETED remittance statuses and return credit runs and corresponding debits. If ‘bankAccountId’ filter is present it will be applied to all remittance statuses 

    Was this article helpful?
    What's Next