Batch transaction upload

Last updated: April 7, 2026

For a full understanding of the transaction model please start with our Transactions API documentation.

When you upload transactions in a batch to be evaluated by Transaction Monitoring in Mesh, you can include a wide variety of fields.

There are a minimum set of fields that must be present (marked as required below). Any data you send is stored securely in Mesh and returned via API and in the web app.

Having more data in one place not only provides a single view of your transactions but can increase the efficiency of your team as they don't need to navigate between many platforms to find what they need.

Managing customers

Transactions need to be attached to a customer record. For the fastest evaluation of transactions users should attach the transaction to a pre-existing customer. However, we also offer the ability for the user to update or create a customer at the time of transaction processing.

Full details of your options are on our API docs.

Restriction: each file uploaded to the batch uploader must contain only one of the following methods:

  1. The customer external ID is provided at the top level and the customer object is not provided. i.e. all transactions use existing customers with no in-line customer creation or update.

  2. The customer external ID is provided at the top level and the customer object is also provided. i.e. all transactions include customer details in the customer object to update existing customers or create new customers.

How to set up your file headings

  • Row 1 must contain the name of the fields.

    • All supported fields are listed below by customer type, you can exclude any that are not relevant to you.

  • Fields indicated below with [X] can take more than one value.

    • Each value must be entered in a new column where headers are differentiated by replacing [X] with [1], [2], [3] etc.

    • For example, for a person's nationality:

      • If there is only 1 nationality, the heading would be customer[1].person.nationality[1].

      • If there is a second nationality, it must be filled into a separate column with the heading customer[1].person.nationality[2].

  • Fields that are not required can be left blank, even if you include the headers in your file

You will need to provide the required fields from the Transaction and Customer sections for each transaction you are submitting.

There are csv and xslx template files available to download in the web application.

Supported attributes and descriptions

Transaction

Common

The following fields are required for all transaction types.

 

Accepted value(s) or format(s)

Required? (yes/no)

Description

Max length

Field added in

transaction.classification

MONETARY

yes

Classification of the transaction.

Currently we only support monetary transaction types.

 

 

transaction.type

BANK_PAYMENT

yes

The specific type of transaction this represents.

 

 

scenario_configuration_identifier

n/a

yes

The identifier for the scenario configuration you have set up in Mesh

 

 

transaction.external_identifier

n/a

yes

The identifier you assign each transaction to uniquely identify them

255

 

transaction.occurred_at.timestamp

ISO-8601

yes

The timestamp of the transaction. For a monetary transaction this could be the timestamp of the card swipe or the settlement date of the transaction.

 

 

transaction.occurred_at.timezone

IANA timezone

no

The IANA timezone in which the timestamp exists, for example "Europe/Andorra", "America/New_York", etc.

 

 

transaction.monetary_transaction.reference_text

 

no

The reference text supplied as part of the financial transaction.

255

 

transaction.monetary_transaction.product_name

 

no

 

255

 

transaction.monetary_transaction.value.amount

number

no

The amount of the financial transaction in the currency it occurred in.

 

 

transaction.monetary_transaction.value.currency

ISO 4217 currency code

no

The currency the financial transaction occurred in.

 

 

transaction.monetary_transaction.base_value.amount

number

yes

The amount of the financial transaction in the reference base currency.

 

 

transaction.monetary_transaction.base_value.currency

ISO 4217 currency code

no

The reference base currency for the account.

 

 

transaction.custom_field[X]

n/a

n/a

You can provide up to 10 custom fields per transaction. The fields should be repeated; with the number in the column name incremented for each custom field.

 

 

transaction.custom_field[1].key

 

 

The key of the custom field.

255

 

transaction.custom_field[1].string_value

 

 

You can provide one of string_value or decimal value.

String representation of the custom field value.

255

 

transaction.custom_field[1].decimal_value

 

 

You can provide one of string_value or decimal value.

Decimal representation of the custom field value.

 

 

transaction.regulatory_reporting.fincen_cash_transaction_subtype

DEPOSIT
PAYMENT
WITHDRAWAL
ADVANCE_ON_CREDIT
CURRENCY_EXCHANGE
CURRENCY_TRANSFER_IN
CURRENCY_TRANSFER_OUT
CURRENCY_TO_PREPAID_ACCESS
CURRENCY_FROM_PREPAID_ACCESS
CURRENCY_WAGER
NEGOTIABLE_INSTRUMENT_PURCHASE
NEGOTIABLE_INSTRUMENT_CASHED
GAMING_INSTRUMENT_PURCHASE
GAMING_INSTRUMENT_REDEMPTION
BILLS_INSERTED_INTO_GAMING_DEVICES
PAYMENT_ON_WAGER
PROMOTION_PAYMENT
TRAVEL_COMPLIMENTARY_EXPENSES
OTHER

