API ReferenceTransactions

Verify a Transaction

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.

Headers

x-api-keystringRequired

Query parameters

validateOriginUserIdenumOptional
Boolean string whether Flagright should validate if provided originUserId exist. True by default
Allowed values:
validateDestinationUserIdenumOptional
Boolean string whether Flagright should validate if provided destinationUserId exist. True by default
Allowed values:

Request

typestringRequired

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

transactionIdstringRequired>=1 character
Unique transaction identifier
timestampdoubleRequired>=315529200000<=4133890801000
Timestamp of when transaction took place
originUserIdstringOptional
UserId for where the transaction originates from
destinationUserIdstringOptional
UserId for transaction's destination. In other words, where the value is being transferred to.
transactionStateenumOptional
Model for transaction states. E.g. Processing, Refunded, Successful etc.
originAmountDetailsobjectOptional
Model for transaction amount details
destinationAmountDetailsobjectOptional
Model for transaction amount details
originPaymentDetailsobjectOptional
Payment details of the origin. It can be a bank account number, wallet ID, card fingerprint etc.
destinationPaymentDetailsobjectOptional
originFundsInfoobjectOptional
Model for origin funds information
relatedTransactionIdslist of stringsOptional

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

productTypestringOptional

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

promotionCodeUsedbooleanOptional
Whether a promotion code was used or not the transaction
referencestringOptional>=1 character
Reference field for the transaction indicating the purpose of the transaction etc.
originDeviceDataobjectOptional
Model for device data
destinationDeviceDataobjectOptional
Model for device data
tagslist of objectsOptional
Additional information that can be added via tags

Response

Created
executedRuleslist of objects
Unique transaction identifier
hitRuleslist of objects
Unique transaction identifier
statusenum
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
Allowed values:
transactionIdstring
Transaction ID that the results pertain to
messagestring or null
riskScoreDetailsobject or null

Errors