transactions

Retrieve a Transaction

GET Transactions

/transactions endpoint allows you to operate on the Transaction entity.

Calling GET /transactions/{transactionId} will return the entire transaction payload and rule execution results for the transaction with the corresponding transactionId

get/transactions/{transactionId}

Request

  • Base URL: https://sandbox.api.flagright.com
  • URL: https://sandbox.api.flagright.com/transactions/{transactionId}
  • Auth: API key in header x-api-key

Path parameters

transactionIdstring required

Unique Transaction Identifier

Response

OK

typestring required

Type of transaction (ex: DEPOSIT, WITHDRAWAL, TRANSFER, EXTERNAL_PAYMENT, REFUND, OTHER)

transactionIdstring required

Unique transaction identifier

timestampnumber double required

Timestamp of when transaction took place

originUserIdstring

UserId for where the transaction originates from

destinationUserIdstring

UserId for transaction's destination. In other words, where the value is being transferred to.

transactionState'CREATED' | 'PROCESSING' | 'SENT' | 'EXPIRED' | 'DECLINED' | 'SUSPENDED' | 'REFUNDED' | 'SUCCESSFUL' | 'REVERSED'

Model for transaction states. E.g. Processing, Refunded, Successful etc.

relatedTransactionIdsstring[]

IDs of transactions related to this transaction. Ex: refund, split bills

productTypestring

Type of produce being used by the consumer (ex wallets, payments etc)

promotionCodeUsedboolean

Whether a promotion code was used or not the transaction

referencestring

Reference field for the transaction indicating the purpose of the transaction etc.

jurisdictionstring

Legal authority or region governing the transaction

externalLinksstring[]

External links related to the transaction

customObjectTransactionWithRulesResultCustomObject

Typed Object defined on the console for additional data

status'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND' required

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Changes

No recorded changes to this operation across all 1 revision of this API.