no

The classification code used to identify the nature of a cash-in or cash-out event for BSA reporting purposes on Currency Transaction Report (Form 112).

 

 

transaction.regulatory_reporting.gto_type_codes[1]

 

no

The Geographic Targeting Order (GTO) specific alphanumeric identifier required by FinCEN to be entered in Field 45 of the Currency Transaction Report. (e.g., "MSB0326GTO").

 

 

Bank Payment

The following fields are required (along with the common fields) if the transaction is a bank payment.

 Accepted value(s) or format(s)Required? (yes/no)DescriptionMax lengthField added in

transaction.monetary_transaction.bank_payment.state

PENDING
BOOKED

no

The state of the payment.

 

 

transaction.monetary_transaction.bank_payment.payment_scheme

OTHER
SWIFT
SEPA
SEPA_INSTANT
FASTER_PAYMENTS
CHAPS
BACS
FEDNOW

no

The payment scheme that was used to initiate the payment.

 

 

transaction.monetary_transaction.payment_channel

OTHER
MOBILE
WEB
BRANCH
TELEPHONE
ATM

no

The payment channel used to initiate the payment.

 

 

transaction.monetary_transaction.customer_account_balance.amount

number

no

The account balance of the customer.

 

 

transaction.monetary_transaction.customer_account_balance.currency

ISO 4217 currency code

no

The currency of the account balance of the customer.

 

 

transaction.monetary_transaction.bank_payment.debtor.name

 

yes

The debtor's name.

255

 

transaction.monetary_transaction.bank_payment.debtor.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.postal_code

 

no

The town or city

50

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.town_name

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.country_subdivision

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.bank_payment.debtor.structured_address.type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.bank_payment.debtor.unstructured_address

n/a

 

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.debtor.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc. 

255

 

transaction.monetary_transaction.bank_payment.debtor.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.bank_payment.debtor.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.

A customer external identifier is required in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

255

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.name

 

no

The ultimate debtor's name.

255

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.structured_address.type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.unstructured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc. 

255

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.counterparty.external_identifier

 

no

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

255

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.

A customer external identifier is required in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

 

 

transaction.monetary_transaction.bank_payment.creditor.name

 

yes

The creditor's name.

255

 

transaction.monetary_transaction.bank_payment.creditor.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.bank_payment.creditor.structured_address.type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.bank_payment.creditor.unstructured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.creditor.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc. 

255

 

transaction.monetary_transaction.bank_payment.creditor.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.bank_payment.creditor.counterparty.external_identifier

 

no

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

255

 

transaction.monetary_transaction.bank_payment.ultimate_debtor.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.

A customer external identifier is required in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

255

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.name

 

no

The ultimate creditor's name.

255

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.structured_address.type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.unstructured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc. 

255

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.counterparty.external_identifier

 

no

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

255

 

transaction.monetary_transaction.bank_payment.ultimate_creditor.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.

A customer external identifier is required in one; and only one; of the following slots:

debtor
creditor
ultimate debtor
ultimate creditor

255

 

transaction.monetary_transaction.bank_payment.agents

n/a

n/a

You can provide details for up to 10 agents per transaction. Each agent’s fields (like role and name) should be repeated. 

The order of the agents is taken from the index field.

 

 

transaction.monetary_transaction.bank_payment.agents[X].index

number between 1 and 10

no

Indicates where this agent appeared in the original list of agents.

 

 

transaction.monetary_transaction.bank_payment.agents[X].role

INTERMEDIARY
COUNTERPARTY_BANK

no

The role the agent has within a financial transaction.

 

 

transaction.monetary_transaction.bank_payment.agents[X].reference_text

 

no

The reference text supplied by an agent.

255

 

transaction.monetary_transaction.bank_payment.agents[X].bank.name

 

no

The name of the bank. This can be the legal name, or a trading name, or a general name.

255

 

transaction.monetary_transaction.bank_payment.agents[X].bank.bic

BIC code

no

The 8-11 character BIC of the bank.

11

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.address_line_1

 

no

The first line of the address

50

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.bank_payment.agents[X].bank.legal_entity_address.type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

Card Payment

The following fields are required (along with the common fields) if the transaction is a card payment.

 

Accepted value(s) or format(s)

Required? (yes/no)

Description

Max length

Field added in

transaction.monetary_transaction.card_payment.card_payment_type

REGULAR
INSTALLMENT
RECURRING
MOTO
UNSCHEDULED
TOP_UP
REFUND
OTHER
AUTH_ONLY

no

