Create an additional-MID invite

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "code": "<string>",
  "message": "<string>",
  "data": {
    "facId": "<string>",
    "spProductId": "<string>",
    "inviteId": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "reference": "<string>",
    "url": "<string>",
    "notifications": {
      "email": {
        "enabled": true,
        "sent": true
      },
      "sms": {
        "enabled": true,
        "sent": true
      }
    },
    "status": "<string>",
    "isDeleted": true,
    "identity": {
      "owners": [
        {
          "title": "<string>",
          "firstName": "<string>",
          "middleName": "<string>",
          "lastName": "<string>",
          "birthDate": "2023-12-25",
          "phoneNumber": "<string>",
          "streetNum": "<string>",
          "streetName": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "ssnLast4": "<string>",
          "ownershipPercentage": 123,
          "email": "<string>"
        }
      ],
      "business": {},
      "Contact": {
        "firstName": "John",
        "middleName": "Michael",
        "lastName": "Doe",
        "birthDate": "1990-01-15",
        "position": "CEO",
        "ssn": "123-45-6789",
        "phoneNumber": "5551234567",
        "email": "john.doe@example.com"
      }
    },
    "feesTemplateId": "<string>",
    "fees": {
      "platform": {
        "interchange": {
          "enabled": true,
          "billTo": "<string>"
        },
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpCapture": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpAuth": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpChargeback": {
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpAvsOnly": {
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpDeclined": {
            "fixed": 123,
            "billTo": "<string>"
          },
          "checkSale": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "checkVerification": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "checkVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "checkRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "checkCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "checkReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          }
        },
        "perPeriod": [
          "<unknown>"
        ]
      },
      "spProduct": {
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 123,
            "fixed": 123
          },
          "ccCnpCapture": {
            "discountRate": 123,
            "fixed": 123
          },
          "ccCnpAuth": {
            "discountRate": 123,
            "fixed": 123
          },
          "ccCnpVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpChargeback": {
            "fixed": 123
          },
          "ccCnpAvsOnly": {
            "fixed": 123
          },
          "ccCnpDeclined": {
            "fixed": 123
          },
          "checkSale": {
            "discountRate": 123,
            "fixed": 123
          },
          "checkVerification": {
            "discountRate": 123,
            "fixed": 123
          },
          "checkVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          }
        },
        "perPeriod": [
          "<unknown>"
        ]
      }
    },
    "onboardingFlowTemplateId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "payoutBankAccounts": [
      "<unknown>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

POST

https://sandbox-platform.jupico.com

onboardinginvites

addsubmerchant

Create an additional-MID invite

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/onboardinginvites/addsubmerchant';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "code": "<string>",
  "message": "<string>",
  "data": {
    "facId": "<string>",
    "spProductId": "<string>",
    "inviteId": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "reference": "<string>",
    "url": "<string>",
    "notifications": {
      "email": {
        "enabled": true,
        "sent": true
      },
      "sms": {
        "enabled": true,
        "sent": true
      }
    },
    "status": "<string>",
    "isDeleted": true,
    "identity": {
      "owners": [
        {
          "title": "<string>",
          "firstName": "<string>",
          "middleName": "<string>",
          "lastName": "<string>",
          "birthDate": "2023-12-25",
          "phoneNumber": "<string>",
          "streetNum": "<string>",
          "streetName": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "ssnLast4": "<string>",
          "ownershipPercentage": 123,
          "email": "<string>"
        }
      ],
      "business": {},
      "Contact": {
        "firstName": "John",
        "middleName": "Michael",
        "lastName": "Doe",
        "birthDate": "1990-01-15",
        "position": "CEO",
        "ssn": "123-45-6789",
        "phoneNumber": "5551234567",
        "email": "john.doe@example.com"
      }
    },
    "feesTemplateId": "<string>",
    "fees": {
      "platform": {
        "interchange": {
          "enabled": true,
          "billTo": "<string>"
        },
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpCapture": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpAuth": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "ccCnpChargeback": {
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpAvsOnly": {
            "fixed": 123,
            "billTo": "<string>"
          },
          "ccCnpDeclined": {
            "fixed": 123,
            "billTo": "<string>"
          },
          "checkSale": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "checkVerification": {
            "discountRate": 123,
            "fixed": 123,
            "billTo": "<string>"
          },
          "checkVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "checkRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "checkCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          },
          "checkReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true,
            "billTo": "<string>"
          }
        },
        "perPeriod": [
          "<unknown>"
        ]
      },
      "spProduct": {
        "perTransaction": {
          "ccCnpSale": {
            "discountRate": 123,
            "fixed": 123
          },
          "ccCnpCapture": {
            "discountRate": 123,
            "fixed": 123
          },
          "ccCnpAuth": {
            "discountRate": 123,
            "fixed": 123
          },
          "ccCnpVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "ccCnpChargeback": {
            "fixed": 123
          },
          "ccCnpAvsOnly": {
            "fixed": 123
          },
          "ccCnpDeclined": {
            "fixed": 123
          },
          "checkSale": {
            "discountRate": 123,
            "fixed": 123
          },
          "checkVerification": {
            "discountRate": 123,
            "fixed": 123
          },
          "checkVoid": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkRefund": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkCredit": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          },
          "checkReversal": {
            "fixed": 123,
            "reverseFixed": true,
            "reverseDiscountRate": true
          }
        },
        "perPeriod": [
          "<unknown>"
        ]
      }
    },
    "onboardingFlowTemplateId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "payoutBankAccounts": [
      "<unknown>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

