/v3/applications

Prev Next
Post
/v3/applications
Body parameters

HMAC Operation - application_create

object
merchant
string

Master Merchant token

Min length32
Max length36
Examplefaf5ee1a-298e-45c7-beb6-b8e410493da3
products
Array of string
Min length1
Max length5
Default[]
Example[ "pos", "e-commerce", "qr", "account-opening", "card-issuing" ]
string
Valid values[ "pos", "e-commerce", "qr", "account-opening", "card-issuing" ]
dueDiligence
string
Valid values[ "SDD", "CDD" ]
company

Company Details

OneOf
CompanyDto3
object (CompanyDto3)
tradeName
string | null

Doing business as

ExamplePaynetics
legalName
string | null

Legal name as appears in trade reigster

ExamplePaynetics AD
uic
string | null

Business Registration Number

Example123567
incorporationDate
string (date-time) | null

Date of the company incorporation

Example2022-01-01T00:00:00Z
website
string | null

URL of the website

Examplehttps://paynetics.digital
phone
string | null

Phone of the company

Example+35900000000
mobilePhone
string | null

Mobile phone of the company

Example+35900000000
country
string | null

Country of the company. Format: ISO 3166-1 alpha-2

Min length2
Max length2
ExampleBG
county
string | null

Country region of the company

ExampleSofia Grad
city
string | null

City where company is registerd

ExampleSofia
zip
string | null

Postal/ZIP Code

Example1407
address1
string | null

Address of the company

ExampleJames Bouchier 76A
address2
string | null

Additional details for the address

ExampleFloor 2
contactEmail
string | null

Correspondence email address

Examplejohn.doe@paynetics.digital
correspondenceAddress
string | null

Correspondence phisical address

ExampleJames Bouchier 76A
descriptionOfActivity
string | null

Description of the business activity of the company

ExampleAcquiring, Issuing etc.
addressOfShop
string | null

Address of the phisical shop/office of the company

ExampleJames Bouchier 76A
mcc
string | null

Filed is deprected and must be omitted

Min length4
Max length4
Example5999
legalForm
string | null

Legal form of the company

Valid values[ "sole-trader", "limited-company", "limited-partnership", "limited-liability-partnership", "other", "self-employed" ]
Examplesole-trader
legalFormDescription
string | null

Required when legal_form is specified as other

ExampleThe sutrcte of the company is ...
businessActivity
string | null

More details in nomernclutres section

Examplesecond-hand-store
countryOfIncorporation
string | null

ISO 3166-1 alpha-2

ExampleBG
vatRegistration
string | null

VAT registration number of the company

Example12345678BG
isSie
boolean | null

In case the company appears in any sanctions list the field must be marked as true

Examplefalse
companyMembers
Array of object (CompanyMemberDto) | null
Min items1
Default[]
object
firstName
string | null

First name of the member

ExampleJohn
lastName
string | null

Last name of the member

ExampleDoe
mobilePhone
string | null

Mobile phone of the member

Example+359000000000
phone
string | null

Phone of the member

Example+359000000000
legalName
string | null

Used when member is other legal entity

ExamplePaynetics AD
uic
string | null

Business registration number.Used when member is other legal entity

Example123456
country
string | null

Country of birth or country of legal entity.ISO 3166-1 alpha-2

ExampleBG
countryOfResidence
string | null

ISO 3166-1 alpha-2

ExampleBG
zip
string | null

Postal/Zip code of the member.

Example1407
city
string | null

City of the member.

ExampleSofia
address1
string | null

Address of the member.

ExampleJames Bouchier 76A
address2
string | null

Additional info for the address

ExampleFloor 2
county
string | null

Region of the member

ExampleSofia Grad
ownership
boolean | null

Only for UBO to specify the percentage of the ownership

Exampletrue
ownershipPercentage
integer | null

Only for UBO to specify the percentage of the ownership