Indicates the card payment type, representing the business purpose or nature of the transaction.

 

 

transaction.monetary_transaction.card_payment.payment_stage

AUTHORIZED
SETTLED
REVERSED
PARTIALLY_SETTLED
CHARGEBACK

no

Represents the different stages of a card payment lifecycle.
 

 

 

transaction.monetary_transaction.card_payment.card_payment_scope

DOMESTIC
CROSSBORDER

no

Indicates the geographical scope of the card payment transaction.

 

 

transaction.monetary_transaction.card_payment.card_scheme

VISA
MASTERCARD
AMERICAN_EXPRESS
JCB
UNIONPAY
DINERS_CLUB
MAESTRO
RUPAY
MIR

no

Card scheme/network that issued the card (e.g., Visa, Mastercard, American Express).

 

 

transaction.monetary_transaction.card_payment.related_transaction_identifier

 

no

The parent transaction related to the current transaction. This is applicable for when you want to link a refund operation to the original transaction.

100

 

transaction.monetary_transaction.card_payment.card

n/a

n/a

Represents a payment card with its key identifying attributes.

 

 

transaction.monetary_transaction.card_payment.card.funding_type

CREDIT
DEBIT
PREPAID
OTHER

no

Type of card funding (credit, debit, prepaid, unknown).

 

 

transaction.monetary_transaction.card_payment.card.fingerprint

 

yes

Unique fingerprint to identify the card across transactions. This is a hashed or tokenized representation that allows identification without exposing sensitive card details.

150

 

transaction.monetary_transaction.card_payment.card.wallet_identifier

 

no

Wallet identifier if the card is associated with a digital wallet. Optional field as not all cards are wallet-based.

50

 

transaction.monetary_transaction.card_payment.card.wallet_type

GOOGLE_PAY
APPLE_PAY
PAYPAL
REMOTE_COMMERCE_PROGRAMS
OTHER

no

Type of digital wallet used for this card transaction.

 

 

transaction.monetary_transaction.card_payment.card_verification_results

n/a

n/a

Represents card verification results including CVV, AVS, and identity checks.

 

 

transaction.monetary_transaction.card_payment.card_verification_results.avs_check.result

PASS
FAIL
UNAVAILABLE
UNCHECKED

no

Address Verification System (AVS) check result.

 

 

transaction.monetary_transaction.card_payment.card_verification_results.avs_check.description

 

no

Optional description providing additional details about the AVS check result.

200

 

transaction.monetary_transaction.card_payment.card_verification_results.cvc_check.result

PASS
FAIL
UNAVAILABLE
UNCHECKED

no

Card Verification Code (CVC) check result.

 

 

transaction.monetary_transaction.card_payment.card_verification_results.cvc_check.description

 

no

Optional description providing additional details about the CVC check result.

200

 

transaction.monetary_transaction.card_payment.card_verification_results.three_d_secure_check.result

PASS
FAIL
UNAVAILABLE
UNCHECKED

no

3D Secure authentication check result.

 

 

transaction.monetary_transaction.card_payment.card_verification_results.three_d_secure_check.description

 

no

Optional description providing additional details about the 3D Secure check result.

200

 

transaction.monetary_transaction.card_payment.card_holder

n/a

n/a

Card holder details including party identification and onboarding information.

 

 

transaction.monetary_transaction.card_payment.card_holder.details.name

 

no

The card holder's name.

255

 

transaction.monetary_transaction.card_payment.card_holder.details.counterparty.external_identifier

 

no

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

 

 

transaction.monetary_transaction.card_payment.card_holder.details.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.
A customer external identifier is required in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

255

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.card_payment.card_holder.details.structured_address.address_type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.card_payment.card_holder.details.unstructured_address

n/a

 

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.card_holder.details.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc.

255

 

transaction.monetary_transaction.card_payment.card_holder.details.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.card_payment.issuer

n/a

n/a

Represents details of a card issuer.

 

 

transaction.monetary_transaction.card_payment.issuer.bin

 

no

Bank Identification Number (BIN) - first 6-8 digits of the card number.

8

 

transaction.monetary_transaction.card_payment.issuer.details.name

 

no

The issuer's name.

255

 

transaction.monetary_transaction.card_payment.issuer.details.counterparty.external_identifier

 

 

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

 

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.card_payment.issuer.details.structured_address.address_type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.card_payment.issuer.details.unstructured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.issuer.details.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc.

255

 

transaction.monetary_transaction.card_payment.issuer.details.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.card_payment.acquirer

 

 

Represents details of a card acquirer including acquirer ID and identification information.

 

 

transaction.monetary_transaction.card_payment.acquirer.identifier

 

no

