Retrieve batch | Payroc | Documentation

using RestSharp;
var client = new RestClient("https://api.payroc.com/v1/batches/12345");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);

{
  "batchId": 65,
  "date": "2024-07-02",
  "createdDate": "2024-07-02",
  "lastModifiedDate": "2024-07-02",
  "saleAmount": 100,
  "heldAmount": 0,
  "returnAmount": 0,
  "transactionCount": 10,
  "currency": "USD",
  "merchant": {
    "merchantId": "4525644354",
    "doingBusinessAs": "Pizza Doe",
    "processingAccountId": 38765,
    "link": {
      "rel": "processingAccount",
      "method": "get",
      "href": "https://api.payroc.com/v1/processing-accounts/38765"
    }
  },
  "links": [
    {
      "rel": "transactions",
      "method": "get",
      "href": "https://api.payroc.com/v1/transactions?batchId=65"
    },
    {
      "rel": "authorizations",
      "method": "get",
      "href": "https://api.payroc.com/v1/authorizations?batchId=65"
    }
  ]
}

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.

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](https://docs.payroc.com/api/schema/reporting/settlement/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.

Authentication

AuthorizationBearer

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

Path parameters

batchIdintegerRequired

Unique identifier that we assigned to the batch.

Response

Successful request. Returns the requested batch.

batchIdintegerOptional

Unique identifier that we assigned to the batch.

datedateOptional

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

createdDatedateOptional

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

lastModifiedDatedateOptional

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

saleAmountlongOptional

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

heldAmountlongOptional

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

returnAmountlongOptional

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

transactionCountlongOptional

Total number of transactions in the batch.

currencystringOptional

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

merchantobjectOptional

Object that contains information about the merchant.

linkslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error