Retrieve batch

Browse API reference

GET/batches/{batchId}getbatch

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.

Parameters

Name	In	Type	Description
`batchId`Required	path	`integer`	Unique identifier that we assigned to the batch.

Responses

Successful request. Returns the requested batch.

200 OK · application/json

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

Response schema · 21 fields

batchIdinteger
Unique identifier that we assigned to the batch.
createdDatestringdate
Date that we created a record for the batch. The format of this value is YYYY-MM-DD.
currencystring
Currency of the transactions in the batch. The value for the currency follows the ISO 4217 standard.
datestringdate
Date that the merchant submitted the batch. The format of this value is YYYY-MM-DD.
heldAmountintegerint64
Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.
lastModifiedDatestringdate
Date that the batch was last changed. The format of this value is YYYY-MM-DD.
linksobject[]
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
merchantobject
Object that contains information about the merchant.
- doingBusinessAsstring
  Trading name of the business.
- linkobject
  Object that contains HATEOAS links for the resource.
  - hrefstringrequired
    URL of the target resource.
  - methodstringrequired
    HTTP method that you need to use with the target resource.
  - relstringrequired
    Indicates the relationship between the current resource and the target resource.
- merchantIdstring
  Unique identifier that the processor assigned to the merchant.
- processingAccountIdinteger
  Unique identifier that we assigned to the processing account.
returnAmountintegerint64
Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.
saleAmountintegerint64
Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.
transactionCountintegerint64
Total number of transactions in the batch.

Validation error

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid value",
      "message": "Expected integer, got abc",
      "parameter": "batchId"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

review-settlement-reporting