When you create or edit an event, the fields below are either optional or required.

general_data

Fields

Description

Example

event_id

Unique identifier of the even in your system

  • event-453-gfdf

event_type

Type of Event. Must be either "transaction" for monetary event or "action" for system change events.

  • transaction
  • action

event_subtype

Additional information about how your company classifies the event

  • ach
  • payment

event_time

Date and time the event happened, Date in seconds since 1 Jan 1970 00:00:00 UTC, i.e. in Unix time

  • 1632775046

status

Status of the event in your system

  • settled

tags

Additional information that can be used for grouping and filtering in "key:value" format

  • sector:Europe
  • source:UK_internal

transaction_data

Fields

Description

Example

sent_amount

The monetary value of the transaction, specified in terms of the currency set in the sent_currency field. This value must be positive (greater or equal to zero).

  • 117.95

sent_currency

The currency that the sender sent

  • USD

sender_entity_id

Identifier of the sender entity in your system. If sender_source="internal", this value should match a value of an entity already populate in the Unit21 system. If sender_source="external", this value does not need to match anything.

  • a-123-b-456-c-789

sender_source

Internal or External. Internal senders exist in your system. External are outside of your system.

  • internal
  • external

sender_entity_type

If sender_source="internal" then this value must match the entity_type of the entity already populated in the Unit21 system

  • user
  • business

sender_instrument_id

Identifier of the sender's transaction instrument in your system.

  • 111222333

received_amount

The monetary value of the transaction, specified in terms of the currency set in the received_currency field. This value must be positive (greater or equal to zero).

  • 234.56

received_currency

The currency that the receiver received

  • EUR

receiver_entity_id

Identifier of the receiver entity in your system. If sender_source="Internal", this value should match a value of an entity already populate in the Unit21 system. If sender_source="External", this value does not need to match anything.

  • bc-123-def-456

receiver_source

Internal or External. Internal senders exist in your system. External are outside of your system.

  • internal
  • external

receiver_entity_type

If receiver_source="Internal" then this value must match the entity_type of the entity already populated in the Unit21 system

  • user
  • business

receiver_instrument_id

Identifier of the receiver's transaction instrument in your system.

  • 444555666

amount

The normalized monetary value of the transaction in your system's home currency.

  • 123.45

exchange_rate

The exchange rate used for this transaction

  • 3.05

usd_conversion_notes

Information on the exchange rate used, e.g. what day it was it was pulled, from what source it was obtained

  • Bank rate from 9/14/21

internal_fee

The sum of all internal fees associated with the transaction, specified in USD. All other amount fields should not include the value of these fees.

  • 5.01

external_fee

The sum of all external fees associated with the transaction, specified in USD. All other amount fields should not include the value of these fees.

  • 3.07

location_data

Fields

Description

Example

type

A field indicating the type of location

  • Shipping
  • building

building_number

Building number of the location

  • 14

unit_number

Flat/apartment/suite number of the building

  • 4f

street_name

Street name of the location

  • Coora St

city

City of the location

  • San Jose

state

State or region for the location. For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard

  • CA

postal_code

Postal code of the location

  • 07710

country

Country of the location - use the ISO 3166-1 standard

  • US

digital_data

Field

Description

Example

ip_address

IP address. MUST be in either IPv4 or IPv6 format

  • 164.22.53.245

client_fingerprint

Fingerprints associated with this event

  • nkd90432k3jk2j3

custom_data

Field

Description

Example

custom_data

Any additional information that should be associated with this event in key:value format in json format

  • Commission: 100
  • High value:false

Did this page help you?