Overview

A batch payment is any incoming payment into a batch account, which is a type of organization account. Once a batch payment is received, you are expected to split it between multiple customer accounts in your organization. This action is known as Release.

Batch accounts are meant to hold funds for a short period of time (typically less than a day). They serve use cases that deposit accounts cannot serve for compliance reasons. One such use case is send funds representing N businesses from a payment processor (e.g. WePay or Stripe) into N accounts under the same N businesses on Unit.

Batch Account

A batch account is a type of organization account. You may instruct other institutions or payment processors to send funds directly into it, by sharing its routing number and account number.

curl -X GET 'https://api.s.unit.sh/accounts/10104' \
-H "Authorization: Bearer ${TOKEN}"

Example Response

{
  "data": {
    "type": "batchAccount",
    "id": "10104",
    "attributes": {
      "createdAt": "2020-12-09T12:17:49.849Z",
      "name": "Pied Piper batch account",
      "routingNumber": "812345678",
      "accountNumber": "1000000104",
      "balance": 0,
      "hold": 0
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      }
    }
  }
}