Open Batch

​

Open a new settlement batch for a processor.

Headers
  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

    values
    • application/json
  • Content-Type
    enum
    const:  
    application/json
    required

    Request payload format. Must be application/json when a body is sent.

    values
    • application/json
Body·BatchOpenRequest
required
application/json

Payload for opening a new batch for a processor.

  • processor_batch_id
    Type: string · Processor Batch Id
    required
  • terminal_id
    Type: string · Terminal Id
    required
Responses
  • application/json
  • application/json
Request Example for post/v1/batches/open
curl https://api.uat.koard.com/v1/batches/open \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "processor_batch_id": "",
  "terminal_id": ""
}'

{
  "account_id": "string",
  "batch_metadata": null,
  "captured_amount": 0,
  "closed_at": null,
  "id": "string",
  "opened_at": "2026-04-20T15:32:06.309Z",
  "processor_batch_id": null,
  "processor_config_id": "string",
  "processor_name": "string",
  "refunded_amount": 0,
  "response": null,
  "status": "open",
  "terminal_id": "string",
  "transaction_count": 0
}

Successful Response