Get a transaction

Retrieve a transaction by ID, stage, and version. Stage and version zero return the latest transaction.

Required permissions: transaction:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

transaction_idstringRequired
The unique identifier of the transaction.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Query parameters

stageintegerOptional>=0Defaults to 0

Stage to return; 0 returns the latest.

versionintegerOptional>=0Defaults to 0

Resource version to return; 0 returns the latest.

Response

The transaction.
transaction_idstring
The unique identifier Penny assigns to this transaction.
account_idstring
The unique identifier of the account affected by this transaction.
business_idstring
The unique identifier of the business this transaction belongs to.
business_entity_idstring
The unique identifier of the business entity this transaction belongs to.
program_idstring
The unique identifier of the program this transaction belongs to.
versioninteger
The revision number within the current processing stage. It starts at 1 when the transaction enters a stage and increases when the record is updated without advancing to the next stage.
version_timedatetime
The date and time this revision was recorded.
stageinteger
The transaction's processing step number. It increases when a new event advances the transaction through its lifecycle.
stage_timedatetime
The date and time the transaction entered its current stage.
statusenum
The current lifecycle status of the transaction.
directionenum

Whether funds move into (inbound) or out of (outbound) the account.

Allowed values:
typeenum

The client-visible category of the transaction.

Allowed values:
base_amountstringformat: "^-?\d+(\.\d+)?$"
The transaction amount in the account's settlement currency.
base_amount_currencyenum

The three-letter ISO 4217 currency code of the settlement amount.

Allowed values:
channelobject
How the transaction was conducted.
counterpartyobject
The party on the opposite side of the transaction.
messagestring or nullOptional
Additional context about the current status, when available.
client_referencestring or nullOptional
Your own reference for this transaction, as supplied when the underlying movement was initiated. Penny stores it and never interprets it, and it can be used to look this transaction up. Present only where a reference was supplied.
original_amountstring or nullOptionalformat: "^-?\d+(\.\d+)?$"
The amount in the currency in which the transaction was presented. Present when that currency differs from the settlement currency.
original_amount_currencyenum or nullOptional

The three-letter ISO 4217 currency code of the presented amount. Present together with original_amount.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error