processingTerminals

Close batch for processing terminal

Changed on

Use this method to manually close a batch on a processing terminal.

Our gateway returns a cut-off time that indicates when our gateway closes the batch.

Note: After our gateway closes the batch, the merchant can use the Self-Care Portal to view the details of the batch.

post/processing-terminals/{processingTerminalId}/close-batch

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-terminals/{processingTerminalId}/close-batch
  • Auth
    HTTP bearer

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Response

Successful request. We closed the batch for the processing terminal.

cutOffTimestring required

Time that the processing terminal closes the batch. Our gateway returns this value in HH:mm format and uses the 24-hour clock.

timezonestring required

Time zone of the processing terminal. Our gateway returns this value as an IANA Time Zone Database identifier, for example, America/Chicago or Europe/London.

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 closeBatch removed and replaced with processingTerminals_closeBatch