spProductId

string

The Service provider product reference.

Maximum string length: 100

Example:

"255"

reference

string

The invite reference.

Maximum string length: 100

Example:

"Reference 123"

applicantId

string

The aplicant reference

Example:

"682e0ef81da12ab7229dbf64"

invitedToSmAppId

string

Application reference to filter in the invite

Example:

"682e176bbee4495f337a0464"

identity

object

The identity object containing data about the business and its representatives

Hide child attributes

identity.owners

object[]

Hide child attributes

identity.owners.title

enum<string>

Title.

Available options:

Mr.,

Ms.,

Mrs.

Example:

"Mr."

identity.owners.firstName

string

First name.

Example:

"jonny"

identity.owners.middleName

string

Middle name.

Example:

"eric"

identity.owners.lastName

string

Last name.

Example:

"dooei"

identity.owners.birthDate

string<date>

Date of birth (YYYY-MM-DD).

Example:

"2000-08-01"

identity.owners.phoneNumber

string

Phone number.

Example:

"2232322323"

identity.owners.streetNum

string

Street number.

Example:

"79"

identity.owners.streetName

string

Street name.

Example:

"clarks"

identity.owners.city

string

City name.

Example:

"ny"

identity.owners.state

enum<string>

Two-letter US state code.

Available options:

AK,

AL,

AR,

AZ,

CA,

CO,

CT,

DE,

FL,

GA,

HI,

IA,

ID,

IL,

IN,

KS,

KY,

LA,

MA,

ME,

MD,

MI,

MN,

MS,

MO,

MT,

NC,

ND,

NE,

NH,

NJ,

NM,

NV,

NY,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VA,

VT,

WA,

WI,

WV,

WY

Example:

"NY"

identity.owners.postalCode

string

ZIP or postal code.

Example:

"23434"

identity.owners.ssn

string

Social Security number, 9 digits.

Example:

"123123123"

identity.owners.position

enum<string>

The position of the owner. Possible values are:

OW: Owner
CEO: Chief Executive Officer
CFO: Chief Financial Officer
COO: Chief Operating Officer
PRESIDENT: President
VICE PRESIDENT: Vice President
DIR: Director
TR: Treasurer
SEC: Secretary
PA: Partner
MEMBER LLC: Member of LLC
OTH: Other
SP: Sole Proprietorship

Available options:

OW,

CEO,

CFO,

COO,

PRESIDENT,

VICE PRESIDENT,

DIR,

TR,

SEC,

PA,

MEMBER LLC,

OTH,

SP

Example:

"CEO"

identity.owners.ownershipPercentage

integer

Percentage of the business this owner holds (0-100).

Example:

100

identity.owners.email

string<email>

Email address.

Example:

"mail_m@asd.com"

identity.business

object

Hide child attributes

identity.business.legalName

string

