Merchant Boarding API Specification

Merchant Boarding API

Application Additional Info

Merchant Application Additional information.

Get Additional Information by Application

get /enroll/application/additional-info/key/{externalKey}

Get additional information associated with an application by application external key.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

0aa000a-000a-00a0-00a0-00000aa00a0

Example Response

200 Return additional information for enrollment application.

403 Forbidden response.

404 Application not found error response.

500 Internal Server Error response.

Update Additional Information by Application

patch /enroll/application/additional-info/key/{externalKey}

Update additional information associated with an application by application external key.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

0aa000a-000a-00a0-00a0-00000aa00a0

Request Schema

agentData

Type

object

acceptedPaymentTypes

Type

object

highRiskBusinessData

Type

object

achProcessing

Type

object

isAchProcessingEnabled

Type

boolean

Example

false

Example Request

{
  "agentData": {
    "agentGroupId": 1
  },
  "acceptedPaymentTypes": {
    "americanExpress": {
      "accountNumber": "123-test-2344",
      "amexAnnualVolumeThresholdExceeded": false,
      "amexMonthlyVolume": 11111
    }
  },
  "highRiskBusinessData": {
    "businessTypeFlags": {
      "isCbd": false,
      "isCannabis": true,
      "isKratom": true,
      "isSexuallyExplicitProducts": true
    },
    "highRiskPercentOfBusinessTransactions": {
      "cbd": 10
    }
  },
  "achProcessing": {
    "achCompanyName": "Business Corp.",
    "achEntryDescription": "Back Office Conversion Entry",
    "achPercentOfBusinessTransactions": {
      "retail": 100,
      "internet": 0,
      "moto": 0,
      "other": 0
    },
    "achPercentOfCustomerProfile": {
      "consumer": 100,
      "business": 0,
      "government": 0
    },
    "achProcessingVolumeBreakdown": {
      "credit": {
        "highAmount": 101,
        "averageAmount": 100,
        "averageBatchVolume": 1000,
        "averageMonthlyCount": 1
      },
      "debit": {
        "highAmount": 101,
        "averageAmount": 100,
        "averageBatchVolume": 100,
        "averageMonthlyCount": 10
      }
    },
    "achTransactionFrequency": {
      "oneTime": 100,
      "recurring": 0
    },
    "standardEntryCodes": [
      "BOC"
    ],
    "naicsCode": "311224"
  }
}

Example Response

200 Return updated additional information for enrollment application.

400 Bad request response.

403 Forbidden response.

404 Application not found error response.

415 Unsupported media type response - Invalid content type.

422 Unprocessable entity error response.

500 Internal Server Error response.