Unique identifier for the acquirer (assigned by card networks).

100

 

transaction.monetary_transaction.card_payment.acquirer.details.name

 

no

The acquirer's name.

255

 

transaction.monetary_transaction.card_payment.acquirer.details.counterparty.external_identifier

 

no

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

 

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.card_payment.acquirer.details.structured_address.address_type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.card_payment.acquirer.details.unstructured_address

n/a

 

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.acquirer.details.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc.

255

 

transaction.monetary_transaction.card_payment.acquirer.details.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.card_payment.merchant

n/a

n/a

Details of a principal merchant (e.g., Payment Facilitator).

 

 

transaction.monetary_transaction.card_payment.merchant.category_type

AGRICULTURAL_SERVICES
CONTRACTED_SERVICES
TRANSPORTATION_SERVICES
UTILITY_SERVICES
RETAIL_OUTLET_SERVICES
CLOTHING_SHOPS
MISCELLANEOUS_SHOPS
BUSINESS_SERVICES
PROFESSIONAL_SERVICES
GOVERNMENT_SERVICES

no

Category types for Merchant Category Codes based on industry code ranges.

 

 

transaction.monetary_transaction.card_payment.merchant.mcc_category_code

number

no

4-digit MCC code (e.g., 5812, 6012).

4

 

transaction.monetary_transaction.card_payment.merchant.mcc_code_description

 

no

Human-readable description of the MCC (e.g., "Grocery Stores, Supermarkets").

200

 

transaction.monetary_transaction.card_payment.merchant.details.name

 

no

The merchant's name.

255

 

transaction.monetary_transaction.card_payment.merchant.details.counterparty.external_identifier

 

no

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

100

 

transaction.monetary_transaction.card_payment.merchant.details.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.
A customer external identifier is required in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

255

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.card_payment.merchant.details.structured_address.address_type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.card_payment.merchant.details.unstructured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.merchant.details.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc.

255

 

transaction.monetary_transaction.card_payment.merchant.details.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.card_payment.sub_merchant

n/a

n/a

Details of the sub-merchant where the transaction originated. This field is optional as not all card payments involve sub-merchants.

 

 

transaction.monetary_transaction.card_payment.sub_merchant.category_type

AGRICULTURAL_SERVICES
CONTRACTED_SERVICES
TRANSPORTATION_SERVICES
UTILITY_SERVICES
RETAIL_OUTLET_SERVICES
CLOTHING_SHOPS
MISCELLANEOUS_SHOPS
BUSINESS_SERVICES
PROFESSIONAL_SERVICES
GOVERNMENT_SERVICES

no

Category types for Merchant Category Codes based on industry code ranges.

 

 

transaction.monetary_transaction.card_payment.sub_merchant.mcc_category_code

number

no

4-digit MCC code (e.g., 5812, 6012).

4

 

transaction.monetary_transaction.card_payment.sub_merchant.mcc_code_description

 

no

Human-readable description of the MCC (e.g., "Grocery Stores, Supermarkets").

200

 

transaction.monetary_transaction.card_payment.sub_merchant.details.name

 

no

The sub-merchant's name.

255

 

transaction.monetary_transaction.card_payment.sub_merchant.details.counterparty.external_identifier

 

 

You can optionally provide a counterparty external identifier in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

100

 

transaction.monetary_transaction.card_payment.sub_merchant.details.customer.external_identifier

 

yes

The identifier you assign each customer to uniquely identify them.
A customer external identifier is required in one; and only one; of the following slots:

card_holder
merchant
sub_merchant

255

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address

n/a

n/a

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.address_line1

 

no

The first line of the address

50

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.address_line2

 

no

The second line of the address

50

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.town_name

 

no

The town or city

50

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.country_subdivision

 

no

The zip code or postal code

50

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.postal_code

 

no

The country subdivision or state

50

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.country

ISO 3166-1 alpha-2

no

The address country

 

 

transaction.monetary_transaction.card_payment.sub_merchant.details.structured_address.address_type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

transaction.monetary_transaction.card_payment.sub_merchant.details.unstructured_address

n/a

 

You can provide one of structured_address or unstructured_address

 

 

transaction.monetary_transaction.card_payment.sub_merchant.details.unstructured_address.local_details

 

no

Unstructured local address information. This could be just a street number and name, a comma separated list of various local parts of an address such as a flat number, street and town etc.

255

 

transaction.monetary_transaction.card_payment.sub_merchant.details.unstructured_address.country

 

no

Unstructured country information, when available. This may be a country name, partial name, internal short code or a 2 or 3 character ISO code, etc.

255

 

transaction.monetary_transaction.card_payment.point_of_sale

n/a

 

Contextual information about the card payment environment.

 

 

