/api/v1/application

post https://cat-webfarm.1dc.com/boarding-ui-cat/external-api/api/v1/application

This endpoint allows you create a new full application to be boarded

Responses

Response body

object

main

object

required

applicationId

integer

required

Application identification. Return on the API after the first save.

applicationStatus

string

IN_PROGRESS - The application has an ID generated. Some information is saved, but not been applied yet
CANCELED - This application has been canceled by the user
REJECTED - Rejected during user review.
APPROVED - Approved during review.
FAIL_PROCESSED - Has been processed, but has failed
SUCCESSFUL_PROCESSED - Has been successfully processed
BOARDING_PROCESS - Started bording Process
UNDER_REVIEW - Under review
Declined - The application has been declined. This means it cannot be further processed. The user should not attempt any additional actions on this application, as it must be terminated.
QUEUED - The application has been succesfully queued for processing. Please wait for further updates on the application status.

IN_PROGRESS CANCELED REJECTED APPROVED FAIL_PROCESSED SUCCESSFUL_PROCESSED BOARDING_PROCESS UNDER_REVIEW DECLINED QUEUED

creationUser

string

hierarchy

object

required

Hierarchy data

requiredDetails

object

required

optionalDetails

object

required

contract

object

required

location

object

required

schemeDetails

object

salesDetails

object

addresses

array of objects

addresses

object

categoryIndex

string | null

required

The category of the address to be added. It can be a mandatory or optional category, defined per Institution. For possible values check get:/api/v1/application/acquirer-profile with field name addressCategories.

contactName

string | null

required

The contact name at the address location. Any extended ASCII characters contains 2 bytes

groupSpecific

boolean | null

Only applicable if a merchant is in a hierarchy. Indicates if the address is to be used for all merchants within the group.

line1

string | null

required

Merchant address line 1 for the specified address category.

line2

string | null

Merchant address line 2 for the specified address category.

line3

string | null

Merchant address line 3 for the specified address category.

line4

string | null

Merchant address line 4 for the specified address category.

line5

string | null

Merchant address line 5 for the specified address category.

postCode

string

required

length between 0 and 20

Merchant address post code or zip code for the specified address category.

city

string

required

length between 0 and 35

Merchant city for the specified address category.

state

string

length between 0 and 3

Merchant state for the specified address category.

countryCode

string | null

required

ISO-3166 alpha country code representing the country the address category is located in, the values are restricted based on institutions configuration. For possible values check get:/api/v1/application/acquirer-profile with field name COUNTRYCODE.

telephone

string | null

required

Telephone at the specified address category

fax

string | null

Fax at the specified address category

deliveryMethodIndex

string | null

Delivery method code of correspondence to this address; however, it is dependent on the delivery solutions in place for the given institution. For possible values check get:/api/v1/application/acquirer-profile with field name DELIVERYMETHODINDEX.

string

required

length ≤ 60

Email address (with extended length capacity) for the specified address category

effectiveDate

date | null

Effective date of the address. When selecting address information the Omnipay platform will select the most recent effective address. For auditing reasons merchant address can not be deleted after it has become effective hence the use of effective dates for addresses. Format YYYYMMDD. If ommited the default is the current instituiton posting date.

addressId

integer

≤ 1e+27

Address identification inside our Boarding System.

applicationId

integer

≤ 1e+26

Application ID, owner of this address

accounts

array of objects

accounts

object

integer

≤ 1e+27

Account identification inside our Boarding System.

billingLevel

boolean

required

Defaults to false

Indicates if the account will be settled to on a funding. Billing accounts should have the Bank Account details filled.

receiverCountryCode

string | null

ISO-3166 alpha country code for the merchant's bank country. Mandatory if billing level is set to true.

statementTypeIndex

string

length between 3 and 3

Statement type to be generated. As per the predefined values or left blank where not applicable. For possible values check get:/api/v1/application/acquirer-profile with field name STATEMENTTYPEINDEX.

statementGenerationCode

string | null

Defaults to GENERATE_IF_ACTIVITY

Option for statement generation.

SUPPRESS GENERATE GENERATE_IF_ACTIVITY GENERATE_IF_NO_ACTIVITY

annualFeeDueDate

date

YYYYMMDD Date which the annual fee for this account should be generated

paymentReference

string | null

For institutions using IFS funding file this field should contain the direct debit contract number (required for merchant debits). For others it is a reference text to display on merchant's bank statement if supported on the funding file.

payable

object

Details to be used when sending a payment instruction on the funding file

receivable

object

Details to be used when sending a collection instruction on the funding file

applicationId

integer

≤ 1e+26

Application ID, owner of this Account

accountTypeIndex

string | null

required

Index of the account type to be assigned to the merchant. For a list of valid codes use API get /application/account-settlements with field name accountSettlement.accountType or get /application/account-type.

