Platform · Payments
Transactions
Every authorization, capture and refund, the fee taken out of it, and the journal it produced.
/api/platform/payment-transactionsPublished as /api/v1/payment-transactionsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | platform.payment_transactions · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
transaction_no | text | read only | Transaction no |
provider_id | uuid | read only | Provider id |
transaction_type | text | read only | Transaction type |
amount | numeric | read only | Amount |
currency | text | read only | Currency |
fee_amount | numeric | read only | Fee amount |
net_amount | numeric | read only | Net amount |
method | text | read only | Method |
card_brand | text | read only | Card brand |
card_last4 | text | read only | Card last4 |
source_module | text | read only | Source module |
source_ref | text | read only | Source ref |
ar_invoice_id | uuid | read only | Ar invoice id |
customer_ref | text | read only | Customer ref |
provider_reference | text | read only | Provider reference |
status | text | read only | Status |
failure_code | text | read only | Failure code |
failure_reason | text | read only | Failure reason |
authorized_at | timestamp with time zone | read only | Authorized at |
captured_at | timestamp with time zone | read only | Captured at |
settled_at | timestamp with time zone | read only | Settled at |
refunded_amount | numeric | read only | Refunded amount |
parent_transaction_id | uuid | read only | Parent transaction id |
journal_id | uuid | read only | Journal id |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Transactions for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.