transaction.monetary_transaction.card_payment.point_of_sale.condition.code

Must be exactly 2 digits

no

POS condition code with description indicating the specific conditions or environment under which the transaction took place at the point-of-sale.

2

 

transaction.monetary_transaction.card_payment.point_of_sale.condition.description

 

no

Human-readable description of the code.

200

 

transaction.monetary_transaction.card_payment.point_of_sale.entry_mode.code

 

no

Point of Service Entry Mode indicating how the cardholder's account number (PAN) was physically entered or captured at the point-of-sale terminal. This represents the technical method of card data input.

2

 

transaction.monetary_transaction.card_payment.point_of_sale.entry_mode.description

 

no

Human-readable description of the code.

200

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization

n/a

n/a

Authorization Information

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization.state

 

no

Current state of the authorization.

 

 

 

Accepted value(s) or format(s)

Required? (yes/no)

Description

Max length

Field added in

transaction.monetary_transaction.bank_payment.state

PENDING
BOOKED

no

The state of the payment.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization.response.reason_code

 

no

Reason code for the authorization response.

50

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization.identifier

 

no

Unique identifier for the authorization.

100

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization.value.amount

number

no

The amount of the authorization in the currency it occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization.value.currency

ISO 4217 currency code

no

The currency the authorization occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.authorization.type

PREAUTHORIZATION
AUTHORIZATION

no

Type of authorization for a card payment.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.settlement

n/a

n/a

Settlement information.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.settlement.timestamp

ISO 8601 date & time with offset

no

Timestamp when the settlement occurred.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.settlement.value.amount

number

no

The amount of the settlement in the currency it occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.settlement.value.currency

ISO 4217 currency code

no

The currency the settlement occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.reversal

n/a

n/a

Reversal information.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.reversal.timestamp

ISO 8601 date & time with offset

no

Timestamp when the reversal occurred.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.reversal.value.amount

number

no

The amount of the reversal in the currency it occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.reversal.value.currency

ISO 4217 currency code

no

The currency the reversal occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.reversal.identifier

 

no

Unique identifier for the reversal.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.refund

n/a

n/a

Refund information - although refunds are not part of the transaction, you can provide context of the refund here.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.refund.timestamp

ISO 8601 date & time with offset

no

Timestamp when the refund occurred.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.refund.reason.code

 

no

Reason code for the refund.

50

 

transaction.monetary_transaction.card_payment.payment_stages_info.refund.reason.description

 

no

Human-readable description of the code.

200

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback

n/a

n/a

 

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback.value.amount

number

no

The amount of the chargeback in the currency it occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback.value.currency

ISO 4217 currency code

no

The currency the chargeback occurred in.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback.timestamp

ISO 8601 date & time with offset

no

Timestamp when the chargeback occurred.

 

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback.reason

 

no

Reason classification of the chargeback.

50

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback.description

 

no

Description of the chargeback reason.

500

 

transaction.monetary_transaction.card_payment.payment_stages_info.chargeback.outcome

UNDEFENDED
PENDING
WON
LOST
WITHDRAW

no

The outcome of the chargeback.

 

 

 

Remittance Transaction

The following fields are required (along with the common fields) if the transaction is a remittance.

 

Column

Accepted value(s) or format(s)

Required? (yes/no)

Type

Notes

Max length

transaction.monetary_transaction.remittance.payment_scheme

SWIFT, SEPA, SEPA_INSTANT, FASTER_PAYMENTS, CHAPS, BACS, FEDNOW, OTHER

No

Enum

Payment scheme/network used to route the transaction

 

transaction.monetary_transaction.remittance.service_provider.type

 

No

Enum

Service provider facilitating the remittance transfer

 

transaction.monetary_transaction.remittance.service_provider.identifier

 

No

String

Service provider identifier

150

transaction.monetary_transaction.remittance.service_provider.name

 

No

String

Service provider name

150

Payment Methods

 

transaction.monetary_transaction.remittance.source_payment_method

REMITTANCE_PAYMENT_METHOD_UNSPECIFIED

REMITTANCE_PAYMENT_METHOD_CASH

REMITTANCE_PAYMENT_METHOD_CREDIT_CARD

REMITTANCE_PAYMENT_METHOD_DEBIT_CARD

REMITTANCE_PAYMENT_METHOD_BANK_TRANSFER

REMITTANCE_PAYMENT_METHOD_MOBILE_WALLET

REMITTANCE_PAYMENT_METHOD_PREPAID_CARD

REMITTANCE_PAYMENT_METHOD_CHEQUE

REMITTANCE_PAYMENT_METHOD_CRYPTOCURRENCY

