Settlement

Retrieve batch

Changed on

Use this method to retrieve information about a batch.

Note: To retrieve a batch, you need its batchId. If you don't have the batchId, use our List Batches method to search for the batch.

Our gateway returns the following information about the batch:

  • Transaction information, including the number of transactions and total value of sales.
  • Merchant information, including the merchant ID (MID) and the processing account that the batch is associated with.
get/batches/{batchId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/batches/{batchId}
  • Auth
    HTTP bearer

Path parameters

batchIdinteger required

Unique identifier that we assigned to the batch.

Response

Successful request. Returns the requested batch.

batchIdinteger

Unique identifier that we assigned to the batch.

datestring date

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

createdDatestring date

Date that we created a record for the batch. The format of this value is YYYY-MM-DD.

lastModifiedDatestring date

Date that the batch was last changed. The format of this value is YYYY-MM-DD.

saleAmountinteger

Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.

heldAmountinteger

Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.

returnAmountinteger

Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.

transactionCountinteger

Total number of transactions in the batch.

currencystring

Currency of the transactions in the batch. The value for the currency follows the ISO 4217 standard.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieveBatch removed and replaced with settlement_retrieveBatch