Retrieve a Transaction | Flagright

curl https://sandbox.api.flagright.com/transactions/transactionId \
     -H "x-api-key: <apiKey>"

{
  "type": "DEPOSIT",
  "transactionId": "7b80a539eea6e78acbd6d458e5971482",
  "timestamp": 1641654664000,
  "executedRules": [
    {
      "ruleInstanceId": "string",
      "ruleName": "Proof of funds for high value transactions",
      "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
      "ruleAction": "BLOCK",
      "ruleHit": true,
      "ruleId": "R-1a"
    }
  ],
  "hitRules": [
    {
      "ruleInstanceId": "string",
      "ruleName": "Proof of funds for high value transactions",
      "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
      "ruleAction": "BLOCK",
      "ruleId": "R-1a"
    }
  ],
  "status": "BLOCK",
  "originUserId": "8650a2611d0771cba03310f74bf6",
  "destinationUserId": "9350a2611e0771cba03310f74bf6",
  "originAmountDetails": {
    "transactionAmount": 2000,
    "transactionCurrency": "EUR",
    "country": "DE"
  },
  "destinationAmountDetails": {
    "transactionAmount": 68351.34,
    "transactionCurrency": "INR",
    "country": "IN"
  },
  "originPaymentDetails": {
    "method": "CARD",
    "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
    "cardIssuedCountry": "US",
    "transactionReferenceField": "Deposit",
    "3dsDone": true
  },
  "destinationPaymentDetails": {
    "method": "CARD",
    "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
    "cardIssuedCountry": "IN",
    "transactionReferenceField": "Deposit",
    "3dsDone": true
  },
  "promotionCodeUsed": true,
  "reference": "loan repayment",
  "originDeviceData": {
    "batteryLevel": 95,
    "deviceLatitude": 13.0033,
    "deviceLongitude": 76.1004,
    "ipAddress": "10.23.191.2",
    "deviceIdentifier": "3c49f915d04485e34caba",
    "vpnUsed": false,
    "operatingSystem": "Android 11.2",
    "deviceMaker": "ASUS",
    "deviceModel": "Zenphone M2 Pro Max",
    "deviceYear": "2018",
    "appVersion": "1.1.0"
  },
  "destinationDeviceData": {
    "batteryLevel": 95,
    "deviceLatitude": 13.0033,
    "deviceLongitude": 76.1004,
    "ipAddress": "10.23.191.2",
    "deviceIdentifier": "3c49f915d04485e34caba",
    "vpnUsed": false,
    "operatingSystem": "Android 11.2",
    "deviceMaker": "ASUS",
    "deviceModel": "Zenphone M2 Pro Max",
    "deviceYear": "2018",
    "appVersion": "1.1.0"
  },
  "tags": [
    {
      "key": "customKey",
      "value": "customValue"
    }
  ]
}

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 `/transactions` endpoint allows you to operate on the [Transaction entity](/guides/overview/entities#transaction). Calling `GET /transactions/{transactionId}` will return the entire transaction payload and rule execution results for the transaction with the corresponding `transactionId`

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

transactionIdstringRequired

Unique Transaction Identifier

Response

typestring

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

transactionIdstring>=1 character

Unique transaction identifier

timestampdouble315529200000-4133890801000

Timestamp of when transaction took place

executedRuleslist of objects

hitRuleslist of objects

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:

originUserIdstring

UserId for where the transaction originates from

destinationUserIdstring

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

transactionStateenum

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

originAmountDetailsobject

Model for transaction amount details

destinationAmountDetailsobject

Model for transaction amount details

originPaymentDetailsobject

Payment details of the origin. It can be a bank account number, wallet ID, card fingerprint etc.

destinationPaymentDetailsobject

originFundsInfoobject

Model for origin funds information

corporateEntityobject

Model for corporate entity details

relatedTransactionIdslist of strings

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>=1 character

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

originDeviceDataobject

Model for device data

destinationDeviceDataobject

Model for device data

metadataobject

Additional metadata for transactions including risk analysis and counterparty information

tagslist of objects

Additional information that can be added via tags

jurisdictionstring

Legal authority or region governing the transaction

riskScoreDetailsobject

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error