Maintenance Merchant

Omnipay Merchant Details
Omnipay Merchant References
Omnipay Accounts
Omnipay Payment Instructions
Omnipay Transaction Charges
IPG Ecommerce
TMP Orders
Omnipay Merchant Services
PCF/Base24 Terminal Management
Omnipay Account Fees
TMS Terminal Management
Omnipay Addresses
Omnipay Merchant Properties
Omnihub
OpenFX DCC
FDPOS Terminal Management
- /api/v1/maintenance/fdpos/products/{mid}post
- /api/v1/maintenance/fdpos/{mid}/request/{requestId}/terminalsget
TMP Terminal Management
Clover Terminal Management
- /api/v1/clover/merchant/{mid}/terminal/provisionpost
- /api/v1/clover/merchant/{mid}/terminal/deprovisionpost
internal-log-controller
- /api/v1/audit-logget

Bording Merchant

diligence-remarks-controller
- /api/v1/diligence/remarksput
- /api/v1/diligence/remarks/{applicationId}get
application-impl-controller
diligence-controller
- /api/diligenceput
- /api/diligence/{id}get
token-controller
- /tokenpost
- /token/refreshpost
terminal-controller
open-fx-controller
secondary-tax-id-values-controller
- /api/v1/secondaryTaxIDValuesget
ipg-controller
- /api/v1/ipgget
- /api/v1/ipg/merchant/{mid}get
fdpos-controller
- /api/v1/fdpos/products-and-features/{countryCode}get

Card Present

/payments/v1/payments
- Generate a primary transactionpost

Boarding Webhook

webhook
- boarding resultspost

/api/diligence

put https://cat-webfarm.1dc.com/boarding-ui-dev/external-api/api/diligence

This endpoint allows you save or update a Diligence Application

Body Params

diligenceMerchant

object

required

diligencePrincipals

array of objects

required

diligencePrincipals*

diligenceVisitation

object

required

salesManDetail

object

required

diligenceSalesData

object

required

currency

object

required

applicationId

integer

required

Application identification. Return on the API after the first save - post:/application/v1.

Responses

Response body

object

diligenceMerchantResponse

object

merchantId

integer

legalForm

string

Business Legal Form

businessStartDate

date

The date business opened its doors.

diligencePrincipalResponses

array of objects

diligencePrincipalResponses

object

principalId

integer

firstName

string

First Name of the Principal Owner.

lastName

string

Last Name of the Principal Owner.

dateOfBirth

date

Date of Birth the Principal Owner

nationality

int32

Nationality of the Principal Owner

diligenceAddress

object

personalGuarantee

string

Principal Guarantee Flag. Possible values are yes or no.

percentOwnership

number

Principal Ownership percentage.

pullCBReport

string

Rights to Pull Credit Bureau Report.

diligenceNationalId

object

salesManDetailsResponse

object

salesManDetailsId

integer

salesManId

string

Sales Rep Code

agentFName

string

Name of the Principal Owner.

agentLName

string

Last Name of the Principal Owner

agentEmailID

string

E-mail address of the Principal Owner

diligenceSalesDataResponse

object

salesDataId

integer

diligenceBusinessProceduresDTO

object

currencyResponse

object

currencyId

integer

applicationCurrency

string

The identification of merchant (MID) will be based on this supported currency. Possible value: Mexican PESO MXN / 484 or US Dollar USD / 840

diligenceVisitationResponse

object

visitationId

integer

productServiceSold

string

Description of Goods and Services sold. Free Form Text, must not be pre-filled.

diligenceApplicationStatusDto

object

diligencePushId

integer

required

diligenceId

integer

required

applicationStatus

string

enum

required

APPROVED DECLINED IN_PROCESS BACK_TO_SALES DECLINE_REVALUATION

puwStatus

string

enum

APPROVED DECLINED IN_PROCESS BACK_TO_SALES DECLINE_REVALUATION

puwReasonCode

string

creditOfficerId

string

creditOfficerName

string

comments

string

reasonDesc1

string

reasonDesc2

string

reasonDesc3

string

reasonDesc4

