No momento, esta página não está disponível em português
Developer-resource icon

Import data into referral lists

You can import referral data into the plataforma de pagamentos da Adyen to be placed on several referral lists used for fraud checks.

This bulk import of referral data is different from uploading items to a block or trust list using a CSV file in the Customer Area.

The CSV file that contains the referral data for the bulk import must be encrypted, and uploading the file requires our Support Team.

Input file format

  1. Create a file in CSV (Comma Separated Values) format as per RFC 4180. These are the requirements:

    • Prefix each line with a supported fixed value field, either the payment method or the type of referral list. See the different types of referrals on this page for the details.
    • Each line contains the fields for a single referral item. In other words: each referral is on a separate line.
    • Multi-line fields are not allowed. You can use a variable number of fields per line.
    • A header is not allowed.
    • The maximum number of lines per file is 100.000 (if file size permits).
  2. Save the file in UTF-8 format (to support non-western characters).

  3. Encrypt the file using the PGP public key provided to you by either our Support Team, or your Adyen contact.

    For more information, see our PGP encryption documentation.

  4. Send the file to Adyen.

Card

For card referrals the following columns are required:

Field Required Description
Fixed value: card -white_check_mark- Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
cardNumber -white_check_mark- The card number.
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

SEPA

For SEPA referral data the following columns are required:

Field Required Description
Fixed value: sepa -white_check_mark- Record type identifier.
iban -white_check_mark- IBAN of the bank account.
merchantAccountCode -white_check_mark- The merchant account name.
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Shopper name

For shopper name the following columns are required:

Field Required Description
Fixed value: shopperName -white_check_mark- Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
shopperName -white_check_mark- Name of the shopper.
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Shopper email

For shopper email referrals the following columns are required:

Field Required Description
Fixed value: shopperEmail -white_check_mark- Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
shopperEmail -white_check_mark- The shopper's email address.
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Shopper IP

For shopper IP referrals the following columns are required:

Field Required Description
Fixed value: shopperIp -white_check_mark- Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
shopperIP -white_check_mark- The IP address the shopper used to carry out the transaction.
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Shopper reference

For shopper reference referrals the following columns are required:

Field Required Description
Fixed value: shopperReference -white_check_mark- Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
shopperReference -white_check_mark- A shopper's reference, which is the unique identifier for a shopper.
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Shopper address

For shopper address referrals the following columns are required:

Field Required Description
Fixed value: shopperAddress -white_check_mark-  Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
street -white_check_mark- Street name.
houseNumberOrName -white_check_mark- House number or name.
city -white_check_mark- Name of the city
postalCode -white_check_mark- Postal code.
stateOrProvince -white_check_mark- State or province name.
countryCode -white_check_mark- Country code
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Shopper phone number

For shopper phone number referrals the following columns are required:

Field Required Description
Fixed value: shopperPhoneNumber -white_check_mark- Record type identifier.
merchantAccountCode -white_check_mark- The merchant account name.
phoneNumber -white_check_mark- The phone number
description -white_check_mark- A description of the item, for example a transaction ID of the original transaction.
flag -white_check_mark- You can perform the following actions:
  • trust
  • block
  • delete

Example file

The following is an example file with several lines of referral data:

card,YourMerchantOrCompanyAccount,4111111111111111,"Example description",block
shopperName,YourMerchantOrCompanyAccount,"S. Hopper","Example description",trust
shopperEmail,YourMerchantOrCompanyAccount,s.hopper@example.com,"Example description",trust
shopperIp,YourMerchantOrCompanyAccount,8.8.8.8,"Example description",block
shopperReference,YourMerchantOrCompanyAccount,YourMerchantReference,"Example description",delete
shopperAddress,YourMerchantOrCompanyAccount,StreetName,58,Amsterdam,2116 E,AMS,NL,"Example description",trust
shopperPhoneNumber,YourMerchantOrCompanyAccount,0123456789,"Example description",block