Skip to main content

Get Settlements Using Merchant Reference Number

GET 
/v1/settlements

Click on Send API Request after entering the required data, to see how to lookup a Settlement using the merchant reference number used in the original request.

Request​

Query Parameters

    merchantRefNum stringrequired

    This is the merchant reference number created by the merchant and submitted as part of the Process Payment request.

    limit number

    Possible values: <= 50

    Default value: 10

    This is the total number of records to return.

    offset number

    Default value: 0

    This is the starting position, where 0 is the first record.

    startDate date

    This is the start date in UTC. Default = 30 days before the endDate.

    endDate date

    This is the end date in UTC. Default = current date and time.

Responses​

OK

Response Headers

  • Content-Type

    string

Schema

    settlements object[]

    An array of Settlements.

    meta

    object

    Contains meta info for the pagination APIs

    numberOfRecords number

    This is the number of records returned in the lookup.

    limit number

    This is the number of records returned per page.

    page number

    This is the page of records on which the lookup starts.

Loading...