FLflagright
transactions

Verify a Transaction

Changed on

POST Transactions

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

In order to pass the payload of a transaction to Flagright and verify the transaction, you will need to call this endpoint with the transaction payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Here are some of the most used payload fields explained (you can find the full payload schema below with 1 line descriptions):

  • type: Type of transaction (Ex: WITHDRAWAL, DEPOSIT, TRANSFER etc).
  • transactionId - Unique Identifier for the transaction.
  • timestamp - UNIX timestamp in milliseconds of when the transaction took place
  • transactionState - The state of the transaction, set to CREATED by default. More details here
  • originUserId - Unique identifier (if any) of the user who is sending the money. This user must be created within the Flagright system before using the create a consumer user or create a business user endpoint
  • destinationUserId - Unique identifier (if any) of the user who is receiving the money. This user must be created within the Flagright system before using the create a consumer user or create a business user endpoint
  • originAmountDetails - Details of the amount being sent from the origin
  • destinationAmountDetails - Details of the amount being received at the destination
  • originPaymentDetails - Payment details (if any) used at the origin (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.
  • destinationPaymentDetails - Payment details (if any) used at the destination (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.
post/transactions

Request

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

Query parameters

validateOriginUserId'true' | 'false'

Boolean string whether Flagright should validate if provided originUserId exist. True by default

validateDestinationUserId'true' | 'false'

Boolean string whether Flagright should validate if provided destinationUserId exist. True by default

Request body

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

customObjectTransactionCustomObject

Typed Object defined on the console for additional data

Response

Created

transactionIdstring required

Transaction ID that the results pertain to

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

messagestring

Changes

  • 1c04818a93a7Revision changes
    • info

      added the new ANUBIS enum value to the request property //

    • info

      added the new ANUBIS enum value to the request property //

    • info

      added the new APTOS enum value to the request property //

    • info

      added the new APTOS enum value to the request property //

    • info

      added the new ARC enum value to the request property //

    • info

      added the new ARC enum value to the request property //

    • info

      added the new ARWEAVE enum value to the request property //

    • info

      added the new ARWEAVE enum value to the request property //

    • info

      added the new BERACHAIN enum value to the request property //

    • info

      added the new BERACHAIN enum value to the request property //

    • info

      added the new BIFROST_NETWORK enum value to the request property //

    • info

      added the new BIFROST_NETWORK enum value to the request property //

    • info

      added the new BITTENSOR enum value to the request property //

    • info

      added the new BITTENSOR enum value to the request property //

    • info

      added the new BLAST enum value to the request property //

    • info

      added the new BLAST enum value to the request property //

    • info

      added the new BOT_CHAIN enum value to the request property //

    • info

      added the new BOT_CHAIN enum value to the request property //

    • info

      added the new CANTON_NETWORK enum value to the request property //

    • info

      added the new CANTON_NETWORK enum value to the request property //

    • info

      added the new CELO enum value to the request property //

    • info

      added the new CELO enum value to the request property //

    • info

      added the new CHAINFLIP enum value to the request property //

    • info

      added the new CHAINFLIP enum value to the request property //

    • info

      added the new CRONOS enum value to the request property //

    • info

      added the new CRONOS enum value to the request property //

    • info

      added the new DYDX enum value to the request property //

    • info

      added the new DYDX enum value to the request property //

    • info

      added the new ETHEREUM_CLASSIC enum value to the request property //

    • info

      added the new ETHEREUM_CLASSIC enum value to the request property //

    • info

      added the new ETHERLINK enum value to the request property //

    • info

      added the new ETHERLINK enum value to the request property //

    • info

      added the new FILECOIN enum value to the request property //

    • info

      added the new FILECOIN enum value to the request property //

    • info

      added the new FLARE enum value to the request property //

    • info

      added the new FLARE enum value to the request property //

    • info

      added the new FLOW enum value to the request property //

    • info

      added the new FLOW enum value to the request property //

    • info

      added the new FRAXTAL enum value to the request property //

    • info

      added the new FRAXTAL enum value to the request property //

    • info

      added the new GNOSIS_CHAIN enum value to the request property //

    • info

      added the new GNOSIS_CHAIN enum value to the request property //

    • info

      added the new HYDRATION enum value to the request property //

    • info

      added the new HYDRATION enum value to the request property //

    • info

      added the new IMMUTABLE_X enum value to the request property //

    • info

      added the new IMMUTABLE_X enum value to the request property //

    • info

      added the new INJECTIVE enum value to the request property //

    • info

      added the new INJECTIVE enum value to the request property //

    • info

      added the new INK enum value to the request property //

    • info

      added the new INK enum value to the request property //

    • info

      added the new INTERNET_COMPUTER enum value to the request property //

    • info

      added the new INTERNET_COMPUTER enum value to the request property //

    • info

      added the new IOTA enum value to the request property //

    • info

      added the new IOTA enum value to the request property //

    • info

      added the new KAIA enum value to the request property //

    • info

      added the new KAIA enum value to the request property //

    • info

      added the new KATANA enum value to the request property //

    • info

      added the new KATANA enum value to the request property //

    • info

      added the new KAVA enum value to the request property //

    • info

      added the new KAVA enum value to the request property //

    • info

      added the new LINEA enum value to the request property //

    • info

      added the new LINEA enum value to the request property //

    • info

      added the new MANTLE enum value to the request property //

    • info

      added the new MANTLE enum value to the request property //

    • info

      added the new MEGAETH enum value to the request property //

    • info

      added the new MEGAETH enum value to the request property //

    • info

      added the new MEZO enum value to the request property //

    • info

      added the new MEZO enum value to the request property //

    • info

      added the new MIXIN enum value to the request property //

    • info

      added the new MIXIN enum value to the request property //

    • info

      added the new MONAD enum value to the request property //

    • info

      added the new MONAD enum value to the request property //

    • info

      added the new MORPH enum value to the request property //

    • info

      added the new MORPH enum value to the request property //

    • info

      added the new MULTIVERSX enum value to the request property //

    • info

      added the new MULTIVERSX enum value to the request property //

    • info

      added the new OSMOSIS enum value to the request property //

    • info

      added the new OSMOSIS enum value to the request property //

    • info

      added the new PHAROS enum value to the request property //

    • info

      added the new PHAROS enum value to the request property //

    • info

      added the new PLASMA enum value to the request property //

    • info

      added the new PLASMA enum value to the request property //

    • info

      added the new PROVENANCE enum value to the request property //

    • info

      added the new PROVENANCE enum value to the request property //

    • info

      added the new PULSECHAIN enum value to the request property //

    • info

      added the new PULSECHAIN enum value to the request property //

    • info

      added the new RISE enum value to the request property //

    • info

      added the new RISE enum value to the request property //

    • info

      added the new ROBINHOOD_CHAIN enum value to the request property //

    • info

      added the new ROBINHOOD_CHAIN enum value to the request property //

    • info

      added the new ROLLUX enum value to the request property //

    • info

      added the new ROLLUX enum value to the request property //

    • info

      added the new ROOTSTOCK enum value to the request property //

    • info

      added the new ROOTSTOCK enum value to the request property //

    • info

      added the new SCROLL enum value to the request property //

    • info

      added the new SCROLL enum value to the request property //

    • info

      added the new SEI enum value to the request property //

    • info

      added the new SEI enum value to the request property //

    • info

      added the new STABLE enum value to the request property //

    • info

      added the new STABLE enum value to the request property //

    • info

      added the new STACKS enum value to the request property //

    • info

      added the new STACKS enum value to the request property //

    • info

      added the new STARKNET enum value to the request property //

    • info

      added the new STARKNET enum value to the request property //

    • info

      added the new STORY enum value to the request property //

    • info

      added the new STORY enum value to the request property //

    • info

      added the new STRATO_CHAIN enum value to the request property //

    • info

      added the new STRATO_CHAIN enum value to the request property //

    • info

      added the new TAIKO enum value to the request property //

    • info

      added the new TAIKO enum value to the request property //

    • info

      added the new THORCHAIN enum value to the request property //

    • info

      added the new THORCHAIN enum value to the request property //

    • info

      added the new TON enum value to the request property //

    • info

      added the new TON enum value to the request property //

    • info

      added the new UNICHAIN enum value to the request property //

    • info

      added the new UNICHAIN enum value to the request property //

    • info

      added the new WORLD_CHAIN enum value to the request property //

    • info

      added the new WORLD_CHAIN enum value to the request property //

    • info

      added the new XDC_NETWORK enum value to the request property //

    • info

      added the new XDC_NETWORK enum value to the request property //

    • info

      added the new XPR_NETWORK enum value to the request property //

    • info

      added the new XPR_NETWORK enum value to the request property //

    • info

      added the new X_LAYER enum value to the request property //

    • info

      added the new X_LAYER enum value to the request property //

    • info

      added the new ZKSYNC_ERA enum value to the request property //

    • info

      added the new ZKSYNC_ERA enum value to the request property //