SchemaReportingSettlement

List batches

Retrieve batch data for a specific date.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional

Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.

afterstringOptional

Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.

limitintegerOptional<=100Defaults to 10

States the total amount of results the response is limited to.

datestringRequiredformat: "date"

Date that the merchant submitted the batch. The format of this value is YYYY-MM-DD.

merchantIdstringOptional

Unique identifier of the merchant.

Response

Successful request. Returns a paginated list of batches.

datalist of objects

Array of batch objects.

countintegerOptional

Number of results that we returned.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.