accountCurrencyCode

string | null

required

ISO 4217 currency of the account selected, possible values are restricted based on the institution configuration. For a list of valid codes use API get /application/account-fees with field name accountCurrencyCode or get /application/account-currency.

services

array of objects

services

object

integer

≤ 1e+27

Service identification number inside our Boarding System.

serviceIndex

string | null

required

Code id for the acquiring service. Valid values depends on the institution configuration. For possible values check get:/api/v1/application/services with field name serviceId.serviceIndex

assigned

boolean | null

required

Flag to indicate if the service is valid for the merchant.

tariffIndex

string | null

required

Code ID for the tariff which drives the default transactions fees to be generated for the merchant per service. For possible values check get:/api/v1/application/services with field name serviceMerchantTariffs.tariffIndex

floorLimit

string | null

Floor limit for merchant service selected; for information purpose only

dinersCode

string | null

Defaults to NA

Processing model to be applied for the merchant for Diners and Discover. Required if the service id corresponds to a Diners/Discover service.

CONVEYANCE_CLEARING DINERS_AND_DISCOVER NA

jcbStateCodeIndex

string | null

State code required to process and clear JCB transaction. Only required for JCB services. Value depends on the institution configuration. For a list of valid codes use Acquirer Profile API get acquirerprofile/v1.0/reference_data end-point with query parameter classification equal to jcbStateCodeIndex.

jcbAreaCode1Index

string | null

Area code 1 required to process and clear JCB transaction. Only required for JCB services. State and selected area codes should be as per institution specific list of values. For a list of valid codes use Acquirer Profile API get acquirerprofile/v1.0/reference_data end-point with query parameter classification equal to jcbAreaCode1Index.

jcbArea2Index

string | null

Area code 2 required to process and clear JCB transaction. Only required for JCB services. State and selected area codes should be as per institution specific list of values. For a list of valid codes use Acquirer Profile API get acquirerprofile/v1.0/reference_data end-point with query parameter classification equal to jcbArea2Index.

merchantSubId

string

Merchant sub id required to process and clear Ideal transaction. Required for Ideal service. Must not exist on an already boarded merchant under same institution.

applicationId

integer

≤ 1e+26

Application ID, owner of this Service

references

array of objects

references

object

integer

referenceIndex

string

required

length between 3 and 3

Predefined reference index to tag merchant with additional information. For a list of valid codes use references API - GET:/api/v1/application/reference-fields with field name referenceIndex.

referenceValue

string

length between 0 and 32

Value to be associated with the client reference. The value to be placed in this field is dependent on the client reference type. Note some values may be validated against a list of predefined values depending on the setup of the client reference, if the client reference values are pre-defined the API - GET:/api/v1/application/reference-fields end point results will indicate the possible values for the client reference.

merchantProperties

array of objects

merchantProperties

object

integer

≤ 1e+27

MerchantProperty identification number inside our Boarding System.

propertyIndex

string

required

Code for the institution defined property; as per the institution configuration. For a list of valid codes use Acquirer Profile API get acquirerprofile/v1.0/reference_data end-point with query parameter classification equal to propertyIndex.

propertyValue

string | null

The value of the property type selected

applicationId

integer

≤ 1e+26

Application ID, owner of this MerchantProperty

merchantDevices

array of objects

merchantDevices

object

integer

≤ 1e+27

MerchantDevice identification number inside our Boarding System.

externalTerminalId

string

required

length between 0 and 20

The unique id for the terminal. This value should be unique within the institution.

serialNumber

string | null

The serial number of the terminal

contactName

string | null

Contract name at terminal location

terminalLocation

string | null

Location of the terminal

telephone

string | null

Connection id or phone number for the terminal

schemeId

string | null

The identity of the schema

accountCurrencyCode

string | null

ISO 4217 currency code.

system_batchId

int32 | null

≤ 999999

Identity number of the system Batch

feeEffeciveDate

date | null

Date the terminal fee is effective from. Format YYYYMMDD. If ommited the default will be the current institution posting date.

lastFeeDate

date | null

Last fee date. Format YYYYMMDD

clientFeeIndex

int32 | null

≤ 999

If fees should be applied to the device, this code will indicate which is the corresponding fee to be triggered. For a list of valid codes use Acquirer Profile API get acquirerprofile/v1.0/reference_data end-point with query parameter classification equal to clientFeeIndex.

feeExpiryDate

date | null

Fee expiry date. Format YYYYMMDD

configOfTerminalIndex

string | null

Code corresponding to the configuration of the terminal. For possible values check get:/api/v1/application/acquirer-profile with field name CONFIGOFTERMINALINDEX.

installDate

date | null

Date the terminal was installed. Format YYYYMMDD

activeDate

date | null

Date the terminal was activated. Format YYYYMMDD

terminationDate

