TRANXACT.AI Help

Accounting · Cash Movement

Payment Batches

Money going out. The file is generated in the format the bank accepts — NACHA with its check digits and blocking, or ISO 20022 pain.001 — and transmitting it settles the payables it covers.

Type REST17 operationsBase path /api/accounting/payment-batchesPublished as /api/v1/payment-batches

Download specification (OpenAPI 3.1) Screen: Payment Batches

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › Payment Batches on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableacct.bank_payment_batches · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

17 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/payment-batchesList payment batches

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "batch_no": "BAT-000001",
      "payment_type": "text",
      "file_format": "text",
      "effective_date": "2026-10-30",
      "currency": "USD",
      "item_count": 10,
      "total_amount": "1250.00",
      "status": "draft",
      "file_name": "Example",
      "file_hash": "text",
      "file_content": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/payment-batches?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/payment-batches/{id}Read one payment batches

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "batch_no": "BAT-000001",
  "payment_type": "text",
  "file_format": "text",
  "effective_date": "2026-10-30",
  "currency": "USD",
  "item_count": 10,
  "total_amount": "1250.00",
  "status": "draft",
  "file_name": "Example",
  "file_hash": "text",
  "file_content": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/payment-batchesCreate a payment batches

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
connection_iduuidNoConnection
bank_account_iduuidYesDrawn on
payment_typetextNoType
file_formattextNoFile format
effective_datedateYesEffective date
currencytextNoCurrency

Sample body

{
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "effective_date": "2026-10-30",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payment_type": "text",
  "file_format": "text",
  "currency": "USD"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "batch_no": "BAT-000001",
  "payment_type": "text",
  "file_format": "text",
  "effective_date": "2026-10-30",
  "currency": "USD",
  "item_count": 10,
  "total_amount": "1250.00",
  "status": "draft",
  "file_name": "Example",
  "file_hash": "text",
  "file_content": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"bank_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","effective_date":"2026-10-30","connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","payment_type":"text","file_format":"text","currency":"USD"}'
PUT/api/accounting/payment-batches/{id}Change a payment batches

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
connection_iduuidNoConnection
bank_account_iduuidYesDrawn on
payment_typetextNoType
file_formattextNoFile format
effective_datedateYesEffective date
currencytextNoCurrency

Sample body

{
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "effective_date": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bank_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "batch_no": "BAT-000001",
  "payment_type": "text",
  "file_format": "text",
  "effective_date": "2026-10-30",
  "currency": "USD",
  "item_count": 10,
  "total_amount": "1250.00",
  "status": "draft",
  "file_name": "Example",
  "file_hash": "text",
  "file_content": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"bank_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","effective_date":"2026-10-30"}'
DELETE/api/accounting/payment-batches/{id}Delete a payment batches

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/payment-batches/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/accounting/payment-batches/createCreate

Request body

The keys this action reads (* = required; "one of" lists the only values):

bankAccountId*, paymentType, fileFormat, effectiveDate*, items*, apInvoiceIds; paymentType one of ach|wire|rtp|check|book_transfer; fileFormat one of nacha|iso20022_pain001|fedwire|rtp|manual

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"bankAccountId":"value","paymentType":"value","fileFormat":"value","effectiveDate":"value","items":"value","apInvoiceIds;":"value"}'
POST/api/accounting/payment-batches/{id}/approveApprove

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/payment-batches/{id}/generateGenerate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

description

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/generate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"value"}'
GET/api/accounting/payment-batches/{id}/fileFile

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/file" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/payment-batches/{id}/transmitTransmit

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

traceNumber

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transmit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"traceNumber":"value"}'
POST/api/accounting/payment-batches/{id}/acknowledgeAcknowledge

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

accepted, bankReference, reason

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/acknowledge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accepted":"value","bankReference":"value","reason":"value"}'
POST/api/accounting/payment-batches/proposePropose

Request body

The keys this action reads (* = required; "one of" lists the only values):

horizonDays, bankAccountId

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/propose" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"horizonDays":"value","bankAccountId":"value"}'
GET/api/accounting/payment-batches/{parentId}/itemsItems

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/payment-batches/{parentId}/itemsItems

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/payment-batches/{parentId}/items/{lineId}Items

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/payment-batches/{parentId}/items/{lineId}Items

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/payment-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/items/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a payment batches, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
connection_iduuidread, writeConnection
bank_account_iduuidread, writeDrawn on
batch_notextread onlyBatch no
payment_typetextread, writeType
file_formattextread, writeFile format
effective_datedateread, writeEffective date
currencytextread, writeCurrency
item_countintegerread onlyItem count
total_amountnumericread onlyTotal amount
statustextread onlyStatus
file_nametextread onlyFile name
file_hashtextread onlyFile hash
file_contenttextread onlyFile content
trace_numbertextread onlyTrace number
bank_referencetextread onlyBank reference
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
transmitted_attimestamp with time zoneread onlyTransmitted at
acknowledged_attimestamp with time zoneread onlyAcknowledged at
rejection_reasontextread onlyRejection reason
journal_iduuidread onlyJournal id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Payment Batches for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.