Registered legal name of the business.

Example:

"testInvite"

identity.business.dbaName

string

The merchant's doing-business-as name. Appears on customer statements unless overridden.

Example:

"testDBAInvite"

identity.business.federalTaxId

string

Federal tax ID, 9 digits.

Example:

"999999999"

identity.business.tinType

enum<string>

The type of Tax Identification Number (TIN):

SSN (Social Security Number)
EIN (Employer Identification Number)
Other

Available options:

SSN,

EIN,

Other

Example:

"SSN"

identity.business.mccCode

string

Four-digit merchant category code (MCC) that classifies the business.

Example:

"5812"

identity.business.phoneNumber

string

Phone number.

Example:

"2232322323"

identity.business.address

object

Address details.

Hide child attributes

identity.business.address.streetNum

string

Street number.

Example:

"123"

identity.business.address.streetName

string

Street name.

Example:

"main street"

identity.business.address.city

string

City name.

Example:

"ny"

identity.business.address.state

enum<string>

Two-letter US state code.

Available options:

AK,

AL,

AR,

AZ,

CA,

CO,

CT,

DE,

FL,

GA,

HI,

IA,

ID,

IL,

IN,

KS,

KY,

LA,

MA,

ME,

MD,

MI,

MN,

MS,

MO,

MT,

NC,

ND,

NE,

NH,

NJ,

NM,

NV,

NY,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VA,

VT,

WA,

WI,

WV,

WY

Example:

"NY"

identity.business.address.postalCode

string

ZIP or postal code.

Example:

"22222"

identity.business.websiteUrl

string<uri>

Business website URL.

Example:

"https://www.sarasa.com"

identity.business.ownershipType

enum<string>

Legal structure of the business.

Available options:

PublicCorporation,

Government,

PrivateCorporation,

SoleProprietorship,

LLC,

Partnership,

NonProfit,

Trust

Example:

"PrivateCorporation"

identity.business.businessEstablishedDate

string<date-time>

Format: YYYY-MM-DD

Example:

"2023-11-02"

identity.business.expectedMonthlyVolume

integer

Expected monthly processing volume, used in underwriting.

Example:

200

identity.contact

object

Hide child attributes

identity.contact.firstName

string

First name.

Example:

"John"

identity.contact.middleName

string

Middle name.

Example:

"Michael"

identity.contact.lastName

string

Last name.

Example:

"Doe"

identity.contact.birthDate

string<date>

Format: YYYY-MM-DD

Example:

"1990-01-15"

identity.contact.position

string

Role of the owner in the business.

Example:

"CEO"

identity.contact.ssn

string

Social Security Number

Example:

"123-45-6789"

identity.contact.phoneNumber

string

Phone number.

Example:

"5551234567"

identity.contact.email

string<email>

Email address.

Example:

"john.doe@example.com"

payoutBankAccounts

object[]

Bank accounts where the merchant receives payouts.

Hide child attributes

payoutBankAccounts.accountRouting

string

9-digit ABA routing number.

Maximum string length: 9

Example:

"123123122"

payoutBankAccounts.accountNumber

string

Bank account number.

Required string length: 6 - 17

Example:

"8789545642"

payoutBankAccounts.accountType

enum<string>

Bank account type, such as checking.

Available options:

checking

Maximum string length: 20

Example:

"checking"

payoutBankAccounts.nameOnAccount

string

Name on the bank account.

Maximum string length: 50

Example:

"Updatedjonnydooeiacc"

feesTemplateId

string

UUID of the fees template with predefined fees. If no value is passed, the id of the default template will be used.

Example:

""

fees

object

The fees object will overwrite the values set on the fees template, as specified by the feesTemplateId. This allows for customization of fees at the invite overriding any defaults defined in the template.

Hide child attributes

fees.platform

object

Fee configuration at the platform level.

Hide child attributes

fees.platform.interchange

object

Interchange pass-through fee settings.

Hide child attributes

fees.platform.interchange.enabled

boolean

Whether this setting is enabled.

Example:

false

fees.platform.interchange.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

fees.platform.perTransaction.ccCnpSale

object

Fee applied to each card-not-present sale.

Hide child attributes