REMITTANCE_PAYMENT_METHOD_GIFT_CARD

REMITTANCE_PAYMENT_METHOD_POSTAL_ORDER

REMITTANCE_PAYMENT_METHOD_BARTER

REMITTANCE_PAYMENT_METHOD_OTHER

No

Enum

Payment method used by sender to initiate remittance

 

transaction.monetary_transaction.remittance.collection_method

REMITTANCE_PAYMENT_METHOD_UNSPECIFIED

REMITTANCE_PAYMENT_METHOD_CASH

REMITTANCE_PAYMENT_METHOD_CREDIT_CARD

REMITTANCE_PAYMENT_METHOD_DEBIT_CARD

REMITTANCE_PAYMENT_METHOD_BANK_TRANSFER

REMITTANCE_PAYMENT_METHOD_MOBILE_WALLET

REMITTANCE_PAYMENT_METHOD_PREPAID_CARD

REMITTANCE_PAYMENT_METHOD_CHEQUE

REMITTANCE_PAYMENT_METHOD_CRYPTOCURRENCY

REMITTANCE_PAYMENT_METHOD_GIFT_CARD

REMITTANCE_PAYMENT_METHOD_POSTAL_ORDER

REMITTANCE_PAYMENT_METHOD_BARTER

REMITTANCE_PAYMENT_METHOD_OTHER

No

Enum

Method by which recipient will collect remittance

 

Remittance Transaction Context

 

transaction.monetary_transaction.remittance.relationship

SPOUSE, FAMILY, FRIEND, BUSINESS_PARTNER, EMPLOYEE, OTHER

No

Enum

Relationship between sender and recipient

 

transaction.monetary_transaction.remittance.purpose_of_payment

REMITTANCE_PURPOSE_UNSPECIFIED

REMITTANCE_PURPOSE_FAMILY_SUPPORT

REMITTANCE_PURPOSE_EDUCATION

REMITTANCE_PURPOSE_MEDICAL

REMITTANCE_PURPOSE_BUSINESS

REMITTANCE_PURPOSE_PROPERTY

REMITTANCE_PURPOSE_EMERGENCY

REMITTANCE_PURPOSE_SAVINGS

REMITTANCE_PURPOSE_GIFT

REMITTANCE_PURPOSE_TRAVEL

REMITTANCE_PURPOSE_DEBT_REPAYMENT

REMITTANCE_PURPOSE_PURCHASE

REMITTANCE_PURPOSE_SALARY

REMITTANCE_PURPOSE_RENT

REMITTANCE_PURPOSE_OTHER

No

Enum

Purpose or reason for the remittance transfer

 

transaction.monetary_transaction.remittance.source_of_funds

REMITTANCE_SOURCE_OF_FUNDS_UNSPECIFIED

REMITTANCE_SOURCE_OF_FUNDS_SALARY

REMITTANCE_SOURCE_OF_FUNDS_BUSINESS_INCOME

REMITTANCE_SOURCE_OF_FUNDS_SAVINGS

REMITTANCE_SOURCE_OF_FUNDS_INVESTMENTS

REMITTANCE_SOURCE_OF_FUNDS_PENSION

REMITTANCE_SOURCE_OF_FUNDS_LOAN

REMITTANCE_SOURCE_OF_FUNDS_GIFT

REMITTANCE_SOURCE_OF_FUNDS_INHERITANCE

REMITTANCE_SOURCE_OF_FUNDS_ASSET_SALE

REMITTANCE_SOURCE_OF_FUNDS_INSURANCE_PAYOUT

REMITTANCE_SOURCE_OF_FUNDS_GOVERNMENT_BENEFITS

REMITTANCE_SOURCE_OF_FUNDS_TRUST_DISTRIBUTION

REMITTANCE_SOURCE_OF_FUNDS_CRYPTO_LIQUIDATION

REMITTANCE_SOURCE_OF_FUNDS_CROWDFUNDING

REMITTANCE_SOURCE_OF_FUNDS_GAMBLING_WINNINGS

REMITTANCE_SOURCE_OF_FUNDS_OTHER

No

Enum

Information about where the money originated

 

Cash Pickup Details

 

transaction.monetary_transaction.remittance.creditor.cash_pickup.location_identifier

 

No

String

Unique identifier for pickup location

100

transaction.monetary_transaction.remittance.creditor.cash_pickup.country

ISO 3166-1 alpha-2

No

String

Country of pickup location

 

transaction.monetary_transaction.remittance.creditor.cash_pickup.agent_network

 

No

String

Agent network facilitating pickup

Western Union, MoneyGram agent Western Union, MoneyGram agent

100

Agent Information

 

