Skip to main content

Implemented by

Fields

accountNumber : String

Unique identifier of the account the transaction belongs to.

amount : Int

Gross amount including tax (when payable). Refer to the amounts field for a breakdown of this information.

The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned.

balanceCarriedForward : Int

The customer's resulting balance after this transaction has been applied, in the smallest unit of currency.

billingDocumentIdentifier : ID

The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document.

createdAt : DateTime

The date time when the transaction is created.

hasStatement : Boolean

Returns True if the transaction is linked with a statement.

id : ID

Unique identifier for the transaction.

isAccountCharge : Boolean

Deprecated.

Deprecation
The 'isAccountCharge' field is deprecated.

This information is provided by the __typename introspection query.

- Marked as deprecated on 2020-06-19.
- Scheduled for removal on or after 2022-11-15.
isAccountPayment : Boolean

Deprecated.

Deprecation
The 'isAccountPayment' field is deprecated.

This information is provided by the __typename introspection query.

- Marked as deprecated on 2020-06-19.
- Scheduled for removal on or after 2022-11-15.
isCredit : Boolean

Deprecated.

Deprecation
The 'isCredit' field is deprecated.

This information is provided by the __typename introspection query.

- Marked as deprecated on 2020-06-19.
- Scheduled for removal on or after 2022-11-15.
isHeld : Boolean

Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction.

isIssued : Boolean

Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents.

isReversed : Boolean! required
note : String

Returns the note field value for the transaction, which contains additional info.

postedDate : Date

Date when the transaction was posted to the account.

reasonCode : String

Returns the reason.

statementId : ID

Returns None if a statement is not linked with the transaction.

Deprecation
The 'statementId' field is deprecated.

Use `billingDocumentIdentifier` instead.

- Marked as deprecated on 2023-11-30.
- Scheduled for removal on or after 2024-06-01.
title : String

Human-readable title describing the transaction.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountNumber": "A-CADAA3C5", "amount": 21, "amounts": TransactionAmountType, "balanceCarriedForward": 23, "billingDocumentIdentifier": "60423352", "createdAt": "2003-02-14T04:25:30.303312+00:00", "hasStatement": true, "id": "78869568", "isHeld": true, "isIssued": true, "isReversed": true, "note": "describe-dog-American-middle-couple", "postedDate": "1998-07-09", "reasonCode": "partner-your-baby-huge-let", "title": "note-answer-bed-behind-spring" }