--- updatedAt: 2026-05-18T16:12:34.000Z agentTools: projectIndex: https://docs.mesh.complyadvantage.com/llms.txt --- # Retrieve a specific version of a Transaction using our identifier When you submit a transaction to us we allocate an internal identifier for the Transaction. This API allows you to retrieve a specific version of a Transaction using the identifier we set when we received your transaction. # OpenAPI definition ```json { "components": { "schemas": { "activity_AccountBalanceV3": { "description": "Represents the balance of a financial account.", "properties": { "current_balance": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "current_base_balance": { "$ref": "#/components/schemas/activity_MonetaryValueV3" } }, "required": [ "current_balance" ], "type": "object" }, "activity_AcquirerV3": { "description": "Represents the payment acquirer information.", "properties": { "details": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "identifier": { "description": "Unique acquirer identifier.", "example": "acq_visa_usa", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_AddressFormatV3": { "description": "Represents the format of the address used for a party.", "enum": [ "STRUCTURED", "UNSTRUCTURED" ], "example": "STRUCTURED", "type": "string" }, "activity_AddressTypeV3": { "description": "Represents the type of address.", "enum": [ "RESIDENTIAL", "MAILING", "OPERATING", "REGISTRATION", "BILLING", "PO_BOX", "DELIVERY", "BUSINESS", "LEGAL_ENTITY" ], "example": "MAILING", "type": "string" }, "activity_AddressV3": { "description": "Address of the ATM.", "discriminator": { "propertyName": "format" }, "properties": { "format": { "$ref": "#/components/schemas/activity_AddressFormatV3" } }, "required": [ "format" ], "type": "object" }, "activity_AgentRoleV3": { "description": "The roles an agent may take within a financial transaction.", "enum": [ "COUNTERPARTY_BANK", "INTERMEDIARY", "DEBTOR_AGENT", "CREDITOR_AGENT" ], "example": "COUNTERPARTY_BANK", "type": "string" }, "activity_AgentV3": { "description": "Represents an agent in a financial transaction.", "properties": { "bank": { "$ref": "#/components/schemas/activity_BankV3" }, "index": { "description": "The position of the agent in the list. Used to track the agent's order in the original sequence.", "format": "int32", "nullable": true, "type": "integer" }, "money_transfer_operator": { "$ref": "#/components/schemas/activity_MoneyTransferOperatorV3" }, "online_remittance_platform": { "$ref": "#/components/schemas/activity_OnlineRemittancePlatformV3" }, "reference_text": { "description": "The reference text supplied by an agent.", "example": "Interbank Ref 9372", "maxLength": 512, "minLength": 0, "nullable": true, "type": "string" }, "role": { "$ref": "#/components/schemas/activity_AgentRoleV3" }, "virtual_asset_service_provider": { "$ref": "#/components/schemas/activity_VirtualAssetServiceProviderV3" } }, "required": [ "role" ], "type": "object" }, "activity_AtmChannelV3": { "allOf": [ { "$ref": "#/components/schemas/activity_ChannelV3" }, { "properties": { "address": { "discriminator": { "mapping": { "STRUCTURED": "#/components/schemas/activity_StructuredAddressV3" }, "propertyName": "format" }, "oneOf": [ { "$ref": "#/components/schemas/activity_StructuredAddressV3" }, { "$ref": "#/components/schemas/activity_UnstructuredAddressV3" } ] }, "geographic_location": { "$ref": "#/components/schemas/activity_GeographicCoordinatesV3" }, "identifier": { "description": "Client-specific identifier for ATM.", "type": "string" }, "provider": { "description": "ATM provider name.", "type": "string" } }, "type": "object" } ], "description": "Represents an ATM channel used for transaction processing.", "required": [ "network_details", "type" ], "title": "ATM", "type": "object" }, "activity_AuthorizationInfoV3": { "description": "Authorization information.", "properties": { "identifier": { "description": "Unique authorization identifier.", "example": "auth_123456789", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" }, "response": { "$ref": "#/components/schemas/activity_AuthorizationResponseV3" }, "state": { "description": "Represents the state of an authorization request.", "enum": [ "APPROVED", "DECLINED", "PENDING", "EXPIRED", "CANCELLED" ], "example": "APPROVED", "nullable": true, "type": "string" }, "timestamp": { "description": "Authorization timestamp.", "example": "2024-01-15T10:30:00.000Z", "format": "date-time", "nullable": true, "type": "string" }, "type": { "description": "Type of authorization for a card payment.", "enum": [ "PREAUTHORIZATION", "AUTHORIZATION" ], "example": "AUTHORIZATION", "nullable": true, "type": "string" }, "value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" } }, "type": "object" }, "activity_AuthorizationResponseV3": { "description": "Authorization response information.", "properties": { "code": { "description": "Authorization response code.", "example": "00", "maxLength": 10, "minLength": 0, "nullable": true, "type": "string" }, "reason_code": { "description": "Authorization reason code.", "example": "APPROVED", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_BankAccountV3": { "description": "Represent bank account details", "properties": { "bank": { "$ref": "#/components/schemas/activity_BankV3" }, "iban": { "description": "Bank account iban number", "nullable": true, "pattern": "^[a-zA-Z]{2}\\d{2}.*", "type": "string" }, "local": { "$ref": "#/components/schemas/activity_LocalAccountDetailsV3" } }, "required": [ "bank" ], "type": "object" }, "activity_BankPaymentMonetaryTransactionTypeDetailsV3": { "allOf": [ { "$ref": "#/components/schemas/activity_MonetaryTransactionTypeDetailsV3" }, { "properties": { "agents": { "description": "Any intermediaries involved in the transaction between the creditor and the debtor.", "items": { "$ref": "#/components/schemas/activity_AgentV3" }, "maxItems": 10, "minItems": 0, "type": "array" }, "creditor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "debtor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "payment_scheme": { "$ref": "#/components/schemas/activity_PaymentSchemeV3" }, "state": { "$ref": "#/components/schemas/activity_BankPaymentStateV3" }, "ultimate_creditor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "ultimate_debtor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" } }, "type": "object" } ], "description": "Models a transfer of funds from one bank account to another in a different financial institution.", "required": [ "creditor", "debtor", "payment_scheme", "state", "type" ], "title": "Bank Payment Details", "type": "object" }, "activity_BankPaymentStateV3": { "description": "The possible states of a bank payment transaction.", "enum": [ "PENDING", "BOOKED", "RETURNED", "REJECTED", "RECALLED", "CANCELLED", "SETTLED", "INFLIGHT", "HELD", "INVESTIGATING", "CLEARED" ], "example": "BOOKED", "type": "string" }, "activity_BankV3": { "description": "Represents a bank's details.", "properties": { "bic": { "description": "The Business Identifier Code (BIC) of the bank. Also known as SWIFT code.", "example": "ABCDGB01A1B", "nullable": true, "pattern": "^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$", "type": "string" }, "legal_entity_address": { "$ref": "#/components/schemas/activity_StructuredAddressV3" }, "name": { "description": "The name of the bank.", "example": "Deutsche Bank", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_BlockchainNetworkTypeV3": { "description": "Type of the blockchain network used in the transaction.", "enum": [ "MAIN", "TEST" ], "type": "string" }, "activity_BlockchainV3": { "description": "Represents a blockchain network used for cryptocurrency transactions.", "properties": { "identifier": { "$ref": "#/components/schemas/activity_Caip2IdentifierV3" }, "network_name": { "description": "Human friendly chain name.", "nullable": true, "type": "string" }, "network_type": { "$ref": "#/components/schemas/activity_BlockchainNetworkTypeV3" } }, "required": [ "identifier", "network_type" ], "type": "object" }, "activity_BooleanEnrichmentValueV3": { "allOf": [ { "$ref": "#/components/schemas/activity_EnrichmentValueV3" }, { "properties": { "boolean": { "description": "The boolean value", "example": true, "type": "boolean" } }, "type": "object" } ], "description": "Boolean representation of the enrichment value.", "required": [ "boolean", "data_type" ], "title": "Boolean Value", "type": "object" }, "activity_Caip19IdentifierV3": { "description": "The industry standard CAIP-19 Asset Identifier (http://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md)", "properties": { "namespace": { "description": "The namespace covers a class of similar assets.", "example": "slip44", "pattern": "[-a-z0-9]{3,8}", "type": "string" }, "reference": { "description": "The way to identify a blockchain within a given namespace.", "example": "966", "pattern": "[-.%a-zA-Z0-9]{1,128}", "type": "string" } }, "required": [ "namespace", "reference" ], "type": "object" }, "activity_Caip2IdentifierV3": { "description": "The industry standard CAIP-2 Identifier for the blockchain (https://chainagnostic.org/CAIPs/caip-2)", "properties": { "namespace": { "description": "Describes an ecosystem or standard, such as e.g. cosmos or eip155. One namespace should refer to one resolution method to resolve the chain’s reference.", "example": "eip155", "pattern": "[-a-z0-9]{3,8}", "type": "string" }, "reference": { "description": "The way to identify a blockchain within a given namespace.", "example": "1", "pattern": "[-_a-zA-Z0-9]{1,32}", "type": "string" } }, "required": [ "namespace", "reference" ], "type": "object" }, "activity_CardFundingTypeV3": { "description": "Defines the funding type of a payment card.", "enum": [ "CREDIT", "DEBIT", "PREPAID", "OTHER" ], "example": "CREDIT", "type": "string" }, "activity_CardHolderV3": { "description": "Represents a card holder with party identification details and onboarding information.", "properties": { "details": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" } }, "type": "object" }, "activity_CardPaymentMonetaryTransactionTypeDetailsV3": { "allOf": [ { "$ref": "#/components/schemas/activity_MonetaryTransactionTypeDetailsV3" }, { "properties": { "acquirer": { "$ref": "#/components/schemas/activity_AcquirerV3" }, "card": { "$ref": "#/components/schemas/activity_PaymentCardV3" }, "card_holder": { "$ref": "#/components/schemas/activity_CardHolderV3" }, "card_payment_scope": { "$ref": "#/components/schemas/activity_CardPaymentScopeV3" }, "card_payment_type": { "$ref": "#/components/schemas/activity_CardPaymentTypeV3" }, "card_scheme": { "$ref": "#/components/schemas/activity_CardSchemeV3" }, "card_verification_results": { "$ref": "#/components/schemas/activity_CardVerificationResultsV3" }, "issuer": { "$ref": "#/components/schemas/activity_IssuerV3" }, "merchant": { "$ref": "#/components/schemas/activity_MerchantV3" }, "payment_stage": { "$ref": "#/components/schemas/activity_CardPaymentStageV3" }, "payment_stages_info": { "$ref": "#/components/schemas/activity_PaymentStagesInfoV3" }, "point_of_sale": { "$ref": "#/components/schemas/activity_PointOfSaleConditionV3" }, "related_transaction_identifier": { "description": "Reference ID linking to parent/related transaction.", "example": "txn_ref_987654321", "maxLength": 100, "minLength": 0, "type": "string" }, "sub_merchant": { "$ref": "#/components/schemas/activity_MerchantV3" } }, "type": "object" } ], "description": "Models a card payment transaction where funds are transferred using a payment card.", "required": [ "type" ], "title": "Card Payment Details", "type": "object" }, "activity_CardPaymentScopeV3": { "description": "Defines the scope of a card payment transaction.", "enum": [ "DOMESTIC", "CROSSBORDER" ], "example": "DOMESTIC", "type": "string" }, "activity_CardPaymentStageV3": { "description": "Defines the stage of a card payment transaction.", "enum": [ "AUTHORIZED", "SETTLED", "REVERSED", "PARTIALLY_SETTLED", "CHARGEBACK", "CLEARED", "CAPTURED", "VOIDED" ], "example": "SETTLED", "type": "string" }, "activity_CardPaymentTypeV3": { "description": "Defines the type of card payment.", "enum": [ "REGULAR", "INSTALLMENT", "RECURRING", "MOTO", "UNSCHEDULED", "TOP_UP", "REFUND", "OTHER", "AUTH_ONLY", "ECOMMERCE", "CARD_PRESENT", "CARDHOLDER_NOT_PRESENT", "CREDENTIAL_ON_FILE", "MERCHANT_INITIATED", "RECURRING_FIRST", "RECURRING_SUBSEQUENT", "ACCOUNT_VERIFICATION", "ZERO_AMOUNT", "INCREMENTAL_AUTHORIZATION", "PUSH_TO_CARD", "QUASI_CASH", "CASHBACK", "GAMBLING_PAYOUT", "GAMBLING_BUY_IN", "AGENT_CASH_OUT", "CHEQUE" ], "example": "REGULAR", "type": "string" }, "activity_CardSchemeV3": { "description": "Represents the card scheme/network that issued the card.", "enum": [ "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DISCOVER", "JCB", "UNIONPAY", "DINERS_CLUB", "MAESTRO", "RUPAY", "MIR" ], "example": "VISA", "type": "string" }, "activity_CardVerificationResultsV3": { "description": "Represents card verification results including CVV, AVS, and identity checks.", "properties": { "avs_check": { "$ref": "#/components/schemas/activity_VerificationCheckV3" }, "cvc_check": { "$ref": "#/components/schemas/activity_VerificationCheckV3" }, "three_d_secure_check": { "$ref": "#/components/schemas/activity_VerificationCheckV3" } }, "type": "object" }, "activity_CardWalletTypeV3": { "description": "Defines the type of digital wallet.", "enum": [ "GOOGLE_PAY", "APPLE_PAY", "PAYPAL", "REMOTE_COMMERCE_PROGRAMS", "OTHER", "SAMSUNG_PAY", "AMAZON_PAY", "CLICK_TO_PAY", "ALIPAY", "WECHAT_PAY", "CASH_APP_PAY", "VENMO", "LINE_PAY", "KAKAOPAY", "GRAB_PAY", "OVO", "DANA", "GOPAY", "PAYTM", "PHONEPE", "STC_PAY", "CAREEM_PAY", "SHOPEEPAY" ], "example": "APPLE_PAY", "type": "string" }, "activity_CashPickupDetailsV3": { "description": "Represents cash pickup details for remittance transactions.", "properties": { "agent_network": { "description": "The agent network facilitating the cash pickup.", "example": "Western Union", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" }, "country": { "description": "The country code (ISO 3166-1 alpha-2) where the cash pickup location is located.", "example": "US", "maxLength": 2, "minLength": 2, "nullable": true, "pattern": "^[A-Z]{2}$", "type": "string" }, "location_identifier": { "description": "The location identifier where cash can be picked up.", "example": "LOC-987654", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_ChannelNetworkDetailsV3": { "description": "Contains network-related information for a payment channel.", "properties": { "country": { "description": "ISO 2-digit country code (alpha).", "example": "GB", "format": "iso-3166-alpha-2", "maxLength": 2, "minLength": 2, "nullable": true, "type": "string" }, "ip_address": { "$ref": "#/components/schemas/activity_InternetProtocolAddressV3" } }, "type": "object" }, "activity_ChannelV3": { "description": "Represents the channel that initiated the transaction.", "discriminator": { "propertyName": "type" }, "properties": { "network_details": { "$ref": "#/components/schemas/activity_ChannelNetworkDetailsV3" }, "type": { "description": "Channel discriminator.", "enum": [ "DEVICE", "ATM" ], "type": "string" } }, "required": [ "network_details", "type" ], "type": "object" }, "activity_ChargebackInfoV3": { "description": "Chargeback information.", "properties": { "description": { "description": "Chargeback description.", "maxLength": 255, "minLength": 0, "nullable": true, "type": "string" }, "outcome": { "description": "Represents the outcome of a chargeback dispute.", "enum": [ "UNDEFENDED", "PENDING", "WON", "LOST", "WITHDRAW" ], "nullable": true, "type": "string" }, "reason": { "description": "Chargeback reason classification.", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" }, "timestamp": { "description": "Chargeback initiation timestamp.", "format": "date-time", "type": "string" }, "value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" } }, "required": [ "timestamp", "value" ], "type": "object" }, "activity_ClearingIdentifierV3": { "description": "ClearingIdentifier pairs a routing system with its specific value.", "properties": { "type": { "description": "ClearingIdentifierType specifies the regional system used to route payments to a specific financial institution. These align with ISO 20022 External Clearing System Identification Codes.", "enum": [ "UK_SORT_CODE", "US_ABA_ROUTING", "IN_IFSC", "AU_BSB", "CA_TRANSIT", "DE_BLZ", "HK_BANK_CODE", "SG_BANK_CODE", "NZ_BANK_CODE", "ZA_CLEARING_CODE", "CH_SIC", "JP_ZENGIN", "OTHER" ], "type": "string" }, "value": { "description": "The raw string value of the code. For monitoring, this should be stored as-is without formatting/dashes.", "example": "123456", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "activity_CounterpartyPartyIdentifierV3": { "allOf": [ { "$ref": "#/components/schemas/activity_PartyIdentifierV3" }, { "properties": { "bank_account": { "$ref": "#/components/schemas/activity_BankAccountV3" }, "external_identifier": { "description": "Your unique identifier for Counterparty to which this Party is linked.", "example": "MyCounterpartyIdentifier", "maxLength": 512, "minLength": 0, "type": "string" } }, "type": "object" } ], "description": "Represents the identification details of a counterparty.", "required": [ "type" ], "title": "Counterparty Party Identifier", "type": "object" }, "activity_CryptoAssetV3": { "description": "The asset that was transacted.", "properties": { "identifier": { "$ref": "#/components/schemas/activity_Caip19IdentifierV3" }, "symbol": { "description": "Human friendly short symbol.", "example": "BTC", "nullable": true, "type": "string" } }, "required": [ "identifier" ], "type": "object" }, "activity_CryptoMonetaryTransactionTypeDetailsV3": { "allOf": [ { "$ref": "#/components/schemas/activity_MonetaryTransactionTypeDetailsV3" }, { "properties": { "agents": { "description": "List of agents associated with a crypto transaction.", "items": { "$ref": "#/components/schemas/activity_AgentV3" }, "type": "array" }, "asset": { "$ref": "#/components/schemas/activity_CryptoAssetV3" }, "chain": { "$ref": "#/components/schemas/activity_BlockchainV3" }, "creditor": { "$ref": "#/components/schemas/activity_CryptoPartyV3" }, "debtor": { "$ref": "#/components/schemas/activity_CryptoPartyV3" }, "destination_tag": { "description": "Destination tag/memo identifying recipient.", "type": "string" }, "transaction_hash": { "description": "Transaction blockchain hash ID.", "type": "string" } }, "type": "object" } ], "description": "Crypto-specific transaction details.", "required": [ "agents", "asset", "chain", "creditor", "debtor", "transaction_hash", "type" ], "title": "Crypto Details", "type": "object" }, "activity_CryptoPartyV3": { "description": "Crypto specific Party data structure. Could be counterparty or customer. Follows the model of PartyIdentification type but with additional information.", "properties": { "identification": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "wallet": { "$ref": "#/components/schemas/activity_CryptoWalletV3" } }, "required": [ "identification", "wallet" ], "type": "object" }, "activity_CryptoWalletV3": { "description": "Represents a cryptocurrency wallet involved in a transaction.", "properties": { "chain": { "$ref": "#/components/schemas/activity_BlockchainV3" }, "managing_exchange": { "description": "The human readable friendly name of the exchange that the wallet resides on, if applicable.", "nullable": true, "type": "string" }, "wallet_identifier": { "description": "The crypto wallet identifier. Typically the address of the wallet. (public key)", "type": "string" } }, "required": [ "chain", "wallet_identifier" ], "type": "object" }, "activity_CustomFieldDataTypeV3": { "description": "The type of data stored in a custom field.", "enum": [ "TEXT", "DECIMAL" ], "type": "string" }, "activity_CustomFieldV3": { "description": "A representation of a custom field.", "properties": { "key": { "description": "The key of the custom field.", "example": "field_key", "type": "string" }, "value": { "discriminator": { "mapping": { "DECIMAL": "#/components/schemas/activity_DecimalValueV3", "TEXT": "#/components/schemas/activity_TextValueV3" }, "propertyName": "data_type" }, "oneOf": [ { "$ref": "#/components/schemas/activity_DecimalValueV3" }, { "$ref": "#/components/schemas/activity_TextValueV3" } ] } }, "required": [ "key", "value" ], "type": "object" }, "activity_CustomFieldValueV3": { "description": "The value of the custom field.", "discriminator": { "propertyName": "data_type" }, "properties": { "data_type": { "$ref": "#/components/schemas/activity_CustomFieldDataTypeV3" } }, "required": [ "data_type" ], "type": "object" }, "activity_CustomerPartyIdentifierV3": { "allOf": [ { "$ref": "#/components/schemas/activity_PartyIdentifierV3" }, { "properties": { "external_identifier": { "description": "Your unique identifier for Customer to which this Party is linked.", "example": "MyCustomerIdentifier", "maxLength": 512, "minLength": 0, "type": "string", "writeOnly": true }, "identifier": { "description": "Our unique identifier for Customer to which this Party is linked. We will populate this after mapping your customer identifier to ours as we process your Transaction.", "example": "0195fb35-4793-7bb5-8042-e4371640d176", "format": "uuid", "readOnly": true, "type": "string" } }, "type": "object" } ], "description": "Represents the identification details of a customer party.", "required": [ "type" ], "title": "Customer Party Identifier", "type": "object" }, "activity_DecimalEnrichmentValueV3": { "allOf": [ { "$ref": "#/components/schemas/activity_EnrichmentValueV3" }, { "properties": { "decimal": { "description": "The decimal value", "example": 98.33, "type": "number" } }, "type": "object" } ], "description": "Decimal representation of the enrichment value.", "required": [ "data_type", "decimal" ], "title": "Decimal Value", "type": "object" }, "activity_DecimalValueV3": { "allOf": [ { "$ref": "#/components/schemas/activity_CustomFieldValueV3" }, { "properties": { "decimal": { "description": "The decimal value", "example": 10.02, "type": "number" } }, "type": "object" } ], "description": "Decimal representation of the custom field value.", "required": [ "data_type", "decimal" ], "title": "Decimal Value", "type": "object" }, "activity_DeviceChannelV3": { "allOf": [ { "$ref": "#/components/schemas/activity_ChannelV3" }, { "properties": { "fingerprint": { "description": "Device fingerprint.", "type": "string" }, "phone_number": { "description": "Client phone number used in the transaction.", "type": "string" } }, "type": "object" } ], "description": "Represents the device channel used to initiate a transaction.", "required": [ "fingerprint", "network_details", "type" ], "title": "Device", "type": "object" }, "activity_EnrichmentDataTypeV3": { "description": "The type of data stored in an enrichment value.", "enum": [ "TEXT", "DECIMAL", "BOOLEAN" ], "type": "string" }, "activity_EnrichmentTypeV3": { "description": "The type of enrichment source.", "enum": [ "LOOKUP_LIST", "REGEX_BOOLEAN" ], "example": "LOOKUP_LIST", "type": "string" }, "activity_EnrichmentV3": { "description": "A representation of a transaction enrichment.", "properties": { "key": { "description": "The key of the enrichment.", "example": "debtors_country_risk", "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/activity_EnrichmentTypeV3" }, "value": { "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/activity_BooleanEnrichmentValueV3", "DECIMAL": "#/components/schemas/activity_DecimalEnrichmentValueV3", "TEXT": "#/components/schemas/activity_TextEnrichmentValueV3" }, "propertyName": "data_type" }, "oneOf": [ { "$ref": "#/components/schemas/activity_BooleanEnrichmentValueV3" }, { "$ref": "#/components/schemas/activity_DecimalEnrichmentValueV3" }, { "$ref": "#/components/schemas/activity_TextEnrichmentValueV3" } ] } }, "readOnly": true, "required": [ "key", "type", "value" ], "type": "object" }, "activity_EnrichmentValueV3": { "description": "The value of the enrichment.", "discriminator": { "propertyName": "data_type" }, "properties": { "data_type": { "$ref": "#/components/schemas/activity_EnrichmentDataTypeV3" } }, "required": [ "data_type" ], "type": "object" }, "activity_FincenCashTransactionSubtype": { "description": "Defines the subtype of FinCEN transactions.", "enum": [ "DEPOSIT", "PAYMENT", "CURRENCY_TRANSFER_OUT", "NEGOTIABLE_INSTRUMENT_PURCHASE", "CURRENCY_EXCHANGE", "CURRENCY_TO_PREPAID_ACCESS", "GAMING_INSTRUMENT_PURCHASE", "CURRENCY_WAGER", "BILLS_INSERTED_INTO_GAMING_DEVICES", "WITHDRAWAL", "ADVANCE_ON_CREDIT", "CURRENCY_TRANSFER_IN", "NEGOTIABLE_INSTRUMENT_CASHED", "CURRENCY_FROM_PREPAID_ACCESS", "GAMING_INSTRUMENT_REDEMPTION", "PAYMENT_ON_WAGER", "TRAVEL_COMPLIMENTARY_EXPENSES", "PROMOTION_PAYMENT", "OTHER" ], "example": "PAYMENT", "nullable": true, "type": "string" }, "activity_FincenDetailsV3": { "description": "FinCEN transaction details.", "properties": { "fincen_cash_transaction_subtype": { "$ref": "#/components/schemas/activity_FincenCashTransactionSubtype" }, "gto_type_codes": { "description": "List of GTO type codes associated with the transaction.", "example": [ "MSB0326GTO" ], "items": { "description": "List of GTO type codes associated with the transaction.", "example": "[\"MSB0326GTO\"]", "type": "string" }, "nullable": true, "type": "array" } }, "type": "object" }, "activity_GeographicCoordinatesV3": { "description": "Geographic location represented by the latitude and longitude.", "properties": { "latitude": { "description": "The angular distance north or south of the Earth's equator, measured in degrees. Valid range: -90 to +90, where negative values represent southern latitudes and positive values represent northern latitudes.", "example": -34.603722, "maximum": 90, "minimum": -90, "type": "number" }, "longitude": { "description": "The angular distance east or west of the prime meridian, measured in degrees. Valid range: -180 to +180, where negative values represent western longitudes and positive values represent eastern longitudes.", "example": 148.516389, "maximum": 180, "minimum": -180, "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "activity_InternetProtocolAddressV3": { "description": "Represents an Internet Protocol (IP) address with its associated type information.", "properties": { "address": { "description": "The IP address in the native format.", "example": "192.168.1.1", "pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))", "type": "string" }, "type": { "$ref": "#/components/schemas/activity_InternetProtocolInformationV3" } }, "required": [ "address", "type" ], "type": "object" }, "activity_InternetProtocolInformationV3": { "description": "Enumeration for available IP format values.", "enum": [ "IPV4", "IPV6" ], "type": "string" }, "activity_IssuerV3": { "description": "Represents the card issuer information.", "properties": { "bank_identification_number": { "description": "Bank Identification Number (first 6-8 digits of card).", "example": "424242", "nullable": true, "pattern": "^[0-9]{6,8}$", "type": "string" }, "details": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" } }, "type": "object" }, "activity_LoanProductV3": { "allOf": [ { "$ref": "#/components/schemas/activity_ProductV3" }, { "properties": { "base_loan_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "base_remaining_balance_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "expected_installment_count": { "description": "The expected number of loan installments to be made.", "example": 12, "format": "int32", "type": "integer" }, "expected_repayment_date": { "description": "The expected repayment date of the loan.", "example": "2025-04-03T00:00:00.000Z", "format": "date", "type": "string" }, "funded_at": { "description": "The timestamp the loan was funded.", "example": "2025-04-03T11:32:00.000Z", "format": "date-time", "type": "string" }, "loan_type": { "$ref": "#/components/schemas/activity_LoanTypeV3" }, "loan_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "remaining_balance_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "settled_at": { "description": "The timestamp the loan was settled.", "example": "2025-04-03T11:32:00.000Z", "format": "date-time", "type": "string" } }, "type": "object" } ], "description": "Represents a loan product.", "required": [ "base_loan_value", "base_remaining_balance_value", "loan_type", "type" ], "title": "Loan", "type": "object" }, "activity_LoanTypeV3": { "description": "Defines the type of loan.", "enum": [ "CREDIT_CARD", "DEBT_CONSOLIDATION", "HOME_EQUITY", "GUARANTOR_LOAN", "OVERDRAFT", "BUY_NOW_PAY_LATER", "TERM_LOAN", "WORKING_CAPITAL_FINANCE", "COMMERCIAL_MORTGAGE", "ASSET_FINANCE", "INVOICE_FINANCE", "SYNDICATED_LOAN", "SMALL_BUSINESS_LOAN", "BRIDGING_LOAN", "MICROFINANCE", "CRYPTO_COLLATERALIZED_LOAN", "HOME_EQUITY_LOAN", "STUDENT_LOAN", "DEBT_CONSOLIDATION_LOAN", "CREDIT_BUILDER_LOAN", "MORTGAGE", "PERSONAL", "PAYDAY", "VEHICLE", "OTHER" ], "example": "BRIDGING_LOAN", "type": "string" }, "activity_LocalAccountDetailsV3": { "description": "Represents banking information for 'domestic rail' transactions where a global standard like IBAN is not used.", "properties": { "account_number": { "description": "The primary account number (BAN).", "type": "string" }, "account_number_suffix": { "description": "Regional extension for specific markets. In the NZ, this is the 2-3 digit suffix distinguishing sub-accounts. In the UK, this could contain a building society roll number.", "nullable": true, "type": "string" }, "clearing_identifier": { "$ref": "#/components/schemas/activity_ClearingIdentifierV3" } }, "required": [ "account_number", "clearing_identifier" ], "type": "object" }, "activity_MerchantV3": { "description": "Represents merchant information.", "properties": { "category_type": { "description": "Represents the category types for Merchant Category Codes based on industry code ranges.", "enum": [ "AGRICULTURAL_SERVICES", "CONTRACTED_SERVICES", "TRANSPORTATION_SERVICES", "UTILITY_SERVICES", "RETAIL_OUTLET_SERVICES", "CLOTHING_SHOPS", "MISCELLANEOUS_SHOPS", "BUSINESS_SERVICES", "PROFESSIONAL_SERVICES", "GOVERNMENT_SERVICES" ], "example": "RETAIL_OUTLET_SERVICES", "nullable": true, "type": "string" }, "details": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "mcc_category_code": { "description": "4-digit Merchant Category Code.", "example": "5411", "nullable": true, "pattern": "^[0-9]{4}$", "type": "string" }, "mcc_code_description": { "description": "Human-readable MCC description.", "example": "Grocery Stores, Supermarkets", "maxLength": 200, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_MonetaryTransactionClassificationDetailsV3": { "allOf": [ { "$ref": "#/components/schemas/activity_TransactionClassificationDetailsV3" }, { "properties": { "base_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "customer_account_balance": { "$ref": "#/components/schemas/activity_AccountBalanceV3" }, "details": { "discriminator": { "mapping": { "BANK_PAYMENT": "#/components/schemas/activity_BankPaymentMonetaryTransactionTypeDetailsV3", "CARD_PAYMENT": "#/components/schemas/activity_CardPaymentMonetaryTransactionTypeDetailsV3", "CRYPTO": "#/components/schemas/activity_CryptoMonetaryTransactionTypeDetailsV3", "REMITTANCE": "#/components/schemas/activity_RemittanceMonetaryTransactionTypeDetailsV3" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/activity_BankPaymentMonetaryTransactionTypeDetailsV3" }, { "$ref": "#/components/schemas/activity_CardPaymentMonetaryTransactionTypeDetailsV3" }, { "$ref": "#/components/schemas/activity_CryptoMonetaryTransactionTypeDetailsV3" }, { "$ref": "#/components/schemas/activity_RemittanceMonetaryTransactionTypeDetailsV3" } ] }, "direction": { "$ref": "#/components/schemas/activity_MonetaryTransactionDirectionV3" }, "local_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "payment_channel": { "$ref": "#/components/schemas/activity_PaymentChannelV3" }, "product_name": { "description": "The freeform name of the product being used to perform the financial transaction.", "example": "Product X, Issue 1", "maxLength": 256, "minLength": 0, "type": "string" }, "reference_text": { "description": "The reference text supplied as part of the financial transaction (if any).", "example": "Invoice 1234", "maxLength": 512, "minLength": 0, "type": "string" }, "value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" } }, "type": "object" } ], "description": "Details related to a monetary transaction.", "required": [ "base_value", "classification", "details" ], "title": "Monetary Transaction Details", "type": "object" }, "activity_MonetaryTransactionDirectionV3": { "description": "Defines the direction of the flow of value in the transaction in relation to the primary Customer in a Monetary Transaction.", "enum": [ "OUTBOUND", "INBOUND" ], "readOnly": true, "type": "string" }, "activity_MonetaryTransactionTypeDetailsV3": { "description": "Details specific to the a Monetary Transaction.", "discriminator": { "propertyName": "type" }, "properties": { "type": { "$ref": "#/components/schemas/activity_MonetaryTransactionTypeV3" } }, "required": [ "type" ], "type": "object" }, "activity_MonetaryTransactionTypeV3": { "description": "Defines the type of a monetary transaction.", "enum": [ "BANK_PAYMENT", "CARD_PAYMENT", "REMITTANCE", "CRYPTO" ], "example": "BANK_PAYMENT", "type": "string" }, "activity_MonetaryValueV3": { "description": "Represents a combination of a decimal amount with a currency.", "properties": { "amount": { "description": "The decimal amount/value.", "example": 10.02, "type": "number" }, "crypto_asset": { "$ref": "#/components/schemas/activity_CryptoAssetV3" }, "currency": { "description": "3 letter currency code as defined by ISO-4217.", "example": "EUR", "format": "iso-4217", "maxLength": 3, "minLength": 3, "nullable": true, "type": "string" } }, "required": [ "amount" ], "type": "object" }, "activity_MoneyTransferOperatorV3": { "description": "Represents a money transfer operator's details.", "properties": { "identifier": { "description": "A unique identifier for the money transfer operator, such as a SWIFT BIC or regulatory identifier.", "example": "WUIBUS6S", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" }, "name": { "description": "The legal name of the money transfer operator.", "example": "Western Union", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_OnlineRemittancePlatformV3": { "description": "Represents an online remittance platform's details.", "properties": { "identifier": { "description": "A unique identifier for the online remittance platform.", "example": "remittance-identifier", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" }, "name": { "description": "The brand or platform name of the online remittance service.", "example": "Wise", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_PartyIdentificationV3": { "description": "Represents the identification details of a party. This includes not just the party's identifier, but also any other identifying information specific to the transaction such as alternate names or addresses.", "properties": { "address": { "discriminator": { "mapping": { "STRUCTURED": "#/components/schemas/activity_StructuredAddressV3", "UNSTRUCTURED": "#/components/schemas/activity_UnstructuredAddressV3" }, "propertyName": "format" }, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/activity_StructuredAddressV3" }, { "$ref": "#/components/schemas/activity_UnstructuredAddressV3" } ] }, "identifier": { "discriminator": { "mapping": { "COUNTERPARTY": "#/components/schemas/activity_CounterpartyPartyIdentifierV3", "CUSTOMER": "#/components/schemas/activity_CustomerPartyIdentifierV3" }, "propertyName": "type" }, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/activity_CounterpartyPartyIdentifierV3" }, { "$ref": "#/components/schemas/activity_CustomerPartyIdentifierV3" } ] }, "name": { "description": "The name of the party.", "example": "John Doe", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_PartyIdentifierV3": { "description": "Party identifier details", "discriminator": { "propertyName": "type" }, "properties": { "type": { "description": "The type of party identifier.", "enum": [ "CUSTOMER", "COUNTERPARTY" ], "example": "CUSTOMER", "type": "string" } }, "required": [ "type" ], "type": "object" }, "activity_PaymentCardV3": { "description": "Details about a payment card used in a transaction.", "properties": { "fingerprint": { "description": "Unique hashed card identifier for tracking.", "example": "card_fingerprint_123456", "maxLength": 100, "minLength": 0, "type": "string" }, "funding_type": { "$ref": "#/components/schemas/activity_CardFundingTypeV3" }, "wallet_identifier": { "description": "Digital wallet identifier if applicable.", "example": "wallet_12345678", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" }, "wallet_type": { "$ref": "#/components/schemas/activity_CardWalletTypeV3" } }, "required": [ "fingerprint" ], "type": "object" }, "activity_PaymentChannelV3": { "description": "The channel used for a payment.", "enum": [ "OTHER", "MOBILE", "WEB", "BRANCH", "TELEPHONE", "ATM", "POS", "KIOSK", "AGENT", "API", "IVR", "MAIL" ], "example": "MOBILE", "type": "string" }, "activity_PaymentSchemeV3": { "description": "The payment scheme that was used to initiate the financial transaction.", "enum": [ "OTHER", "SWIFT", "SEPA", "SEPA_INSTANT", "FASTER_PAYMENTS", "CHAPS", "BACS", "FEDNOW", "SWIFT_GPI", "T2", "TIPS", "NPA", "FEDWIRE", "ACH", "SAME_DAY_ACH", "RTP_TCH", "ZELLE", "INTERAC_ETRANSFER", "LYNX", "ACSS", "RTR", "SPEI", "PIX", "STR", "TED", "UPI", "IMPS", "NEFT", "RTGS", "RAAST", "FAST", "PAYNOW", "DUITNOW", "PROMPTPAY", "BI_FAST", "INSTAPAY", "PESONET", "NAPAS_247", "BAKONG", "CNAPS", "HVPS", "IBPS", "CIPS", "CHATS", "FPS", "ZENGIN", "BOJ_NET", "BOK_WIRE_PLUS", "NPP", "OSKO", "PAYTO", "BECS", "RITS", "AANI", "UAEFTS", "SARIE", "FAWRAN", "ZAHAV", "MARI", "NIP", "CBN_RTGS", "PAYSHAP", "SAMOS", "PESALINK", "KEPSS", "GIP", "PAPSS", "BUNA", "AFAQ", "GIMACPAY", "TCIB", "SBP", "BESP", "MOBILE_MONEY_MTN_MOMO", "MOBILE_MONEY_AIRTEL_MONEY", "MOBILE_MONEY_ORANGE_MONEY", "MOBILE_MONEY_WAVE", "GCASH", "MAYA", "OVO", "DANA", "GOPAY", "TRUEMONEY", "MOMO", "PAYTM", "PHONEPE", "STC_PAY", "CAREEM_PAY", "CLS", "CHIPS", "TARGET2_T2S", "SEPA_SCT", "SEPA_SDD_CORE", "SEPA_SDD_B2B", "EBA_EURO1", "EBA_STEP2", "EBA_RT1", "MYBANK", "EPI_WERO", "OPEN_BANKING_PAYMENTS", "BIZUM", "SNCE_IBERPAY", "IDEAL", "EQUENS", "PAYCONIQ", "CEC", "GIROPAY", "RPS_SEPA_CLEARER", "PAYDIREKT", "CORE", "PAYLIB", "BANCOMAT_PAY", "BICOMP", "MBWAY", "SICOI", "DIAS", "IRIS", "SIC", "SIC_IP", "EUROSIC", "TWINT", "EXPRESS_ELIXIR", "ELIXIR", "SORBNET2", "BLIK", "CERTIS", "GIRO", "AFR", "QVIK", "VIBER", "TRANSFOND_SENT", "REGIS", "ROPAY", "BISERA", "BLINK", "RINGS", "NKSINST", "IPS_NBS", "RTGS_NBS", "KOLAS", "EFT", "IPS", "SWISH", "RIX_INST", "RIX", "BANKGIROT", "VIPPS", "NICS", "STRAKSBETALINGER", "NBO", "MOBILEPAY", "STRAKSCLEARING", "SUMCLEARINGEN", "KRONOS2", "SIIRTO", "PIVO", "NORDIC_P27", "CODI", "DIMO", "SIAC", "SITRAF", "BOLETO", "TRANSFERENCIAS_3_0", "DEBIN", "MODO", "MEP", "CCE_COELSA", "TEF", "LBTR", "PSE", "TRANSFIYA", "BRE_B", "CUD", "YAPE", "PLIN", "CCE", "LBBCRP", "SPI", "SINPE", "SINPE_MOVIL", "SIPARD", "UY_TR", "SLBTR", "BCB_LIP", "QR_SIMPLE", "SIPAP", "AEPS", "NACH", "BBPS", "E_RUPI", "CEFTS", "LANKASETTLE", "ONELINK_IBFT", "PRISM", "BKASH", "NAGAD", "BINIMOY", "BEFTN", "CONNECTIPS", "NEPS_RTGS", "GIFT", "MEPS_PLUS", "IBFT", "FPX", "RENTAS", "BAHTNET", "BI_RTGS", "SKNBI", "QRIS", "PHILPASS", "QR", "VIETQR", "CITAD", "BEPS", "NUCC_NETSUNION", "CDFCPS", "ALIPAY", "WECHAT_PAY", "E_CNY", "CIFS", "FISC_IFT", "CBC_IFTS", "FXYCS", "PAY_EASY", "PAYPAY", "KFTC_INTERBANK", "KAKAOPAY", "NAVER_PAY", "TOSS", "PAYID", "BPAY", "ESAS", "SBI_BECS", "DIGITAL_DIRHAM", "SARTGS", "QMP", "QPS", "FAWRI", "FAWRI_PLUS", "FAWATEER", "BENEFITPAY", "KASSIP", "MPCSS", "CLIQ", "JOMOPAY", "MASAV", "AEBC", "VIREMENT_INSTANTANE", "SRBM", "ATCI_SACI", "ARTS", "SWITMOBILE", "SIBTEL", "LYPAY", "NQR", "ENAIRA", "RTC", "EFT_CREDIT", "M_PESA", "TISS", "GIPS", "UNISS", "EKASH_RSWITCH", "RIPPS", "MMI", "EZWICH", "GHANA_RTGS", "NFS", "ZIPSS", "ETHSWITCH", "EATS", "SADC_RTGS", "EAPS", "REPSS", "PROJECT_NEXUS", "PROJECT_MBRIDGE", "UPI_PAYNOW_LINK", "PROMPTPAY_PAYNOW_LINK", "DUITNOW_PROMPTPAY_LINK", "SPFS", "BISS", "KCIPS", "PROSTIR", "SEP", "ZALOPAY", "KBZPAY", "STABLECOIN_USDC", "STABLECOIN_USDT", "STABLECOIN_PYUSD", "STABLECOIN_EURC" ], "example": "SWIFT", "type": "string" }, "activity_PaymentStagesInfoV3": { "description": "Payment stages information.", "properties": { "authorization": { "$ref": "#/components/schemas/activity_AuthorizationInfoV3" }, "chargeback": { "$ref": "#/components/schemas/activity_ChargebackInfoV3" }, "refund": { "$ref": "#/components/schemas/activity_RefundInfoV3" }, "reversal": { "$ref": "#/components/schemas/activity_ReversalInfoV3" }, "settlement": { "$ref": "#/components/schemas/activity_SettlementInfoV3" } }, "type": "object" }, "activity_PointOfSaleConditionCodeV3": { "description": "Point of sale condition code and description", "properties": { "code": { "description": "2-digit POS condition code", "example": "59", "nullable": true, "pattern": "^[0-9]{2}$", "type": "string" }, "description": { "description": "Human-readable POS condition description", "example": "E-commerce transaction - card not present", "maxLength": 200, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_PointOfSaleConditionV3": { "description": "Contains contextual information about the card payment environment.", "properties": { "condition": { "$ref": "#/components/schemas/activity_PointOfSaleConditionCodeV3" }, "entry_mode": { "$ref": "#/components/schemas/activity_PointOfSaleEntryModeV3" } }, "type": "object" }, "activity_PointOfSaleEntryModeV3": { "description": "Point of sale entry mode code and description", "properties": { "code": { "description": "3-digit POS entry mode code", "example": "012", "nullable": true, "pattern": "^[0-9]{3}$", "type": "string" }, "description": { "description": "Human-readable POS entry mode description", "example": "E-commerce transaction", "maxLength": 200, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_ProblemDetailErrorResponse": { "additionalProperties": true, "properties": { "detail": { "nullable": true, "type": "string" }, "identifier": { "format": "uuid", "type": "string" }, "instance": { "format": "uri", "nullable": true, "type": "string" }, "status": { "format": "int32", "nullable": true, "type": "integer" }, "timestamp": { "format": "date-time", "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "format": "uri", "nullable": true, "type": "string" } }, "required": [ "identifier", "timestamp" ], "type": "object" }, "activity_ProductTypeV3": { "description": "Defines the type of product payload.", "enum": [ "LOAN" ], "type": "string" }, "activity_ProductV3": { "description": "Represents product details associated with a transaction.", "discriminator": { "propertyName": "type" }, "properties": { "base_expected_monthly_payment_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "expected_monthly_payment_value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" }, "external_identifier": { "description": "The client's identifier for the product.", "example": "customer_loan_id", "maxLength": 512, "minLength": 0, "type": "string" }, "identifier": { "description": "The CA internal identifier for the product.", "example": "0195fb35-4793-7bb5-8042-e4371640d176", "format": "uuid", "nullable": true, "readOnly": true, "type": "string" }, "monthly_transaction_count": { "description": "The monthly transaction number of the product.", "example": 12, "format": "int64", "nullable": true, "type": "integer" }, "name": { "description": "The name of the product.", "example": "Personal Loan", "maxLength": 256, "minLength": 0, "type": "string" }, "type": { "$ref": "#/components/schemas/activity_ProductTypeV3" } }, "required": [ "external_identifier", "name", "type" ], "type": "object" }, "activity_RefundInfoV3": { "description": "Refund information.", "properties": { "reason": { "$ref": "#/components/schemas/activity_RefundReasonV3" }, "timestamp": { "description": "Refund timestamp.", "format": "date-time", "type": "string" } }, "required": [ "timestamp" ], "type": "object" }, "activity_RefundReasonV3": { "description": "Refund reason information.", "properties": { "code": { "description": "Reason code for refund.", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" }, "description": { "description": "Reason description.", "maxLength": 200, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_RegulatoryReportDetailsV3": { "description": "Regulatory reporting transaction details.", "properties": { "fincen_details": { "$ref": "#/components/schemas/activity_FincenDetailsV3" }, "transaction_location_external_identifier": { "description": "Your unique identifier for the Transaction Location.", "example": "MyLocationIdentifier", "maxLength": 512, "minLength": 0, "nullable": true, "type": "string" } }, "type": "object" }, "activity_RemittanceCreditorV3": { "description": "Represents the creditor in a remittance transaction.", "properties": { "cash_pickup": { "$ref": "#/components/schemas/activity_CashPickupDetailsV3" }, "details": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" } }, "required": [ "details" ], "type": "object" }, "activity_RemittanceMonetaryTransactionTypeDetailsV3": { "allOf": [ { "$ref": "#/components/schemas/activity_MonetaryTransactionTypeDetailsV3" }, { "properties": { "agents": { "description": "Any intermediaries involved in the transaction between the creditor and the debtor.", "items": { "$ref": "#/components/schemas/activity_AgentV3" }, "maxItems": 10, "minItems": 0, "type": "array" }, "collection_method": { "$ref": "#/components/schemas/activity_RemittancePaymentMethodV3" }, "creditor": { "$ref": "#/components/schemas/activity_RemittanceCreditorV3" }, "debtor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "payment_scheme": { "$ref": "#/components/schemas/activity_PaymentSchemeV3" }, "purpose_of_payment": { "$ref": "#/components/schemas/activity_RemittancePurposeV3" }, "purpose_of_payment_details": { "description": "Free-text details about the purpose of the remittance payment.", "maxLength": 50, "minLength": 0, "type": "string" }, "relationship": { "$ref": "#/components/schemas/activity_RemittanceRelationshipV3" }, "service_provider": { "$ref": "#/components/schemas/activity_RemittanceServiceProviderV3" }, "source_of_funds": { "$ref": "#/components/schemas/activity_RemittanceSourceOfFundsV3" }, "source_of_funds_details": { "description": "Free-text details about the source of funds for the remittance transfer.", "maxLength": 50, "minLength": 0, "type": "string" }, "source_payment_method": { "$ref": "#/components/schemas/activity_RemittancePaymentMethodV3" }, "ultimate_creditor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" }, "ultimate_debtor": { "$ref": "#/components/schemas/activity_PartyIdentificationV3" } }, "type": "object" } ], "description": "Models a cross-border remittance payment transaction between parties in different countries.", "required": [ "creditor", "debtor", "type" ], "title": "Remittance Details", "type": "object" }, "activity_RemittancePaymentMethodV3": { "description": "The payment method used for remittance transactions.", "enum": [ "CASH", "CREDIT_CARD", "DEBIT_CARD", "BANK_TRANSFER", "MOBILE_WALLET", "PREPAID_CARD", "CHEQUE", "CRYPTOCURRENCY", "GIFT_CARD", "POSTAL_ORDER", "BARTER", "OTHER", "CARD", "COMBINED_MULTIPLE", "CASH_DEPOSIT", "CASH_WITHDRAWAL", "CASH_AT_AGENT", "CASH_AT_MERCHANT", "INSTANT_BANK_TRANSFER", "WIRE_TRANSFER", "DIRECT_DEBIT", "STABLECOIN", "CBDC", "CARD_PUSH_PAYMENT", "MOBILE_MONEY", "VOUCHER" ], "example": "CASH", "type": "string" }, "activity_RemittancePurposeV3": { "description": "The purpose of the remittance payment.", "enum": [ "FAMILY_SUPPORT", "EDUCATION", "MEDICAL", "BUSINESS", "PROPERTY", "EMERGENCY", "SAVINGS", "GIFT", "TRAVEL", "DEBT_REPAYMENT", "PURCHASE", "SALARY", "RENT", "OTHER", "TAXES", "UTILITIES", "INSURANCE_PREMIUM", "INVESTMENT", "CHARITY_DONATION", "GOVERNMENT_PAYMENT", "LOAN_DISBURSEMENT", "LOAN_REPAYMENT", "PENSION", "DIVIDEND", "ROYALTIES", "LEGAL_SETTLEMENT", "TRADE_GOODS_IMPORT", "TRADE_GOODS_EXPORT", "TRADE_SERVICES", "WAGES", "INTRA_COMPANY", "CARD_REPAYMENT", "MORTGAGE_PAYMENT", "ALIMONY", "CHILD_SUPPORT", "REFUND", "COMMISSION", "CRYPTO_PURCHASE", "CRYPTO_SALE", "FOREIGN_EXCHANGE" ], "type": "string" }, "activity_RemittanceRelationshipV3": { "description": "The relationship between the sender and receiver in a remittance transaction.", "enum": [ "SPOUSE", "FAMILY", "FRIEND", "BUSINESS_PARTNER", "EMPLOYEE", "OTHER", "SELF", "CHILD", "PARENT", "SIBLING", "EMPLOYER", "CHARITY", "CLIENT", "SUPPLIER", "LENDER", "UNKNOWN" ], "type": "string" }, "activity_RemittanceServiceProviderTypeV3": { "description": "The type of service provider facilitating the remittance transaction.", "enum": [ "TRADITIONAL_BANK", "MONEY_TRANSFER_OPERATOR", "DIGITAL_PLATFORM", "ONLINE_PAYMENT_SERVICE", "MOBILE_MONEY_SERVICE", "CRYPTOCURRENCY_PLATFORM", "NEOBANK", "OTHER" ], "example": "MONEY_TRANSFER_OPERATOR", "type": "string" }, "activity_RemittanceServiceProviderV3": { "description": "Represents a remittance service provider's details.", "properties": { "identifier": { "description": "The unique identifier for the remittance service provider.", "example": "RSP-12345", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" }, "name": { "description": "The name of the remittance service provider.", "example": "Western Union", "maxLength": 256, "minLength": 0, "nullable": true, "type": "string" }, "type": { "$ref": "#/components/schemas/activity_RemittanceServiceProviderTypeV3" } }, "type": "object" }, "activity_RemittanceSourceOfFundsV3": { "description": "The source of funds for the remittance transaction.", "enum": [ "SALARY", "BUSINESS_INCOME", "SAVINGS", "INVESTMENTS", "PENSION", "LOAN", "GIFT", "INHERITANCE", "ASSET_SALE", "INSURANCE_PAYOUT", "GOVERNMENT_BENEFITS", "TRUST_DISTRIBUTION", "CRYPTO_LIQUIDATION", "CROWDFUNDING", "GAMBLING_WINNINGS", "OTHER", "WAGES_SELF_EMPLOYMENT", "RENTAL_INCOME", "ROYALTIES", "DIVIDENDS_AND_INTEREST", "MATURED_INVESTMENTS", "MATURED_INSURANCE_POLICY", "LEGAL_SETTLEMENT", "LOTTERY_OR_PRIZE", "EXPORT_OF_GOODS", "SALE_OF_BUSINESS", "SALE_OF_PROPERTY", "STIPEND_OR_SCHOLARSHIP", "ALIMONY_OR_CHILD_SUPPORT", "RESEARCH_GRANT", "COMPENSATION_PAYMENT" ], "type": "string" }, "activity_ReversalInfoV3": { "description": "Reversal information.", "properties": { "identifier": { "description": "Unique reversal identifier.", "maxLength": 50, "minLength": 0, "nullable": true, "type": "string" }, "timestamp": { "description": "Reversal timestamp.", "format": "date-time", "type": "string" }, "value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" } }, "required": [ "timestamp", "value" ], "type": "object" }, "activity_SettlementInfoV3": { "description": "Settlement information.", "properties": { "timestamp": { "description": "Settlement timestamp.", "example": "2024-01-16T08:15:00.000Z", "format": "date-time", "type": "string" }, "value": { "$ref": "#/components/schemas/activity_MonetaryValueV3" } }, "required": [ "timestamp", "value" ], "type": "object" }, "activity_StructuredAddressV3": { "allOf": [ { "$ref": "#/components/schemas/activity_AddressV3" }, { "properties": { "address_line1": { "description": "The first line of the address.", "example": "123 Main St", "maxLength": 256, "minLength": 0, "type": "string" }, "address_line2": { "description": "The second line of the address.", "example": "Apt 4B", "maxLength": 256, "minLength": 0, "type": "string" }, "address_type": { "$ref": "#/components/schemas/activity_AddressTypeV3" }, "country": { "description": "2 letter country code as defined by iso-3166-alpha-2.", "example": "GB", "format": "iso-3166-alpha-2", "pattern": "^([A-Z]{2})?$", "type": "string" }, "country_subdivision": { "description": "The country subdivision (e.g., state, province).", "example": "Greater London", "maxLength": 256, "minLength": 0, "type": "string" }, "postal_code": { "description": "The postal code of the address.", "example": "SW1A 0AA", "maxLength": 256, "minLength": 0, "type": "string" }, "town_name": { "description": "The town or city name.", "example": "London", "maxLength": 256, "minLength": 0, "type": "string" } }, "type": "object" } ], "description": "Represents a structured address with detailed components.", "required": [ "format" ], "title": "Structured Address", "type": "object" }, "activity_TextEnrichmentValueV3": { "allOf": [ { "$ref": "#/components/schemas/activity_EnrichmentValueV3" }, { "properties": { "text": { "description": "The text content.", "example": "HIGH", "maxLength": 256, "minLength": 0, "type": "string" } }, "type": "object" } ], "description": "String representation of the enrichment value.", "required": [ "data_type", "text" ], "title": "Text Value", "type": "object" }, "activity_TextValueV3": { "allOf": [ { "$ref": "#/components/schemas/activity_CustomFieldValueV3" }, { "properties": { "text": { "description": "The text content.", "example": "Text Field Value", "maxLength": 256, "minLength": 0, "type": "string" } }, "type": "object" } ], "description": "String representation of the custom field value.", "required": [ "data_type", "text" ], "title": "Text Value", "type": "object" }, "activity_TransactionClassificationDetailsV3": { "description": "Details specific to the Transaction classification.", "discriminator": { "propertyName": "classification" }, "properties": { "classification": { "$ref": "#/components/schemas/activity_TransactionClassificationV3" } }, "required": [ "classification" ], "type": "object" }, "activity_TransactionClassificationV3": { "description": "Classifies a transaction as a specific high-level class of transaction.", "enum": [ "MONETARY" ], "example": "MONETARY", "type": "string" }, "activity_TransactionV3": { "description": "Represents a Transaction performed by a Customer. A Transaction can be either monetary or non-monetary.", "properties": { "custom_fields": { "description": "A list of custom fields attached to the Transaction.", "items": { "$ref": "#/components/schemas/activity_CustomFieldV3" }, "maxItems": 10, "minItems": 0, "nullable": true, "type": "array" }, "customer_external_identifier": { "description": "Your unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.", "example": "MyUniqueCustomerReference", "maxLength": 512, "minLength": 0, "type": "string" }, "customer_identifier": { "description": "Our unique identifier for customer that the Transaction is associated with. We will populate this after mapping your customer identifier to ours as we process your Transaction.", "example": "0195fb35-4793-7bb5-8042-e4371640d176", "format": "uuid", "readOnly": true, "type": "string" }, "details": { "discriminator": { "mapping": { "MONETARY": "#/components/schemas/activity_MonetaryTransactionClassificationDetailsV3" }, "propertyName": "classification" }, "oneOf": [ { "$ref": "#/components/schemas/activity_MonetaryTransactionClassificationDetailsV3" } ] }, "enrichments": { "description": "A list of enrichments applied to the Transaction.", "items": { "$ref": "#/components/schemas/activity_EnrichmentV3" }, "nullable": true, "readOnly": true, "type": "array" }, "evaluation_outcome": { "description": "The combined outcome of all transaction evaluations.", "enum": [ "PENDING", "PROCESS", "ALLOW", "HOLD", "ERROR" ], "readOnly": true, "type": "string" }, "external_identifier": { "description": "Your unique identifier for the Transaction. You will use this to reference the Transaction within our systems. This cannot be changed after submitting the Transaction.", "example": "MyUniqueIdentifier", "maxLength": 512, "minLength": 0, "type": "string" }, "identifier": { "description": "Our unique identifier for your Transaction. We generate this when we process your Transaction and you are not able to specify it.", "format": "uuid", "nullable": true, "readOnly": true, "type": "string" }, "initiating_channel": { "discriminator": { "mapping": { "ATM": "#/components/schemas/activity_AtmChannelV3", "DEVICE": "#/components/schemas/activity_DeviceChannelV3" }, "propertyName": "type" }, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/activity_AtmChannelV3" }, { "$ref": "#/components/schemas/activity_DeviceChannelV3" } ] }, "occurred_at": { "description": "The timestamp of the Transaction. This is the timestamp you want us to use as this transactions position in time for the purposes of risk analysis. This timestamp can contain offset information.", "example": "2025-04-03T03:32:00.000Z", "format": "date-time", "type": "string" }, "product": { "discriminator": { "mapping": { "LOAN": "#/components/schemas/activity_LoanProductV3" }, "propertyName": "type" }, "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/activity_LoanProductV3" } ] }, "received_at": { "description": "The timestamp the Transaction event was received by us.", "example": "2025-04-03T11:32:00.000Z", "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "regulatory_reporting_details": { "$ref": "#/components/schemas/activity_RegulatoryReportDetailsV3" }, "review_decision": { "description": "Represents the states of review decision", "enum": [ "NOT_APPLICABLE", "NOT_REVIEWED", "RELEASE", "REJECT" ], "readOnly": true, "type": "string" }, "version": { "description": "The version of the transaction.", "example": 3, "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" } }, "required": [ "customer_external_identifier", "customer_identifier", "details", "evaluation_outcome", "external_identifier", "occurred_at", "review_decision", "version" ], "type": "object" }, "activity_UnstructuredAddressV3": { "allOf": [ { "$ref": "#/components/schemas/activity_AddressV3" }, { "properties": { "country": { "description": "An unstructured text representation of a country", "example": "Spain", "type": "string" }, "local_details": { "description": "The local details of the address.", "example": "123 Main Street, London", "maxLength": 512, "minLength": 0, "type": "string" } }, "type": "object" } ], "description": "Represents an unstructured address with local details and country.", "required": [ "format" ], "title": "Unstructured Address", "type": "object" }, "activity_VerificationCheckResultV3": { "description": "Represents the result of a verification check.", "enum": [ "PASS", "FAIL", "UNAVAILABLE", "UNCHECKED" ], "example": "PASS", "type": "string" }, "activity_VerificationCheckV3": { "description": "Represents a verification check with result and optional description.", "properties": { "description": { "description": "Human-readable verification check description.", "example": "Address and ZIP code match", "maxLength": 200, "minLength": 0, "nullable": true, "type": "string" }, "result": { "$ref": "#/components/schemas/activity_VerificationCheckResultV3" } }, "type": "object" }, "activity_VirtualAssetServiceProviderV3": { "description": "Type for storing VASP details.", "properties": { "name": { "description": "The name of the VASP.", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "HTTP Bearer Token Authentication", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Mesh API", "version": "v2.0" }, "openapi": "3.0.3", "paths": { "/v3/transactions/{identifier}/versions/{version}": { "get": { "description": "When you submit a transaction to us we allocate an internal identifier for the Transaction. This API allows you to retrieve a specific version of a Transaction using the identifier we set when we received your transaction.", "operationId": "activityStoreGetTransactionVersionByInternalIdentifier", "parameters": [ { "description": "Our identifier for the transaction.", "example": "01966d5b-e4fa-7b60-a2d7-5b5225fbd39a", "in": "path", "name": "identifier", "required": true, "schema": { "description": "Our identifier for the transaction.", "example": "01966d5b-e4fa-7b60-a2d7-5b5225fbd39a", "format": "uuid", "type": "string" } }, { "description": "The version of the transaction.", "example": 1, "in": "path", "name": "version", "required": true, "schema": { "description": "The version of the transaction.", "example": 1, "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activity_TransactionV3" } } }, "description": "Stored Transaction Information" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse" } } }, "description": "Transaction not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse" } } }, "description": "Internal Server Error" } }, "summary": "Retrieve a specific version of a Transaction using our identifier", "tags": [ "Transactions" ] } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "description": "ComplyAdvantage Mesh API", "url": "https://api.mesh.complyadvantage.com" } ], "tags": [ { "name": "Transactions" } ] } ```