Example10
type
Array of string
Min length1
Max length2
Example[ "ubo", "ceo", "representative", "proxy", "legal-entity", "officer" ]
string
Valid values[ "ubo", "ceo", "representative", "proxy", "legal-entity", "officer" ]
uniqueIdentifier
string | null

Unique number of persons on offical document.

Example123456
user
string | null

Existing user in Paynetics system to get KYC details

Example
legalForm
string | null

Legal form of the company

Examplesole-trader
placeOfBirth
string | null

ISO 3166-1 alpha-2

ExampleBG
pepDeclaration
boolean | null

Mark as PEP

Exampletrue
pepRelatedDeclaration
boolean | null

Mark as PEP relative

Exampletrue
isSip
boolean | null

Mark as that appears in sanction lists

Exampletrue
birthday
string (date-time) | null

Date of birth

Example1992-03-28T00:00:00Z
nationality
string | null

ISO 3166-1 alpha-2

ExampleBG
contactEmail
string | null
ExampleJohn Doe
documents
Array of object (DocumentDto) | null
object
file
string | null

Base64 encoded file

ExampleiVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3/HwADvgI9/iYBsgAAAABJRU5ErkJggg==
fileType
string | null

Type of the file

Valid values[ "pdf", "docx", "xlxs", "jpg", "jpeg", "png", "mov", "mp4" ]
Examplepdf
documentType
string | null

More details in nomenclatures section

Valid values[ "idcard", "bankstmt", "bill", "other", "idcard-front", "idcard-back", "idcard-selfie", "passport-back", "passport-selfie", "passport", "driving-license-selfie", "selfie", "driving-license-front", "driving-license-back", "sharebook-excerpt", "management-contract", "moms-of-the-board", "activity-license", "bank-account", "bulstat-registration", "vat-registration", "patent-law", "power-of-attorney", "ubo-declaration", "frame-contract", "sample-of-signatures", "face-compare", "proof", "recent-excerpt", "incorporation-documents", "share_holders_list", "other_corporate", "signature", "id_card_passport_photo", "biometric-residence-permit-front", "biometric-residence-permit-back", "kyc-vendor-report", "fatca-declaration", "sow-declaration", "sof-desclaration", "resident-permit-eu-uk-front", "resident-permit-eu-uk-back" ]
Examplepassport
documents
Array of object (DocumentDto) | null
object
file
string | null

Base64 encoded file

ExampleiVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3/HwADvgI9/iYBsgAAAABJRU5ErkJggg==
fileType
string | null

Type of the file

Valid values[ "pdf", "docx", "xlxs", "jpg", "jpeg", "png", "mov", "mp4" ]
Examplepdf
documentType
string | null

More details in nomenclatures section

Valid values[ "idcard", "bankstmt", "bill", "other", "idcard-front", "idcard-back", "idcard-selfie", "passport-back", "passport-selfie", "passport", "driving-license-selfie", "selfie", "driving-license-front", "driving-license-back", "sharebook-excerpt", "management-contract", "moms-of-the-board", "activity-license", "bank-account", "bulstat-registration", "vat-registration", "patent-law", "power-of-attorney", "ubo-declaration", "frame-contract", "sample-of-signatures", "face-compare", "proof", "recent-excerpt", "incorporation-documents", "share_holders_list", "other_corporate", "signature", "id_card_passport_photo", "biometric-residence-permit-front", "biometric-residence-permit-back", "kyc-vendor-report", "fatca-declaration", "sow-declaration", "sof-desclaration", "resident-permit-eu-uk-front", "resident-permit-eu-uk-back" ]
Examplepassport
acquiring

Details for e-commerce/pos products

OneOf
AcquiringDetailsDto
object (AcquiringDetailsDto)
pos

Details for pos product

OneOf
AcquiringDto
object (AcquiringDto)
feeGroup
string | null

Predifined fee group provided by Paynetics in advance

Exampledefault
projectedMonthlyValue
number (float) | null