date | null

Termination date. Format YYYYMMDD

terminalPassword

string | null

The password for the terminal

terminalTypeIndex

string | null

Code corresponding to the terminal type. For possible values check get:/api/v1/application/acquirer-profile with field name TERMINALTYPEINDEX.

terminalCountryCode

string | null

ISO-3166 alpha country code representing the country the terminal is located. There is a restriction on the allowed countries for the institution.

serviceProviderIndex

string | null

Code associated with the company who takes care of the terminal. For a list of valid codes use Acquirer Profile API get acquirerprofile/v1.0/reference_data end-point with query parameter classification equal to serviceProviderIndex.

emv

boolean | null

Indicate if the terminal is EMV capable terminal

city

string | null

The city were the terminal resides at

amex

boolean | null

Indicates if the terminal supports Amex transactions, if true additional fields are required.

acquiringProfileIndex

string | null

Code correspnding to the acquirer profile setup on the terminal. For possible values check get:/api/v1/application/acquirer-profile with field name ACQUIRINGPROFILEINDEX.

templateId

string | null

Template id for the terminal

amexPhoneNo1

string | null

If Amex = true then Amex phone number 1 must be present.

amexPhoneNo2

string | null

If Amex = true then Amex phone number 2 must be present.

relatedTId

string | null

If Amex = true then related TID must be present.

waiver

string | null

Waiver indicator text or amount.

socCode

string | null

Schedule of charges code

setupFee

string | null

Setup fee

gprsRentalAmount

string | null

GPRS Rental Amount

gprsRental

string | null

GPRS renal ( Monthly/Annual)

installed

string | null

Installed/De-Installed. Format YYYYMMDD

applicationId

integer

≤ 1e+26

Application ID, owner of this MerchantDevice

merchantAccountFees

array of objects

merchantAccountFees

object

integer

≤ 1e+27

MerchantAccountFee identification number inside our Boarding System.

recordIdNumber

string | null

Record id of the client account fee to be overwritten. The corresponding id should belong to the client tariff id selected on the merchant contract details. For a list of valid codes use API get /application/account-fees with field name recordIdNumber or get /application/account-record end-point.

feePercentage

string | null

Defaults to 0.0000

Fee percentage to be applied. Valid value as per the Format NNNNNN.NNNN

feeBase

string | null

Defaults to 0.0000

Fee base to be applied. Valid value as per the Format NNNNNN.NNNN

feeMinimum

string | null

Defaults to 0.0000

Fee minimum to be applied. Valid value as per the Format NNNNNN.NNNN

feeMaximum

string | null

Defaults to 0.0000

Fee maximum to be applied. Valid value as per the Format NNNNNN.NNNN

feeMode

boolean | null

Defaults to true

Indicates if the fee is being generated (true) or suppressed (false). Suppressing a fee in effect is the same as setting the fee's pricing to zero, i.e. no fee will be charged.

triggerHighValue

string | null

Defaults to 0.00

Indicates the upper threshold limit set in terms of value of transaction that is used as a trigger for fee calculation.

triggerLowValue

string | null

Indicates the lower threshold limit set in terms of value of transaction that is used as a trigger for fee calculation.

triggerVolumeHigh

string | null

Defaults to 0.00

Indicates the upper threshold limit set in terms of volume of transactions that is used as a trigger for fee calculation.

triggerVolumeLow

string | null

Defaults to 0.00

Indicates the lower threshold limit set in terms of volume of transactions that is used as a trigger for fee calculation.

applicationId

integer

≤ 1e+26

Application ID, owner of this MerchantAccountFee

transactionCharges

array of objects

transactionCharges

object

integer

≤ 1e+27

TransactionCharge identification number inside our Boarding System.

recordIdNumber

string

length between 10 and 10

Record id of the transaction fee to be overwritten. For a list of valid record ids use the api get: /application/transaction-charges with field name data.recordIdNumber.

effectiveDate

date | null

Detail today's date or a future date as appropriate. Format YYYYMMDD. If ommited it will be defaulted to the institution current posting date.

expiryDate

date | null

Expiry date for fee if defined or set to or future date 99991231. Format YYYYMMDD. The date should be in future

feePercentage

string | null

Defaults to 0.0000

Charge base to be applied.

feeBase

string | null

Defaults to 0.0000

Charge base amount to be applied.

feeMinimum

string | null

Defaults to 0.0000

Minimum charge amount.

feeMaximum

string | null

Defaults to 0.0000

Maximum charge amount.

chargeCurrencyCode

string | null

The ISO 4217 currency code for the charge base, minimum and maximun amounts. Values are restricted by institution configuration. For a list of valid record ids use the api get: /application/transaction-charges with field name data.chargeCurrencyCode

chargeTierLevel

string | null

