TRANXACT.AI Help

Platform · Payments

Transactions

Every authorization, capture and refund, the fee taken out of it, and the journal it produced.

Type REST6 operationsBase path /api/platform/payment-transactionsPublished as /api/v1/payment-transactions

Download specification (OpenAPI 3.1) Screen: Transactions

Overview

PackagePlatform
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 Platform › Transactions 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.
Tableplatform.payment_transactions · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/platform/payment-transactionsList transactions

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "transaction_no": "TRA-000001",
      "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "transaction_type": "text",
      "amount": "1250.00",
      "currency": "USD",
      "fee_amount": "1250.00",
      "net_amount": "1250.00",
      "method": "text",
      "card_brand": "text",
      "card_last4": "text",
      "source_module": "text",
      "source_ref": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transaction_no": "TRA-000001",
  "provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transaction_type": "text",
  "amount": "1250.00",
  "currency": "USD",
  "fee_amount": "1250.00",
  "net_amount": "1250.00",
  "method": "text",
  "card_brand": "text",
  "card_last4": "text",
  "source_module": "text",
  "source_ref": "text"
}

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

Sample request

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

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/platform/payment-transactions" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/payment-transactions/{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/platform/payment-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/platform/payment-transactions/{id}Put transactions

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 PUT "https://demo.tranxact.ai/api/platform/payment-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/payment-transactions/{id}Delete transactions

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 DELETE "https://demo.tranxact.ai/api/platform/payment-transactions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a payment transactions, 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
org_unit_iduuidread onlyOrg unit id
transaction_notextread onlyTransaction no
provider_iduuidread onlyProvider id
transaction_typetextread onlyTransaction type
amountnumericread onlyAmount
currencytextread onlyCurrency
fee_amountnumericread onlyFee amount
net_amountnumericread onlyNet amount
methodtextread onlyMethod
card_brandtextread onlyCard brand
card_last4textread onlyCard last4
source_moduletextread onlySource module
source_reftextread onlySource ref
ar_invoice_iduuidread onlyAr invoice id
customer_reftextread onlyCustomer ref
provider_referencetextread onlyProvider reference
statustextread onlyStatus
failure_codetextread onlyFailure code
failure_reasontextread onlyFailure reason
authorized_attimestamp with time zoneread onlyAuthorized at
captured_attimestamp with time zoneread onlyCaptured at
settled_attimestamp with time zoneread onlySettled at
refunded_amountnumericread onlyRefunded amount
parent_transaction_iduuidread onlyParent transaction id
journal_iduuidread onlyJournal id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 Platform › Transactions 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.