In EUR

Example100
descriptor
string | null

Card Acceptor Name

ExampleJohn Doe
ecommerce

Details for e-commerce product

OneOf
EcommerceDto
object (EcommerceDto)
register3ds
boolean | null
supportedAuthorizationTypes
Array of string
Default[]
Example[ "moto", "recurring", "pay-by-link", "oct" ]
string
Valid values[ "moto", "recurring", "pay-by-link", "oct" ]
feeGroup
string | null
projectedMonthlyValue
number (float) | null
descriptor
string | null
payoutDetails
Array of object (PayoutDetailsDto) | null
Default[]
object
amount
number (float) | null

Minimum amount for payout

Example1
currency
string | null

ISO 4217 alpha 3

ExampleBGN
iban
string | null

Valid IBAN to which the funds will be send

ExampleBG18RZBB91550123456789
sortCode
string | null

Valid UK sort code

Min length6
Max length6
Example123456
accountNumber
string | null

UK Account number

Min length8
Max length8
Example12345678
period
string | null

When the payout must be done

Exampledaily
delay
string | null

Payout delay in days

Example2
questionnaire

Futher questions for the company

OneOf
QuestionnaireDto
object (QuestionnaireDto)
isOnline
boolean | null

Must be mark as true when customer is doing business online

Examplefalse
hasOffshoreClients
boolean | null

Must be mark as true when customer has client from off shore zone

Examplefalse
makeBusinessWithSan
boolean | null

Must be mark as true when customer is doing business with legal entities/natural persions in sanction lists

Examplefalse
hasKycProcedure
boolean | null

Must be mark as true when customer has KYC procedure for their customers

Examplefalse
hasKycProcedureDescription
string | null

The KYC procedure must be specified.

Examplefalse
requireAdditionalLicenses
boolean | null

Must be mark as true when customer must provide addtional license

Examplefalse
maintainsAccountsOnBehalfOfClients
boolean | null

Must be mark as true when customer maiting other legal entities or naturual persons bank accounts

Examplefalse
performTransactionsOnBehalfOfClients
boolean | null

Must be mark as true when customer is performing transaction onbehalf of other egal entities or naturual persons

Examplefalse
isOffShore
boolean | null

Must be mark as true when customer is from offshore zone

Examplefalse
purposeOfUsage
string | null

Must specify how the requested product will be used

Examplefalse
sourceOfFunds
string

Source of funds of the company

Valid values[ "dividends", "donation", "funds_from_other_auxiliary_sources", "inheritance", "loan_from_financial_institutions", "loan_from_third_parties", "ordinary_business_activity", "origin_of_funds_unknown", "other", "rent", "sale_of_company_shares_or_business", "sale_of_movable_assets", "sale_of_real_estate" ]
Exampledividends
monthsOfDoingBusiness
integer | null

For how long the company is oprerational

Example12
projectedMonthlyVolume
number (float) | null

Projected volume in EUR the company will make each month

Example10000.0
ipAddress
string | null

IP Address of customer submitted application

Example127.0.0.1
fingerprint
string | null

Device fingerprint of the customer submitted application

Exampleany string
Responses
200

Success

Expand All
object
code
integer | null
Default0
Example0
data
OneOf
ApplicationResponseDto
object (ApplicationResponseDto)
token
string | null

UUID of the application

Examplee3dcc1ee-26d4-40bb-ac24-c961a1c4f77c
company
OneOf
CompanyResponseDto
object (CompanyResponseDto)
token
string | null

UUID of the company

Example16880d2c-6616-4e16-947a-f5e1726604d7
companyMembers
Array of object (CompanyMemberResponseDto) | null
object
token
string | null

UUID of company member

Example7de3abb0-73e1-4d6a-bf72-1a2040685ff3
firstName
string | null

Name of company member

ExampleJohn
lastName
string | null

Name of company member

ExampleDoe