The tier assigned which will drive the merchant tiered pricing. The tier level that is assigned to the merchant. This will be N/A (Default) if the transaction charge record is not tiered.

applicationId

integer

≤ 1e+26

Application ID, owner of this TransactionCharge

paymentInstructions

array of objects

paymentInstructions

object

integer

≤ 1e+27

PaymentInstruction identification number inside our Boarding System.

accountTypeIndex

string | null

From account array, this is the account type id for a billing level account for which the reserve, rolling reserve and/or factoring need to be set up

accountCurrencyCode

string | null

From the account array, the is the account currency corresponding to the selected account type id. ISO 4217

instructionTypeIndex

string | null

Indicates the type of payment instruction to be set for the selected account. The values depends on the configured payment instructions for the Institution. For possible values check get:/api/v1/application/acquirer-profile with field name ACQUIRINGPROFILEINDEX.

deductionStartDate

date | null

Date when the instruction starts. Format YYYYMMDD

deductionEndDate

date | null

Date when the instruction ends. Format YYYYMMDD

deductionPercentage

string | null

Defaults to 00.000000

The payment percent to be deducted from the calculated total amount, to be paid from the account type selected.

deductionMinAmount

string | null

Defaults to 00.000000

The minimum value to be deducted from the payment.

deductionMaxAmount

string | null

Defaults to 00.000000

The maximum value to be deducted from the payment.

deductionBaseAmount

string | null

Defaults to 00.000000

The amount to be deducted from the calculated total amount, to be paid from the account type selected.

deductionTotalCnt

string | null

Indicates how many times this instruction should be executed

deductionTotalAmount

string | null

Indicates how many times this instruction should be executed

factorAgent

string | null

Name of the factor agent

note

string

length between 0 and 674

Free Text for extra note

applicationId

integer

≤ 1e+26

Application ID, owner of this PaymentInstruction

applicationNumber

string

boardDate

date

integrationStep

string

groupLevel

int32

step

int32

errorValidation

string

applicationStatusDate

date-time

bpmProcessId

string

institutionNumber

int64

cardPresence

string

PHYSICAL VIRTUAL BOTH

insertDate

date

lastUpdate

date

parentMerchant

integer

terminals-processing

object

required

entitlements

array of objects

entitlements

object

entitlement

string

required

Entitlement that the terminal will use

VISA MASTERCARD AMEX DISCOVER DINERS JCB CUP JETS LYNX VISA_DEBIT MASTERCARD_DEBIT MASTERCARD_DUAL VISA_DUAL GENERIC_PRIVATE_LABEL PROSA EDS

pcfAdditionalData

object

Additional entitlement data (only for PCF system)

fdposAdditionalData

object

Additional entitlement data (only for FDPOS system)

fdpos

object

clover

object

products

array of objects

products

object

idOnbTerminal

integer

applicationId

integer

terminalCode

string

quantity

int32

terminalIds

array of strings

terminalIds

pcf-data

object

tms-data

object

fdpos-data

object

e-store

object

required

ipgPurchaseLimitsByIdIpg

array of objects

required

ipgPurchaseLimitsByIdIpg*

object

integer

idOnbIpg

integer

currency

string | null

limit

number

0.01 to 9999999999.99

This field contains the merchant max amount limit for transaction processing in e-store. This is with no decimal.

ipg

object

required

ipgServices

array of objects

required

ipgServices*

object

type

string

length ≤ 50

Service type which should be configured

configs

array of objects

required

A Feature Value is a specificied value for given item type. For a list of possible value get/application/data/{countrycode}.

configs*

object

item

string

length ≤ 50

Item type

value

string

length ≤ 1024

Feature Value

ipgTerminalsByIdIpg

object

required

204

No register was found

401

Unauthorized request

Language


xxxxxxxxxx
45
1
curl --request POST \
2
     --url https://cat-webfarm.1dc.com/boarding-ui-cat/external-api/api/v1/application \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "main": {
8
    "requiredDetails": {
9
      "residentStatusCode": "NA",
10
      "residencyFeeLevelCode": "NA"
11
    },
12
    "optionalDetails": {
13
      "paymentDeliveryMethodCode": "NA"
14
    },
15
    "contract": {
16
      "reclassBillbackIndicatorCode": "NA"
17
    },
18
    "schemeDetails": {
19
      "crossBorderFeeCode": "NONE",
20
      "masterCardIPQualificationCode": "NA",
21
      "visaIPQualificationCode": "NA",
22
      "visaCanIasfFee": false,
23
      "viLacFeeCode": "NA",
24
      "mcLacFeeCode": "NA",
25
      "mcAbvFeeInd": false,
26
      "visaEuFeeIndCode": "NEITHER",
27
      "mcIntlEcomFee": false
28
    }
29
  },

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Successful operation

400Bad request

403Forbidden request

500Internal Error

502API Error