transaction.monetary_transaction.remittance.agents[1].role

AGENT_ROLE_UNSPECIFIED

AGENT_ROLE_INTERMEDIARY

AGENT_ROLE_COUNTERPARTY_BANK

AGENT_ROLE_DEBTOR_AGENT

AGENT_ROLE_CREDITOR_AGENT

No

Enum

The role the agent has within a financial transaction

 

transaction.monetary_transaction.remittance.agents[1].reference_text

 

No

Text

The reference text supplied by an agent

255

transaction.monetary_transaction.remittance.agents[1].index

No

Integer

Index in which the agent came in the original list

 

transaction.monetary_transaction.remittance.agents[1].bank.bic

No

String

 

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address

Address fields: address_line_1, address_line_2, post_code, town_name, country_subdivision, country, address_type

No

Object

The address has similar fields as the address in the PartyIdentification model

 

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.address_line1

 

no

String

The first line of the address

50

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.address_line2

 

no

String

The second line of the address

50

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.postal_code

 

no

String

The town or city

50

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.town_name

 

no

String

The zip code or postal code

50

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.country_subdivision

 

no

String

The country subdivision or state

50

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.country

ISO 3166-1 alpha-2

no

String

The address country

 

transaction.monetary_transaction.remittance.agents[1].bank.legal_entity_address.address_type

RESIDENTIAL

MAILING

OPERATING

REGISTRATION

BILLING

No

Enum

The address type

 

transaction.monetary_transaction.remittance.agents[1].money_transfer_operator.name

 

No

Text

Money Transfer Operator name

255

transaction.monetary_transaction.remittance.agents[1].money_transfer_operator.identifier

 

No

Text

Money Transfer Operator identifier

255

transaction.monetary_transaction.remittance.agents[1].online_remittance_platform.name

 

No

Text

Online Remittance Platform name

255

transaction.monetary_transaction.remittance.agents[1].online_remittance_platform.identifier

 

No

Text

Online Remittance Platform identifier

255

 

Customer

The common fields must be submitted on all transactions. At present, you are limited to providing one customer only.

If your customer already exists in Mesh, you just need to provide the external_identifier from the common fields.

If the customer does not exist in Mesh, or you want to update them, you will need to provide the common fields, plus the fields from one of person or company.

Common

 

Accepted value(s) or format(s)

Required? (yes/no)

Description

Max length

Field added in

customer[1].external_identifier

n/a

yes

The identifier you assign each customer to uniquely identify them

255

 

customer[1].acquisition_source

n/a

no

The acquisition source of a customer

255

 

customer[1].customer_since.day

number between 1 and 31

no

The day of customer acquisition

 

 

customer[1].customer_since.month

number between 1 and 12

no

The month of customer acquisition

 

 

customer[1].customer_since.year

number

no

The year of customer acquisition

 

 

Person

If your customer is a person, you also need to provide the following fields.

 

Accepted value(s) or format(s)

Required? (yes/no)

Description

Max length

Field added in

customer[1].person.title

n/a

no

The person's title

50

 

customer[1].person.full_name

n/a

yes
(if last_name is not present)

The person's full name, if any other name fields are populated this field should be null

255

 

customer[1].person.first_name

n/a

no

The person's first name

50

 

customer[1].person.middle_name

n/a

no

The person's middle name

50

 

customer[1].person.last_name

n/a

yes
(if full_name is not present)

The person's last name

50

 

customer[1].person.suffix

n/a

no

The person's suffix

50

 

customer[1].person.mothers_name

n/a

no

The last name of the person's mother

50

 

customer[1].person.fathers_name

n/a

no

The last name of the person's father

50

 

customer[1].person.date_of_birth.day

number between 1 and 31

no

The day of birth

 

 

customer[1].person.date_of_birth.month

number between 1 and 12

no

The month of birth

 

 

customer[1].person.date_of_birth.year

number

no

The year of birth

 

 

customer[1].person.gender

MALE
FEMALE
OTHER

no

The person's gender

 

 

customer[1].person.nationality[X]

iso-3166-alpha-2

no

The person's nationality

 

 

customer.person.country_of_birth

iso-3166-alpha-2

no

The person's country of birth

 

 

customer[1].person.residential_information[X].country_of_residence

iso-3166-alpha-2

no

The person's country of residence or citizenship

 

 

customer[1].person.residential_information[X].residential_status

RESIDENT
PERMANENT_RESIDENT
NON_RESIDENT

no

The residential status the person holds for that country of residence

 

 

customer[1].person.address[X].type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

customer[1].person.address[X].address_line1

n/a

no

The first line of the address

50

 

customer[1].person.address[X].address_line2

n/a

no

