Skip to main content

Transactions

note

This guide covers transactions processed through Account Tokenization. For transactions created through Online Orchestration, see Online Orchestration reporting.

POST /v1/reporting/rest/pba/transactions returns the card transactions processed for your accounts, newest first. Each transaction includes its nested transactions (reversals, incremental authorizations, clearing and refunds) and its reconciliation record.

Use it to:

  • show a customer's transaction history in your back office
  • look up a transaction by your own reference, or by the network's
  • reconcile authorized, cleared and settled amounts against your ledger

Scope transactions.read

Request​

All fields are optional. See Making a request for how filters and pagination work.

FieldTypeDescription
startDatestringOnly transactions created at or after this time (ISO 8601, UTC).
endDatestringOnly transactions created before this time (ISO 8601, UTC).
transactionIdsstring[]Open Fabric transaction IDs.
tenantTransactionRefsstring[]Your transaction references.
networkTransactionRefsstring[]Card network transaction references.
customerIdsstring[]Open Fabric customer IDs.
statusesstring[]Transaction statuses: initiated, approved, declined, created, processed, reversed, unknown, expired.
typesstring[]Transaction types, for example final_auth, pre_auth, refund_online.
sourcesstring[]ecommerce or terminal.
tagstring[]Transaction tags.
limitintegerRecords per page. Default 10, maximum 500.
offsetintegerRecords to skip. Default 0.
withCountbooleanInclude the total count of matching transactions. Default true. Send false for faster responses when you don't need the total.

Example: transactions of one customer in October​

{
"customerIds": ["5a3f1c1e-7c1b-4f36-9d5b-3f0f2b1d9c11"],
"startDate": "2026-10-01T00:00:00Z",
"endDate": "2026-11-01T00:00:00Z",
"limit": 50,
"withCount": false
}

Example: look up a transaction by your reference​

{
"tenantTransactionRefs": ["ORDER-100234"]
}

Response​

{
"pba_transactions": [
{
"transaction_id": "0b9d4c2a-1f7e-4b8a-9b0c-3d2e1f4a5b6c",
"tenant_transaction_ref": "ORDER-100234",
"network_transaction_ref": "321306008869",
"transaction_type": "final_auth",
"status": "processed",
"source": "ecommerce",
"category": "other",
"customer_id": "5a3f1c1e-7c1b-4f36-9d5b-3f0f2b1d9c11",
"customer": { "customer_id": "5a3f1c1e-7c1b-4f36-9d5b-3f0f2b1d9c11", "tenant_customer_ref": "CUST-881" },
"original_transaction_amount": 120.1,
"transaction_currency_code": "SGD",
"original_billing_amount": 120.1,
"billing_currency_code": "SGD",
"authorized_amount": 120.1,
"total_amount": 120.1,
"total_reversed_amount": 0,
"authorization_code": "A1B2C3",
"network_merchant_name": "COFFEE HOUSE",
"network_merchant_category_code": "5814",
"created_at": "2026-10-14T03:12:45.120",
"updated_at": "2026-10-15T19:10:02.004",
"nested_transactions": [],
"reconciliation": {
"clearing_status": "fully_cleared",
"settlement_status": "fully_settled",
"total_cleared_amount": 120.1,
"total_settled_amount": 120.1,
"is_fully_reconciled": true
}
}
],
"pba_transactions_aggregate": { "aggregate": { "count": 1 } }
}

The example shows a subset of the fields. The main ones are below.

Identifiers​

FieldDescription
transaction_idOpen Fabric transaction ID.
tenant_transaction_refYour reference for the transaction, if you set one.
network_transaction_refCard network transaction reference. Clearing and settlement records match on this value.
linked_transaction_idThe transaction this one belongs to, for example the original authorization of a reversal.
customer_id, customer.tenant_customer_refThe customer, by Open Fabric ID and by your reference.
device_id, tokenize_account_device.tenant_account_device_refThe device that made the transaction, for token transactions.
static_token_idThe static token (virtual card) used, for virtual card transactions.

Classification​

FieldDescription
transaction_typeFor example final_auth, pre_auth, refund_online, refund_offline.
statusinitiated, approved, declined, created, processed, reversed, unknown or expired.
reasonWhy the transaction was declined, if it was.
sourceecommerce or terminal.
categoryCategory assigned by Open Fabric, for example recurring_payment, transit, other.
is_converted_pre_authtrue if a pre-authorization was converted into a final authorization.

Amounts​

Amounts are in major units, such as 120.1 for SGD 120.10.

FieldDescription
original_transaction_amount, transaction_currency_codeThe amount and currency at the merchant.
original_billing_amount, billing_currency_code, billing_exchange_rateThe amount billed to the account, and the rate used.
original_settlement_amount, settlement_currency_code, settlement_exchange_rateThe amount the network settles.
authorized_amount, original_approved_amountThe amount authorized, and the amount first approved.
total_amount, total_billing_amount, total_settlement_amount, total_approved_amountRunning totals, after incremental authorizations and reversals.
total_reversed_amount, total_increment_amountTotals of reversals and incremental authorizations.
reversal_history, incremental_historyThe individual reversals and increments.

Merchant​

network_merchant_id, network_merchant_name, network_merchant_category_code and network_merchant_outlet_address hold the merchant, as reported by the card network.

Nested transactions​

nested_transactions holds the follow-up transactions of the transaction, with the same fields. These include reversals, incremental authorizations, refunds and chargebacks. Count a transaction once, through its parent, when you add up totals.

