SchemaReportingSettlement

List authorizations

Use this method to retrieve a [paginated](https://docs.payroc.com/api/pagination) list of authorizations. Use query parameters to filter the list of results that we return, for example, to search for authorizations linked to a specific merchant. > **Important:** You must provide a value for either the date query parameter or the batchId query parameter. Our gateway returns the following information about each authorization in the list: - Authorization response from the issuing bank. - Amount that the issuing bank authorized. - Merchant that ran the authorization. - Details about the customer's card, the transaction, and the batch.

Authentication

AuthorizationBearer

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

Query Parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.
datedateRequired

Filter transactions by the date that the merchant submitted the batch that contains the transaction. The format of this value is YYYY-MM-DD.

You must provide either the batchId or the date.

batchIdintegerRequired
Filter transactions by the unique identifier of the batch that contains the transaction. You must provide either the batchId or the date.
merchantIdstringOptional
Filter results by the unique identifier that the processor assigned to the merchant.

Response

Successful request. Returns a paginated list of authorizations.
datalist of objects
Array of authorization objects.
countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.

Errors