fees.platform.perTransaction.ccCnpSale.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2

fees.platform.perTransaction.ccCnpSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

fees.platform.perTransaction.ccCnpCapture

object

Fee applied to each card-not-present capture.

Hide child attributes

fees.platform.perTransaction.ccCnpCapture.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpCapture.discountRate

number

Percentage fee charged on the event amount.

Example:

2

fees.platform.perTransaction.ccCnpCapture.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

fees.platform.perTransaction.ccCnpAuth

object

Fee applied to each card-not-present authorization.

Hide child attributes

fees.platform.perTransaction.ccCnpAuth.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpAuth.discountRate

number

Percentage fee charged on the event amount.

Example:

2

fees.platform.perTransaction.ccCnpAuth.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.25

fees.platform.perTransaction.ccCnpVoid

object

Fee applied to each card-not-present void.

Hide child attributes

fees.platform.perTransaction.ccCnpVoid.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.platform.perTransaction.ccCnpVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.ccCnpVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.ccCnpRefund

object

Fee applied to each card-not-present refund.

Hide child attributes

fees.platform.perTransaction.ccCnpRefund.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.platform.perTransaction.ccCnpRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.platform.perTransaction.ccCnpRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.ccCnpCredit

object

Fee applied to each card-not-present credit.

Hide child attributes

fees.platform.perTransaction.ccCnpCredit.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.platform.perTransaction.ccCnpCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.platform.perTransaction.ccCnpCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.ccCnpReversal

object

Fee applied to each card-not-present reversal.

Hide child attributes

fees.platform.perTransaction.ccCnpReversal.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.platform.perTransaction.ccCnpReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.platform.perTransaction.ccCnpReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.ccCnpChargeback

object

Fee applied to each chargeback.

Hide child attributes

fees.platform.perTransaction.ccCnpChargeback.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpChargeback.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

25

fees.platform.perTransaction.ccCnpAvsOnly

object

Fee applied to each AVS-only verification.

Hide child attributes

fees.platform.perTransaction.ccCnpAvsOnly.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.ccCnpAvsOnly.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.platform.perTransaction.ccCnpDeclined

object

Fee applied to each declined card-not-present attempt.

Hide child attributes

fees.platform.perTransaction.ccCnpDeclined.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"spProduct"

fees.platform.perTransaction.ccCnpDeclined.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.5

fees.platform.perTransaction.checkSale

object

Fee applied to each eCheck sale.

Hide child attributes

fees.platform.perTransaction.checkSale.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.checkSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

fees.platform.perTransaction.checkSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

fees.platform.perTransaction.checkVerification

object

Fee applied to each eCheck verification.

Hide child attributes

fees.platform.perTransaction.checkVerification.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.checkVerification.discountRate

number

Percentage fee charged on the event amount.

Example:

0

fees.platform.perTransaction.checkVerification.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.platform.perTransaction.checkVoid

object

Fee applied to each eCheck void.

Hide child attributes

fees.platform.perTransaction.checkVoid.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.checkVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.platform.perTransaction.checkVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.checkVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.checkRefund

object

Fee applied to each eCheck refund.

Hide child attributes

fees.platform.perTransaction.checkRefund.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.checkRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.platform.perTransaction.checkRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.platform.perTransaction.checkRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.checkCredit

object

Fee applied to each eCheck credit.

Hide child attributes

fees.platform.perTransaction.checkCredit.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.checkCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.platform.perTransaction.checkCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.platform.perTransaction.checkCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perTransaction.checkReversal

object

Fee applied to each eCheck reversal.

Hide child attributes

fees.platform.perTransaction.checkReversal.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.platform.perTransaction.checkReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.platform.perTransaction.checkReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.platform.perTransaction.checkReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.platform.perPeriod

