Top Level Credit Check Tags

Our easy and powerful Elavon Credit Check service assesses and validates a large range of data. A successful Credit Check returns a Credit Token that is required before boarding can take place. Importantly, data must pass unchanged from the Credit Check to Boarding services, or an error is returned.

Top Level Keys

The EU region eBoarding API creditCheck top-level data keys (names) and arrays are described in the following table. The table is a guide. Always refer to the API Reference.

Note: keys that apply only to North American regions are annotated with "NA" in the API Reference.

Top-Level Keys and Arrays (EU)

Key or Array

Description

Criterion

Notes

additionalStakeholders

This array captures information about additional shareholders important for the purpose of a credit check when the principal is not the sole owner of the company.

This information must be collected for each shareholder with a 25% or greater interest in the business.

An array or group of data key-value pairs.

The data requirements are listed on the Credit Check Flow - additionalStakeholders page.

authenticatePricingProgram

Authenticate Pricing Program, also called APP, to be provided to partners.

Required

Provided by Elavon

bankAccounts

This array captures the related business bank account information required for boarding.

Optionally, you can add additional billing and chargeback accounts using the data format used for DEPOSIT bank account types.

An array or group of data key-value pairs.

The data requirements are listed on the Credit Check Flow - bankAccounts page.

 

Note: In the EU region, DEPOSIT is the only valid bank account type.

bankerId

Identifier of banker responsible for submission

 

 

bankerPartnerId

Identifier of banker partner responsible for submission

 

 

branchCode

Bank branch code associated with application submission.

   

branchNumber

Bank branch number associated with application submission.

   

businessInfo

The businessInfo array streamlines and informs the application approval and compliance process. It captures key information including:

  • Legality

  • Function

  • Products

  • Ownership

  • Longevity

An array or group of data key-value pairs.

The data requirements are listed on the Credit Check Flow - businessInfo page.

cardPricing

cardPricing is a top-level array containing an instance each of cardCharges (with one or more cardCharge objects) and exceptionCharges (with one or more exceptionCharge objects).

An array or group of data key-value pairs.

The data requirements are listed on the Credit Check Flow - cardPricing page.

clientId

Identifies the client sending the application

Required

Assigned by Elavon

country

The country of jurisdiction for the partner

Required

Use ISO 3166-1 alpha-3 standard (3 letter country code)

elavonContract

Determines which contractual documentation is to be distributed and signed.

  Choose options from the elavonContract list.

employeeNumber

Identifies an individual employee.

   

financialInfo

This array gathers financial information related to the merchant’s business including how payments are processed and what affects the process

An array or group of data key-value pairs.

The data requirements are listed on the Credit Check Flow - financialInfo page.

internalUseInfo

Enclosing object for downstream components.

   

monetaryPricingProgram

Monetary Pricing Program, also called MPP/NPP.

Required

Provided by Elavon

parentEntity

The entity that is the parent to the submission, forms a pair with the client group.

Required

Provided by Elavon

principal

The Principal array records details of the individual responsible for card processing services on behalf of the merchant’s business.

An array or group of data key-value pairs.

The data requirements are listed on the Credit Check Flow - principal page.

promotionalCode

A discount or promotional code.

   

repReferralNumber

Identifies and individual representative.

   

salesRepCode

Identifies the sales representative responsible for the submission.

Required

Assigned by Elavon under the Partner organization.

uniqueId

Unique identifier per application, provided by the client. It is unique and never repeated for new applications. The uniqueId is provided to the credit check server. Each credit check response is tied to the uniqueId. 

  • Required

  • Max characters: 32

Every application must have an ID to prevent duplicates.

 

As an example, you could use [Partner Name][Millisecond Timestamp] to form “Acme1572566399123”.

 

 

❮ Back to Credit Check Flow   Next:  principal ❯