TRANXACT.AI Help

Accounting · Card Payments

Card Charge Batches

Due mandates charged in runs, each run one batch for the acquirer. Exporting a batch is the one place card numbers are decrypted.

Type REST5 operationsBase path /api/accounting/card-charge-batches

Download specification (OpenAPI 3.1) Screen: Card Charge 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 › Card Charge 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/accounting/card-charge-batchesRead card charge batches

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/card-charge-batches" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/card-charge-batches/dueDue

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/accounting/card-charge-batches/due" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/card-charge-batches/{id}Read card charge batches

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/card-charge-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/card-charge-batches/runRun

Request body

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

asOf

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/card-charge-batches/run" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"asOf":"value"}'
POST/api/accounting/card-charge-batches/{id}/charges/{chargeId}/resultCharges result

Path parameters

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

Request body

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

status, failureReason, acquirerRef

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/card-charge-batches/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/result" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"value","failureReason":"value","acquirerRef":"value"}'

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 › Card Charge 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.