The second line of the address

50

 

customer[1].person.address[X].town_name

n/a

no

The town or city

50

 

customer[1].person.address[X].postal_code

n/a

no

The zip code or postal code

50

 

customer[1].person.address[X].country_subdivision

n/a

no

The country subdivision or state

50

 

customer[1].person.address[X].country

iso-3166-alpha-2

no

The address country

 

 

customer[1].person.contact_information.email_address[X]

n/a

no

The customer's email address

 

 

customer[1].person.contact_information.fax_number[X]

Must start with a '+' followed by the country code and then the rest of the number

no

The customer's fax number

 

 

customer[1].person.contact_information.phone_number[X]

Must start with a '+' followed by the country code and then the rest of the number

no

The customer's phone number

 

 

customer[1].person.contact_information.url[X]

RFC-2369 (like http://www.complyadvantage.com

no

The customer's URL

 

 

customer[1].person.personal_identification[X].type

SOCIAL_SECURITY_NUMBER
DRIVING_LICENCE
PASSPORT
IDENTITY_CARD
TAX_REGISTRATION
ALIEN_IDENTIFICATION
EMPLOYER_IDENTIFICATION
OTHER

no

The type of identity document

 

 

customer[1].person.personal_identification[X].document_identifier

n/a

no

The identity document's official number or identifier

 

 

customer[1].person.personal_identification[X].issuing_country

iso-3166-alpha-2

no

The country that issued the identity document

 

 

customer[1].person.personal_identification[X].date_of_issue.day

number between 1 and 31

no

The day the document was issued

 

 

customer[1].person.personal_identification[X].date_of_issue.month

number between 1 and 12

no

The month the document was issued

 

 

customer[1].person.personal_identification[X].date_of_issue.year

number

no

The year the document was issued

 

 

customer[1].person.personal_identification[X].date_of_expiry.day

number between 1 and 31

no

The day the document expires

 

 

customer[1].person.personal_identification[X].date_of_expiry.month

number between 1 and 12

no

The month the document expires

 

 

customer[1].person.personal_identification[X].date_of_expiry.year

number

no

The year the document was expires

 

 

customer[1].person.profession[X]

n/a

no

The person's profession or occupation

 

 

customer[1].person.source_of_wealth

n/a

no

The person's source of wealth

 

 

customer[1].person.salary.amount.high

number

no

The upper limit for the person's annual salary

 

 

customer[1].person.salary.amount.low

number

no

The lower limit for the person's annual salary

 

 

customer[1].person.salary.currency

iso-4217

no

The currency of the person's salary

 

 

customer[1].person.industry

n/a

no

The person's profession or occupation industry

50

 

customer[1].person.net_worth.amount

number

no

The person's net worth amount

 

 

customer[1].person.net_worth.currency

iso-4217

no

The person's net worth amount currency

 

 

customer[1].person.source_of_income

n/a

no

The person's source of income

50

 

Company

If your customer is a company, you also need to provide the following fields.

Field

Accepted value(s) or format(s)

Required? (yes/no)

Description

Max length

Field added in

customer.company.legal_name

n/a

yes

The company's legal name

255

 

customer.company.alias[X]

n/a

no

Any aliases for the company, including trading names and "doing business as"

50

 

customer.company.industry

n/a

no

The industry the company operates in

50

 

customer.company.source_of_income

n/a

no

The source of income of the company

 

 

customer.company.company_type

n/a

no

The official company legal type

50

 

customer.company.incorporation_date.day

number between 1 and 31

no

The day the company was incorporated

50

 

customer.company.incorporation_date.month

number between 1 and 12

no

The month of the company was incorporated

 

 

customer.company.incorporation_date.year

number

no

The year of the company was incorporated

 

 

customer.company.place_of_registration

iso-3166, iso3166-2

no

The country or state where the company is registered

6

 

customer.company.registration_authority_identification

n/a

no

The official identification number for the company, as it appears on the registry

50

 

customer.company.status_summary

UNKNOWN
ACTIVE
INACTIVE

no

The official status for the company, as it appears on the registry

 

 

customer.company.address[X].type

RESIDENTIAL
MAILING
OPERATING
REGISTRATION
BILLING

no

The address type

 

 

customer.company.address[X].address_line1

n/a

no

The first line of the address

50

 

customer.company.address[X].address_line2

n/a

no

The second line of the address

50

 

customer.company.address[X].town_name

n/a

no

The town or city

50

 

customer.company.address[X].postal_code

n/a

no

The zip code or postal code

50

 

customer.company.address[X].country_subdivision

n/a

no

The country subdivision or state

50

 

customer.company.address[X].country

iso-3166-alpha-2

no

The address country