Reconciliation​

reconciliation shows how far the transaction has cleared and settled:

FieldDescription
clearing_statusnot_cleared, partially_cleared, fully_cleared or over_cleared.
settlement_statusnot_settled, partially_settled or fully_settled.
total_cleared_amount, total_settled_amount, total_reconciled_amountAmounts cleared, settled and reconciled so far.
is_fully_reconciledtrue once the transaction is fully cleared and settled.
is_clearing_in_progresstrue while clearing records are still arriving.
is_contain_exception, exception_messageSet when reconciliation found a mismatch.
clearing_history, settlement_historyThe individual clearing and settlement records, with their reversals in clearing_reversal_history and settlement_reversal_history.

reconciliation is null until the first clearing record arrives. See Authorization and Clearing for the lifecycle.

GraphQL query​

This endpoint is built on the query below. The fields you send in the request body fill in the query. To fetch fewer fields or add related data, send your own version of it to the GraphQL endpoint.

pba-transactions.graphql
# /v1/reporting/rest/pba/transactions (POST)
#
# Scope: transactions.read
# Hasura query: allowed-queries/get-pba-transactions-post (REST url: pba/transactions)
#
# Generated from slice-graphql-service src/schema/v1/metadata/query_collections.yaml
# by docs/scripts/sync-reporting-graphql.mjs. Do not edit by hand.
query RestQuery ($limit: Int = 10, $offset: Int = 0, $startDate: timestamp = "2020-01-01", $endDate: timestamp = "2120-01-01", $statuses: [String!], $types: [String!], $tag: [String!], $customerIds: [String!], $transactionIds: [bpchar!], $networkTransactionRefs: [String!], $sources: [String!], $tenantTransactionRefs: [String!], $withCount: Boolean = true) {
pba_transactions(order_by: {created_at: desc}, limit: $limit, offset: $offset, where: {transaction_id: {_in: $transactionIds}, created_at:{_gte:$startDate,_lt:$endDate}, status:{_in:$statuses}, transaction_type:{_in:$types}, tag:{_in:$tag}, customer_id:{_in:$customerIds}, network_transaction_ref:{_in:$networkTransactionRefs}, source:{_in:$sources}, tenant_transaction_ref:{_in:$tenantTransactionRefs}}) {
transaction_id
tenant_transaction_ref
device_id
network_transaction_ref
transaction_type
tag
customer_id
network_message_ref
network_message_origin_ref
network_message_timestamp
linked_transaction_id
status
reason
original_transaction_amount
transaction_currency_code
original_billing_amount
billing_currency_code
billing_exchange_rate
original_settlement_amount
settlement_currency_code
settlement_exchange_rate
authorized_amount
reversal_history
incremental_history
created_at
updated_at
original_approved_amount
authorization_code
category
source
total_reversed_amount
total_amount
total_billing_amount
total_settlement_amount
total_approved_amount
total_increment_amount
network_merchant_id
network_merchant_name
network_merchant_category_code
network_merchant_outlet_address
payment_instruments
pgcharge_metadata
static_token_id
reconciliation_id
is_converted_pre_auth
customer {
customer_id
tenant_customer_ref
}
tokenize_account_device {
tenant_account_device_ref
}
nested_transactions {
transaction_id
tenant_transaction_ref
device_id
network_transaction_ref
transaction_type
tag
customer_id
network_message_ref
network_message_origin_ref
network_message_timestamp
linked_transaction_id
status
reason
original_transaction_amount
transaction_currency_code
original_billing_amount
billing_currency_code
billing_exchange_rate
original_settlement_amount
settlement_currency_code
settlement_exchange_rate
authorized_amount
reversal_history
incremental_history
created_at
updated_at
original_approved_amount
authorization_code
category
source
total_reversed_amount
total_amount
total_billing_amount
total_settlement_amount
total_approved_amount
total_increment_amount
network_merchant_id
network_merchant_name
network_merchant_category_code
network_merchant_outlet_address
payment_instruments
pgcharge_metadata
static_token_id
customer {
customer_id
tenant_customer_ref
}
tokenize_account_device {
tenant_account_device_ref
}
reconciliation {
id
is_contain_exception
exception_message
network_transaction_ref
tenant_id
transaction_type
partner_id
total_cleared_amount
clearing_status
total_settled_amount
settlement_status
total_reconciled_amount
is_fully_reconciled
is_clearing_in_progress
currency
billing_currency_code
settlement_currency_code
interchange_fee_currency_code
clearing_history
clearing_reversal_history
settlement_history
settlement_reversal_history
}
}
reconciliation {
id
is_contain_exception
exception_message
network_transaction_ref
tenant_id
transaction_type
partner_id
total_cleared_amount
clearing_status
total_settled_amount
settlement_status
total_reconciled_amount
is_fully_reconciled
is_clearing_in_progress
currency
billing_currency_code
settlement_currency_code
interchange_fee_currency_code
clearing_history
clearing_reversal_history
settlement_history
settlement_reversal_history
}
}
pba_transactions_aggregate(where: {transaction_id: {_in: $transactionIds}, created_at:{_gte:$startDate,_lt:$endDate}, status:{_in:$statuses}, transaction_type:{_in:$types}, tag:{_in:$tag}, customer_id:{_in:$customerIds}, network_transaction_ref:{_in:$networkTransactionRefs}, source:{_in:$sources}, tenant_transaction_ref:{_in:$tenantTransactionRefs}}) @include(if: $withCount) {
aggregate {
count
}
}
}