Verify a Transaction | Flagright

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 `/transactions` endpoint allows you to operate on the [Transaction entity.](/guides/overview/entities#transaction) 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](/api-reference/api-reference/transactions/verify#request) 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](/guides/overview/entities#transaction-lifecycle-through-transaction-events) * `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](/api-reference/api-reference/consumer-users/create) or [create a business user](/api-reference/api-reference/business-users/create) 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](/api-reference/api-reference/consumer-users/create) or [create a business user](/api-reference/api-reference/business-users/create) 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.

Authentication

x-api-keystring

API Key authentication via header

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

timestampdoubleRequired315529200000-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

jurisdictionstringOptional

Legal authority or region governing the transaction

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

POST Transactions

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

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.

1	from flagright import (
2	DeviceData,
3	Flagright,
4	Tag,
5	TransactionAmountDetails,
6	TransactionDestinationPaymentDetails_Card,
7	TransactionOriginPaymentDetails_Card,
8	)
9
10	client = Flagright(
11	api_key="YOUR_API_KEY",
12	)
13	client.transactions.verify(
14	validate_origin_user_id="true",
15	validate_destination_user_id="true",
16	type="DEPOSIT",
17	transaction_id="7b80a539eea6e78acbd6d458e5971482",
18	timestamp=1641654664000.0,
19	origin_user_id="8650a2611d0771cba03310f74bf6",
20	destination_user_id="9350a2611e0771cba03310f74bf6",
21	origin_amount_details=TransactionAmountDetails(
22	transaction_amount=800.0,
23	transaction_currency="EUR",
24	country="DE",
25	),
26	destination_amount_details=TransactionAmountDetails(
27	transaction_amount=68351.34,
28	transaction_currency="INR",
29	country="IN",
30	),
31	origin_payment_details=TransactionOriginPaymentDetails_Card(
32	card_fingerprint="20ac00fed8ef913aefb17cfae1097cce",
33	card_issued_country="TR",
34	transaction_reference_field="Deposit",
35	f_3_ds_done=True,
36	),
37	destination_payment_details=TransactionDestinationPaymentDetails_Card(
38	card_fingerprint="20ac00fed8ef913aefb17cfae1097cce",
39	card_issued_country="TR",
40	transaction_reference_field="Deposit",
41	f_3_ds_done=True,
42	),
43	promotion_code_used=True,
44	reference="loan repayment",
45	origin_device_data=DeviceData(
46	battery_level=95.0,
47	device_latitude=13.0033,
48	device_longitude=76.1004,
49	ip_address="10.23.191.2",
50	device_identifier="3c49f915d04485e34caba",
51	vpn_used=False,
52	operating_system="Android 11.2",
53	device_maker="ASUS",
54	device_model="Zenphone M2 Pro Max",
55	device_year="2018",
56	app_version="1.1.0",
57	),
58	destination_device_data=DeviceData(
59	battery_level=95.0,
60	device_latitude=13.0033,
61	device_longitude=76.1004,
62	ip_address="10.23.191.2",
63	device_identifier="3c49f915d04485e34caba",
64	vpn_used=False,
65	operating_system="Android 11.2",
66	device_maker="ASUS",
67	device_model="Zenphone M2 Pro Max",
68	device_year="2018",
69	app_version="1.1.0",
70	),
71	tags=[
72	Tag(
73	key="customKey",
74	value="customValue",
75	)
76	],
77	)

1	{
2	"executedRules": [
3	{
4	"ruleName": "Proof of funds for high value transactions",
5	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
6	"ruleAction": "BLOCK",
7	"ruleHit": true,
8	"ruleId": "R-1a"
9	}
10	],
11	"hitRules": [
12	{
13	"ruleName": "Proof of funds for high value transactions",
14	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
15	"ruleAction": "BLOCK",
16	"ruleId": "R-1a"
17	}
18	],
19	"status": "ALLOW",
20	"transactionId": "7b80a539eea6e78acbd6d458e5971482"
21	}