object[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

Hide child attributes

fees.platform.perPeriod.period

enum<string>

Billing period for this recurring fee.

Available options:

today,

yesterday,

last-7-days,

this-month,

this-year,

last-6-months,

one-time,

daily,

weekly,

monthly,

quarterly,

per-semester,

annually

Example:

"daily"

fees.platform.perPeriod.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

3

fees.platform.perPeriod.since

string<date-time>

Start of the window during which this fee applies (ISO 8601).

Example:

"2025-08-01T03:00:00.000Z"

fees.platform.perPeriod.until

string<date-time>

End of the window during which this fee applies (ISO 8601).

Example:

"2025-08-23T03:00:00.000Z"

fees.platform.perPeriod.status

string

Whether this recurring fee is currently active.

Example:

"enabled"

fees.platform.perPeriod.isTriggerFirstTx

boolean

When true, the recurring fee starts only after the merchant processes their first transaction.

Example:

false

fees.platform.perPeriod.isProrated

boolean

Whether the first billing period is prorated.

Example:

true

fees.spProduct

object

Fee configuration at the Service Provider product level.

Hide child attributes

fees.spProduct.interchange

object

Interchange pass-through fee settings.

Hide child attributes

fees.spProduct.interchange.enabled

boolean

Whether this setting is enabled.

Example:

false

fees.spProduct.interchange.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"submerchant"

fees.spProduct.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

fees.spProduct.perTransaction.ccCnpSale

object

Fee applied to each card-not-present sale.

Hide child attributes

fees.spProduct.perTransaction.ccCnpSale.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2

fees.spProduct.perTransaction.ccCnpSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

fees.spProduct.perTransaction.ccCnpCapture

object

Fee applied to each card-not-present capture.

Hide child attributes

fees.spProduct.perTransaction.ccCnpCapture.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpCapture.discountRate

number

Percentage fee charged on the event amount.

Example:

2

fees.spProduct.perTransaction.ccCnpCapture.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

fees.spProduct.perTransaction.ccCnpAuth

object

Fee applied to each card-not-present authorization.

Hide child attributes

fees.spProduct.perTransaction.ccCnpAuth.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpAuth.discountRate

number

Percentage fee charged on the event amount.

Example:

2

fees.spProduct.perTransaction.ccCnpAuth.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.25

fees.spProduct.perTransaction.ccCnpVoid

object

Fee applied to each card-not-present void.

Hide child attributes

fees.spProduct.perTransaction.ccCnpVoid.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.spProduct.perTransaction.ccCnpVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.ccCnpVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.ccCnpRefund

object

Fee applied to each card-not-present refund.

Hide child attributes

fees.spProduct.perTransaction.ccCnpRefund.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.spProduct.perTransaction.ccCnpRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.spProduct.perTransaction.ccCnpRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.ccCnpCredit

object

Fee applied to each card-not-present credit.

Hide child attributes

fees.spProduct.perTransaction.ccCnpCredit.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.spProduct.perTransaction.ccCnpCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.spProduct.perTransaction.ccCnpCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.ccCnpReversal

object

Fee applied to each card-not-present reversal.

Hide child attributes

fees.spProduct.perTransaction.ccCnpReversal.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.spProduct.perTransaction.ccCnpReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.spProduct.perTransaction.ccCnpReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.ccCnpChargeback

object

Fee applied to each chargeback.

Hide child attributes

fees.spProduct.perTransaction.ccCnpChargeback.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpChargeback.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

25

fees.spProduct.perTransaction.ccCnpAvsOnly

object

Fee applied to each AVS-only verification.

Hide child attributes

fees.spProduct.perTransaction.ccCnpAvsOnly.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpAvsOnly.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.spProduct.perTransaction.ccCnpDeclined

object

Fee applied to each declined card-not-present attempt.

Hide child attributes

fees.spProduct.perTransaction.ccCnpDeclined.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Example:

"spProduct"

fees.spProduct.perTransaction.ccCnpDeclined.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.5

fees.spProduct.perTransaction.checkSale

object

Fee applied to each eCheck sale.

Hide child attributes

fees.spProduct.perTransaction.checkSale.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.checkSale.discountRate

number

Percentage fee charged on the event amount.

Example:

2.9

fees.spProduct.perTransaction.checkSale.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.3

fees.spProduct.perTransaction.checkVerification

object

Fee applied to each eCheck verification.

Hide child attributes

fees.spProduct.perTransaction.checkVerification.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.checkVerification.discountRate

number

Percentage fee charged on the event amount.

Example:

0

fees.spProduct.perTransaction.checkVerification.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.spProduct.perTransaction.checkVoid

object

Fee applied to each eCheck void.

Hide child attributes

fees.spProduct.perTransaction.checkVoid.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.checkVoid.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0

fees.spProduct.perTransaction.checkVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.checkVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.checkRefund

object

Fee applied to each eCheck refund.

Hide child attributes

fees.spProduct.perTransaction.checkRefund.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.checkRefund.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.spProduct.perTransaction.checkRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.spProduct.perTransaction.checkRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.checkCredit

object

Fee applied to each eCheck credit.

Hide child attributes

fees.spProduct.perTransaction.checkCredit.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.checkCredit.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.spProduct.perTransaction.checkCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.spProduct.perTransaction.checkCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perTransaction.checkReversal

object

Fee applied to each eCheck reversal.

Hide child attributes

fees.spProduct.perTransaction.checkReversal.billTo

enum<string>

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

Available options:

spProduct,

submerchant

Example:

"spProduct"

fees.spProduct.perTransaction.checkReversal.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

0.75

fees.spProduct.perTransaction.checkReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

Example:

false

fees.spProduct.perTransaction.checkReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

Example:

true

fees.spProduct.perPeriod

object[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

Hide child attributes

fees.spProduct.perPeriod.period

enum<string>

Billing period for this recurring fee.

Available options:

today,

yesterday,

last-7-days,

this-month,

this-year,

last-6-months,

one-time,

daily,

weekly,

monthly,

quarterly,

per-semester,

annually

Example:

"daily"

fees.spProduct.perPeriod.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

3

fees.spProduct.perPeriod.since

string<date-time>

Start of the window during which this fee applies (ISO 8601).

Example:

"2025-08-01T03:00:00.000Z"

fees.spProduct.perPeriod.until

string<date-time>

End of the window during which this fee applies (ISO 8601).

Example:

"2025-08-23T03:00:00.000Z"

fees.spProduct.perPeriod.status

string

Whether this recurring fee is currently active.

Example:

"enabled"

fees.spProduct.perPeriod.isTriggerFirstTx

boolean

When true, the recurring fee starts only after the merchant processes their first transaction.

Example:

false

fees.spProduct.perPeriod.isProrated

boolean

Whether the first billing period is prorated.

Example:

true

onboardingFlowTemplateId

string

UUID of the onboarding flow template to be used for the onboarding experience.

Example:

""

Response

Onboarding invite successfully created.

success

boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

code

string

Machine-readable result code. See the Error Codes reference.

message

string

Human-readable result message.

data

object

The response payload.

Hide child attributes

data.facId

string

Facilitator identifier assigned by Jupico.

data.spProductId

string

Identifier of the Service Provider product the merchant belongs to.

data.inviteId

string

Unique identifier of the onboarding invite.

data.name

string

Display name.

data.email

string

Email address.

data.phoneNumber

string

Phone number.

data.reference

string

Your own reference for this invite.

data.url

string<uri>

URL of the hosted page for this object.

data.notifications

object

Delivery status of invite notifications.

Hide child attributes

data.notifications.email

object

Email notification status.

Hide child attributes

data.notifications.email.enabled

boolean

Whether this setting is enabled.

data.notifications.email.sent

boolean

Whether the notification was sent.

data.notifications.sms

object

SMS notification status.

Hide child attributes

data.notifications.sms.enabled

boolean

Whether this setting is enabled.

data.notifications.sms.sent

boolean

Whether the notification was sent.

data.status

string

Current status.

data.isDeleted

boolean

Whether the record is soft-deleted.

data.identity

object

Identity details for the business and its owners.

Hide child attributes

data.identity.owners

object[]

Business owners. Required for individual and business entity types.

Hide child attributes

data.identity.owners.title

string

Salutation of the owner (Mr., Ms., Mrs.).

data.identity.owners.firstName

string

First name.

data.identity.owners.middleName

string

Middle name.

data.identity.owners.lastName

string

Last name.

data.identity.owners.birthDate

string<date>

Date of birth (YYYY-MM-DD).

data.identity.owners.phoneNumber

string

Phone number of the owner.

data.identity.owners.streetNum

string

Street number.

data.identity.owners.streetName

string

Street name.

data.identity.owners.city

string

City name.

data.identity.owners.state

string

Two-letter US state code.

data.identity.owners.postalCode

string

ZIP or postal code.

data.identity.owners.ssnLast4

string

Last 4 digits of the owner's SSN.

data.identity.owners.ownershipPercentage

integer

Percentage of the business this owner holds (0-100).

data.identity.owners.email

string

Email address of the owner.

data.identity.business

object

Business identity details.

data.identity.Contact

object

Primary contact details.

Hide child attributes

data.identity.Contact.firstName

string

First name.

Example:

"John"

data.identity.Contact.middleName

string

Middle name.

Example:

"Michael"

data.identity.Contact.lastName

string

Last name.

Example:

"Doe"

data.identity.Contact.birthDate

string<date>

Format: YYYY-MM-DD

Example:

"1990-01-15"

data.identity.Contact.position

string

Role of the owner in the business.

Example:

"CEO"

data.identity.Contact.ssn

string

Social Security Number

Example:

"123-45-6789"

data.identity.Contact.phoneNumber

string

Phone number.

Example:

"5551234567"

data.identity.Contact.email

string<email>

Email address.

Example:

"john.doe@example.com"

data.feesTemplateId

string

UUID of a fees template with predefined pricing. If omitted, the default template is used.

data.fees

object

Fee configuration. Overrides values from the fees template.

Hide child attributes

data.fees.platform

object

Fee configuration at the platform level.

Hide child attributes

data.fees.platform.interchange

object

Interchange pass-through fee settings.

Hide child attributes

data.fees.platform.interchange.enabled

boolean

Whether this setting is enabled.

data.fees.platform.interchange.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

data.fees.platform.perTransaction.ccCnpSale

object

Fee applied to each card-not-present sale.

Hide child attributes

data.fees.platform.perTransaction.ccCnpSale.discountRate

number

Percentage fee charged on the event amount.

data.fees.platform.perTransaction.ccCnpSale.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpSale.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpCapture

object

Fee applied to each card-not-present capture.

Hide child attributes

data.fees.platform.perTransaction.ccCnpCapture.discountRate

number

Percentage fee charged on the event amount.

data.fees.platform.perTransaction.ccCnpCapture.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpCapture.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpAuth

object

Fee applied to each card-not-present authorization.

Hide child attributes

data.fees.platform.perTransaction.ccCnpAuth.discountRate

number

Percentage fee charged on the event amount.

data.fees.platform.perTransaction.ccCnpAuth.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpAuth.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpVoid

object

Fee applied to each card-not-present void.

Hide child attributes

data.fees.platform.perTransaction.ccCnpVoid.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpVoid.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpRefund

object

Fee applied to each card-not-present refund.

Hide child attributes

data.fees.platform.perTransaction.ccCnpRefund.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpRefund.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpCredit

object

Fee applied to each card-not-present credit.

Hide child attributes

data.fees.platform.perTransaction.ccCnpCredit.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpCredit.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpReversal

object

Fee applied to each card-not-present reversal.

Hide child attributes

data.fees.platform.perTransaction.ccCnpReversal.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.ccCnpReversal.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpChargeback

object

Fee applied to each chargeback.

Hide child attributes

data.fees.platform.perTransaction.ccCnpChargeback.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpChargeback.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpAvsOnly

object

Fee applied to each AVS-only verification.

Hide child attributes

data.fees.platform.perTransaction.ccCnpAvsOnly.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpAvsOnly.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.ccCnpDeclined

object

Fee applied to each declined card-not-present attempt.

Hide child attributes

data.fees.platform.perTransaction.ccCnpDeclined.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.ccCnpDeclined.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.checkSale

object

Fee applied to each eCheck sale.

Hide child attributes

data.fees.platform.perTransaction.checkSale.discountRate

number

Percentage fee charged on the event amount.

data.fees.platform.perTransaction.checkSale.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.checkSale.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.checkVerification

object

Fee applied to each eCheck verification.

Hide child attributes

data.fees.platform.perTransaction.checkVerification.discountRate

number

Percentage fee charged on the event amount.

data.fees.platform.perTransaction.checkVerification.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.checkVerification.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.checkVoid

object

Fee applied to each eCheck void.

Hide child attributes

data.fees.platform.perTransaction.checkVoid.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.checkVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkVoid.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.checkRefund

object

Fee applied to each eCheck refund.

Hide child attributes

data.fees.platform.perTransaction.checkRefund.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.checkRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkRefund.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.checkCredit

object

Fee applied to each eCheck credit.

Hide child attributes

data.fees.platform.perTransaction.checkCredit.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.checkCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkCredit.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perTransaction.checkReversal

object

Fee applied to each eCheck reversal.

Hide child attributes

data.fees.platform.perTransaction.checkReversal.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.platform.perTransaction.checkReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.platform.perTransaction.checkReversal.billTo

string

Which party is billed for this fee: spProduct (the Service Provider) or submerchant (the merchant).

data.fees.platform.perPeriod

any[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

data.fees.spProduct

object

Fee configuration at the Service Provider product level.

Hide child attributes

data.fees.spProduct.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpSale

object

Fee applied to each card-not-present sale.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpSale.discountRate

number

Percentage fee charged on the event amount.

data.fees.spProduct.perTransaction.ccCnpSale.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpCapture

object

Fee applied to each card-not-present capture.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpCapture.discountRate

number

Percentage fee charged on the event amount.

data.fees.spProduct.perTransaction.ccCnpCapture.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpAuth

object

Fee applied to each card-not-present authorization.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpAuth.discountRate

number

Percentage fee charged on the event amount.

data.fees.spProduct.perTransaction.ccCnpAuth.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpVoid

object

Fee applied to each card-not-present void.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpVoid.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpRefund

object

Fee applied to each card-not-present refund.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpRefund.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpCredit

object

Fee applied to each card-not-present credit.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpCredit.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpReversal

object

Fee applied to each card-not-present reversal.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpReversal.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.ccCnpChargeback

object

Fee applied to each chargeback.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpChargeback.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpAvsOnly

object

Fee applied to each AVS-only verification.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpAvsOnly.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.ccCnpDeclined

object

Fee applied to each declined card-not-present attempt.

Hide child attributes

data.fees.spProduct.perTransaction.ccCnpDeclined.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkSale

object

Fee applied to each eCheck sale.

Hide child attributes

data.fees.spProduct.perTransaction.checkSale.discountRate

number

Percentage fee charged on the event amount.

data.fees.spProduct.perTransaction.checkSale.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkVerification

object

Fee applied to each eCheck verification.

Hide child attributes

data.fees.spProduct.perTransaction.checkVerification.discountRate

number

Percentage fee charged on the event amount.

data.fees.spProduct.perTransaction.checkVerification.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkVoid

object

Fee applied to each eCheck void.

Hide child attributes

data.fees.spProduct.perTransaction.checkVoid.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkVoid.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkVoid.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkRefund

object

Fee applied to each eCheck refund.

Hide child attributes

data.fees.spProduct.perTransaction.checkRefund.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkRefund.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkRefund.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkCredit

object

Fee applied to each eCheck credit.

Hide child attributes

data.fees.spProduct.perTransaction.checkCredit.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkCredit.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkCredit.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkReversal

object

Fee applied to each eCheck reversal.

Hide child attributes

data.fees.spProduct.perTransaction.checkReversal.fixed

number

Fixed fee amount charged each time this event occurs.

data.fees.spProduct.perTransaction.checkReversal.reverseFixed

boolean

Whether the fixed fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perTransaction.checkReversal.reverseDiscountRate

boolean

Whether the percentage fee is returned when the underlying transaction is reversed.

data.fees.spProduct.perPeriod

any[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

data.onboardingFlowTemplateId

string

UUID of the onboarding flow template that controls which steps the merchant sees.

data.expiresAt

string<date-time>

Timestamp when this object expires (ISO 8601).

data.payoutBankAccounts

any[]

Bank accounts where the merchant receives payouts.

data.createdAt

string<date-time>

Timestamp when the object was created (ISO 8601).

data.updatedAt

string<date-time>

Timestamp when the object was last updated (ISO 8601).

API Overview

API Reference

Resources

Create an additional-MID invite

Authorizations

Body

Response