string

applicationId

integer

Application identification. Return on the API after the first save - post:/application/v1.

204

No register was found

Response body

object

timestamp

date-time

Date and time of error

statusCode

int32

HTTP status code

statusMessage

string

HTTP status message

errorType

string

HTTP error type

requestPath

string

HTTP request path

errors

array of objects

Error list

errors

Response body

object

timestamp

date-time

Date and time of error

statusCode

int32

HTTP status code

statusMessage

string

HTTP status message

errorType

string

HTTP error type

requestPath

string

HTTP request path

errors

array of objects

Error list

errors

Response body

object

timestamp

date-time

Date and time of error

statusCode

int32

HTTP status code

statusMessage

string

HTTP status message

errorType

string

HTTP error type

requestPath

string

HTTP request path

errors

array of objects

Error list

errors

Response body

object

timestamp

date-time

Date and time of error

statusCode

int32

HTTP status code

statusMessage

string

HTTP status message

errorType

string

HTTP error type

requestPath

string

HTTP request path

errors

array of objects

Error list

errors

Updated 2 months ago

/api/v1/application/account-currency

/api/diligence/{id}

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://cat-webfarm.1dc.com/boarding-ui-dev/external-api/api/diligence \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json'

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

*/*

application/json

Updated 2 months ago

/api/v1/application/account-currency

/api/diligence/{id}

Maintenance Merchant
Omnipay Merchant Details
/api/v1/omnipay/merchantDetails/{mid}/contractdel
/api/v1/omnipay/merchantDetails/{mid}/contractpost
/api/v1/omnipay/merchantDetails/{mid}/contractput
/api/v1/omnipay/merchantDetails/{mid}/statusput
/api/v1/omnipay/merchantDetails/{mid}put
/api/v1/omnipay/merchantDetails/{mid}get
Omnipay Merchant References
/api/v1/omnipay/merchantReferences/{mid}del
/api/v1/omnipay/merchantReferences/{mid}post
/api/v1/omnipay/merchantReferences/{mid}put
/api/v1/omnipay/merchantReferences/{mid}get
Omnipay Accounts
/api/v1/omnipay/accounts/{mid}post
/api/v1/omnipay/accounts/{mid}put
/api/v1/omnipay/accounts/{mid}get
Omnipay Payment Instructions
/api/v1/omnipay/paymentInstructions/{mid}post
/api/v1/omnipay/paymentInstructions/{mid}get
/api/v1/omnipay/paymentInstructions/expire/{mid}put
Omnipay Transaction Charges
/api/v1/transactionCharges/deleteFutureTransactions/{mid}del
/api/v1/transactionCharges/cloneDefaultToIndividual/{mid}post
/api/v1/transactionCharges/expireCharges/{mid}put
/api/v1/transactionCharges/{mid}post
/api/v1/transactionCharges/{mid}put
/api/v1/transactionCharges/{mid}get
IPG Ecommerce
/api/v1/ecommerce/{mid}/{country}post
/api/v1/ecommerce/{mid}/{country}put
/api/v1/ecommerce/{mid}/{country}get
TMP Orders
/api/v1/orders/clear-cache-reason-cancellationdel
/api/v1/orders/inquery-reason-cancellationget
/api/v1/orders/ticket-list/{merchantId}get
/api/v1/orders/cancel-orderpost
/api/v1/orders/reschedulepost
Omnipay Merchant Services
/api/v1/omnipay/merchantServices/{mid}post
/api/v1/omnipay/merchantServices/{mid}put
/api/v1/omnipay/merchantServices/{mid}get
PCF/Base24 Terminal Management
/api/v1/pcfdel
/api/v1/pcfpost
/api/v1/pcfput
Omnipay Account Fees
/api/v1/omnipay/accountFees/{mid}del
/api/v1/omnipay/accountFees/{mid}post
/api/v1/omnipay/accountFees/{mid}put
/api/v1/omnipay/accountFees/{mid}get
TMS Terminal Management
/api/v1/terminals/tms/terminal/{terminalId}get
/api/v1/terminals/tms/merchantpost
/api/v1/terminals/tms/terminalpost
/api/v1/terminals/tms/merchant/{merchantId}/terminal/{terminalId}del
/api/v1/terminals/tms/merchant/{merchantId}/terminal/{terminalId}put
/api/v1/terminals/tms/merchant/{merchantId}put
/api/v1/terminals/tms/merchant/{merchantId}get
Omnipay Addresses
Delete future dated addressesdel
Add future dated addressespost
Modify future effective addressesput
Retrieve merchant addressesget
Omnipay Merchant Properties
/api/v1/omnipay/merchantProperties/{mid}del
/api/v1/omnipay/merchantProperties/{mid}post
/api/v1/omnipay/merchantProperties/{mid}put
/api/v1/omnipay/merchantProperties/{mid}get
Omnihub
/api/v1/omnihub/merchant/{mid}/parameters/last-executionget
/api/v1/omnihub/paymentProcessor/{mid}get
/api/v1/omnihub/paymentProcessor/update/{mid}put
OpenFX DCC
/api/v1/openfx-margins/application/{internalMerchantId}del
/api/v1/openfx-margins/merchant/{internalMerchantId}get
/api/v1/openfx-marginspost
FDPOS Terminal Management
/api/v1/maintenance/fdpos/{mid}/request/{requestId}/terminalsget
/api/v1/maintenance/fdpos/products/{mid}post
TMP Terminal Management
/api/v1/terminals/enquire-terminals/{merchandId}get
/api/v1/terminals/inquiry-status/{referenceNumber}get
/api/v1/terminals/supply-requestget
/api/v1/terminals/ticket-list/{merchandId}get
/api/v1/terminals/change-technology/{merchandId}post
/api/v1/terminals/replacement/{merchandId}post
/api/v1/terminals/supply-request/{merchandId}post
/api/v1/terminals/change-carrier/{merchantId}put
Clover Terminal Management
/api/v1/clover/merchant/{mid}/terminal/deprovisionpost
/api/v1/clover/merchant/{mid}/terminal/provisionpost
internal-log-controller
/api/v1/audit-logget

Bording Merchant
diligence-remarks-controller
/api/v1/diligence/remarks/{applicationId}get
/api/v1/diligence/remarksput
application-impl-controller
/api/v1/application/account-currencyget
/api/v1/application/account-feesget
/api/v1/application/account-recordget
/api/v1/application/account-settlementsget
/api/v1/application/account-typeget
/api/v1/application/acquirer-profileget
/api/v1/application/contractsget
/api/v1/application/data/{countryCode}get
/api/v1/application/dataget
/api/v1/application/hierarchyget
/api/v1/application/mccget
/api/v1/application/merchant-propertiesget
/api/v1/application/optional-detailsget
/api/v1/application/reference-fieldsget
/api/v1/application/servicesget
/api/v1/application/transaction-charges/allget
/api/v1/application/transaction-chargesget
/api/v1/application/boardpost
/api/v1/application/{applicationId}/boardpost
/api/v1/applicationpost
/api/v1/applicationget
/api/v1/application/{applicationId}put
/api/v1/application/{applicationId}get
diligence-controller
/api/diligence/{id}get
/api/diligenceput
token-controller
/token/refreshpost
/tokenpost
terminal-controller
/api/v1/terminal/allTerminalValuesget
/api/v1/terminal/templates/country/{countryCode}get
/api/v1/terminal/save-allpost
open-fx-controller
/api/v1/openfx-margins/application/{applicationId}del
/api/v1/openfx-margins/application/{applicationId}get
/api/v1/openfx-marginspost
secondary-tax-id-values-controller
/api/v1/secondaryTaxIDValuesget
ipg-controller
/api/v1/ipg/merchant/{mid}get
/api/v1/ipgget
fdpos-controller
/api/v1/fdpos/products-and-features/{countryCode}get

Card Present
/payments/v1/payments
Generate a primary transactionpost

Boarding Webhook
webhook
boarding resultspost

200Successful operation

400Bad request

401Unauthorized request

403Forbidden request

500Internal Error