Boarding

Submit Application

SecurityJWT

Request

Request Body schema:
application/json

	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitBusinessInformationDto)
required	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitLocationAddressDto) Location Address. Refers to a physical place or establishment where a business conducts its commercial activities, accepts payments, and provides goods or services to customers
isLegalAddressTheSame required	boolean Is legal address the same
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitAddressDto)
required	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitAuthorizedSignerDto)
isPrimaryContactTheSame	boolean Is Primary Contact the same as the Owner 1?
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitPrimaryContactDto)
achProcessor	integer <int32> (ACHProcessorDto) Aurora Partner that securely manages and facilitates electronic financial ACH transactions between buyers and sellers, ensuring the efficient transfer of funds and compliance with security standards Possible values: 0 - Straddle: Straddle, Inc. is one of the fastest growing electronic payment ach processing companies in the world. The company is a venture-funded entity located in the Tampa Bay Florida area that offers payment-processing services to businesses in all 50 U.S. states. https://achq.com/about/ Value: 0
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SubmitAchProcessorDataDto) ACHQ specific information. Required if achProcessor is set.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/v1/boarding/applications/submit

Request samples

Payload
curl

{"businessInformation": {"mccCodeAliasId": "ac77ae78-04a5-4477-a958-5b153f233d12",
"detailedExplanationWhatDoYouSell": "Hardware store",
"dbaName": "Market",
"legalName": "Market INC",
"webSite": "https://risewithaurora.com",
"businessPhone": "+17701234567",
"customerServicePhone": "+17701234567",
"businessEmail": "test@gmail.com",
"isMerchantOptsOutOfReceivingFutureCommercialFromAmex": false,
"typeOfBusiness": 0,
"businessEstablishedDate": "10/10/2022",
"taxId": "201234567",
"documentationMailingAddress": 0,
"swiped": 20,
"keyed": 20,
"eCommerce": 60,
"desiredLimits": {"monthlyVMCD": 20000,
"avgTicketVMCD": 100,
"highTicketVMCD": 5000,
"monthlyAMEX": 20000,
"avgTicketAMEX": 100,
"highTicketAMEX": 5000
},
"siteInspectionType": 0,
"bankInfo": {"routing": "123456789",
"bank": "TEXAS BANK AND TRUST",
"account": "752111",
"accountName": "TEST LLC"
}
},
"locationAddress": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US",
"typeOfLocation": 0,
"locationIfOther": "string"
},
"isLegalAddressTheSame": false,
"legalAddress": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"owner1": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"owner2": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"owner3": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"owner4": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"authorizedSigner": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
}
},
"isPrimaryContactTheSame": true,
"primaryContact": {"firstName": "Brian",
"lastName": "Tran",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com"
},
"achProcessor": 0,
"achProcessorData": {"monthlyVolumeACH": 1,
"monthlyVolumeACHPayouts": 1,
"highTicketACH": 1,
"highTicketACHPayouts": 1,
"ticketCountACH": 1,
"ticketCountACHPayouts": 1,
"customerType": 0,
"paymentAuthorizationType": 0,
"statementDescriptor": "string",
"useOfPaymentServiceDescription": "string",
"billingRouting": "123456789",
"billingBank": "TEXAS BANK AND TRUST",
"billingAccount": "752111",
"billingAccountName": "TEST LLC"
}
}

Response samples

application/json

{"urlForSigning": "string",
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"applicationNumber": 0
}

Submit Draft Application

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/v1/boarding/applications/{applicationId}/submit

Request samples

curl

Response samples

application/json

{"urlForSigning": "string",
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"applicationNumber": 0
}

Create Draft Application

SecurityJWT

Request

Request Body schema:
application/json

	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressBusinessInformationDto)
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressLocationAddressDto) Location Address. Refers to a physical place or establishment where a business conducts its commercial activities, accepts payments, and provides goods or services to customers
isLegalAddressTheSame	boolean Is legal address the same
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAddressDto) Location Address. Required if not the same as Location Address. The official address of a business or individual as recognized and recorded by legal and governmental authorities. Typically used for legal and official purposes, including government correspondence, regulatory compliance, tax filings, and other formal documentation
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAuthorizedSignerDto) Authorized Signer
isPrimaryContactTheSame	boolean Is Primary Contact the same as the Owner 1?
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressPrimaryContactDto) Primary Contact. Required if not the same as Owner 1. The primary contact of a business is the individual who serves as the main point of contact for communication and coordination.Examples: Owner/Founder, CEO(Chief Executive Officer), Managing Director, Business Development Manager, Customer Service Manager, Sales Manager, Public Relations Officer, Office Manager, Marketing Manager, Project Manager
achProcessor	integer <int32> (ACHProcessorDto) Aurora Partner that securely manages and facilitates electronic financial ACH transactions between buyers and sellers, ensuring the efficient transfer of funds and compliance with security standards Possible values: 0 - Straddle: Straddle, Inc. is one of the fastest growing electronic payment ach processing companies in the world. The company is a venture-funded entity located in the Tampa Bay Florida area that offers payment-processing services to businesses in all 50 U.S. states. https://achq.com/about/ Value: 0
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAchProcessorDataDto) ACHQ specific information. Required if achProcessor is set.
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressMerchantPricingDto) Merchant pricing related data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/v1/boarding/applications/draft

Request samples

Payload
curl

{"businessInformation": {"mccCodeAliasId": "ac77ae78-04a5-4477-a958-5b153f233d12",
"detailedExplanationWhatDoYouSell": "Hardware store",
"merchantType": 0,
"dbaName": "string",
"legalName": "string",
"webSite": "https://risewithaurora.com",
"businessPhone": "+17701234567",
"customerServicePhone": "+17701234567",
"businessEmail": "test@gmail.com",
"isMerchantOptsOutOfReceivingFutureCommercialFromAmex": false,
"typeOfBusiness": 0,
"businessEstablishedDate": "2019-08-24T14:15:22Z",
"taxId": "20-1234567",
"documentationMailingAddress": 0,
"swiped": 100,
"keyed": 100,
"eCommerce": 100,
"desiredLimits": {"monthlyVMCD": 0,
"avgTicketVMCD": 0,
"highTicketVMCD": 0,
"monthlyAMEX": 0,
"avgTicketAMEX": 0,
"highTicketAMEX": 0
},
"sellingOutsideOfUS": true,
"siteInspectionType": 0,
"bankInfo": {"routing": "123456789",
"bank": "TEXAS BANK AND TRUST",
"account": "752111",
"accountName": "TEST LLC"
}
},
"locationAddress": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st",
"typeOfLocation": 0,
"locationIfOther": "string"
},
"isLegalAddressTheSame": true,
"legalAddress": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"owner1": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"owner2": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"owner3": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"owner4": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"authorizedSigner": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
}
},
"isPrimaryContactTheSame": true,
"primaryContact": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com"
},
"achProcessor": 0,
"achProcessorData": {"monthlyVolumeACH": 0,
"monthlyVolumeACHPayouts": 0,
"highTicketACH": 0,
"highTicketACHPayouts": 0,
"ticketCountACH": 0,
"ticketCountACHPayouts": 0,
"customerType": 0,
"paymentAuthorizationType": 0,
"statementDescriptor": "string",
"useOfPaymentServiceDescription": "string",
"billingRouting": "123456789",
"billingBank": "TEXAS BANK AND TRUST",
"billingAccount": "752111",
"billingAccountName": "TEST LLC"
},
"merchantPricing": {"zcpMode": 1,
"zcpRatePercentage": 0,
"useCardBrandFees": true,
"voyager": {"qualifiedFee": 1,
"otherItemRate": 0.5
},
"wex": {"qualifiedFee": 3,
"otherItemRate": 2.1
},
"additionalFees": {"authorizationFee": 0.25,
"avsFee": 0.1,
"voiceAuthFee": 0.5,
"aruFee": 0.2,
"voiceAvsFee": 0.15,
"batchSettlementFee": 1,
"salesTransactionFee": 0.3,
"otherVolumePercentage": 1.75,
"otherItemFee": 5,
"returnTransactionFee": 2.5,
"applicationFee": 50,
"annualFee": 99,
"earlyTerminationFee": 250,
"monthAnnualFeeBilled": 12
},
"achDeposit": {"discountType": 0,
"discountBillingType": 0
},
"monthlyFees": {"customerServiceFee": 15,
"onlineReportingFee": 10,
"regulatoryProductFee": 7.5,
"softwareFee": 12,
"wirelessFee": 20,
"statementFee": 5,
"equipmentFee": 18
},
"conditionalMonthlyFees": {"monthlyMinimumFee": 10,
"tinInvalidFee": 30,
"achRejectFee": 15,
"chargebackFee": 25,
"retrievalFee": 5
},
"pciFees": {"complianceFee": 25,
"nonComplianceFee": 50,
"billingFrequency": 0,
"tsysMonthAnnualFeeBilled": 6,
"fiservMonthAnnualFeeBilled": 0
},
"ebt": {"accountNumber": "987654321",
"cashPerItemFee": 1,
"foodPerItemFee": 0.5
},
"pinDebit": {"enabled": true,
"pinDebitSponsorship": false,
"monthlyAccessFee": 5,
"authorizationFee": 0.25,
"otherVolumeFeePercentage": 2.5
},
"amexFees": {"processingType": 0,
"existingEsaNumber": "123456",
"otherItemFee": 2,
"otherVolumeFeePercentage": 5
},
"miscellaneousFees": [{"type": 0,
"monthAnnualFeeBilled": 3,
"amount": 122,
"percentage": 3,
"startDate": "2025-06-20T00:00:00Z",
"endDate": "2025-07-20T00:00:00Z",
"description": "Monthly maintenance fee"
}
]
}
}

Response samples

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Update Draft Application

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Request Body schema:
application/json

	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressBusinessInformationDto)
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressLocationAddressDto) Location Address. Refers to a physical place or establishment where a business conducts its commercial activities, accepts payments, and provides goods or services to customers
isLegalAddressTheSame	boolean Is legal address the same
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAddressDto) Location Address. Required if not the same as Location Address. The official address of a business or individual as recognized and recorded by legal and governmental authorities. Typically used for legal and official purposes, including government correspondence, regulatory compliance, tax filings, and other formal documentation
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) Details about the individual or individuals who own and operate a business
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAuthorizedSignerDto) Authorized Signer
isPrimaryContactTheSame	boolean Is Primary Contact the same as the Owner 1?
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressPrimaryContactDto) Primary Contact. Required if not the same as Owner 1. The primary contact of a business is the individual who serves as the main point of contact for communication and coordination.Examples: Owner/Founder, CEO(Chief Executive Officer), Managing Director, Business Development Manager, Customer Service Manager, Sales Manager, Public Relations Officer, Office Manager, Marketing Manager, Project Manager
achProcessor	integer <int32> (ACHProcessorDto) Aurora Partner that securely manages and facilitates electronic financial ACH transactions between buyers and sellers, ensuring the efficient transfer of funds and compliance with security standards Possible values: 0 - Straddle: Straddle, Inc. is one of the fastest growing electronic payment ach processing companies in the world. The company is a venture-funded entity located in the Tampa Bay Florida area that offers payment-processing services to businesses in all 50 U.S. states. https://achq.com/about/ Value: 0
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAchProcessorDataDto) ACHQ specific information. Required if achProcessor is set.
	object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressMerchantPricingDto) Merchant pricing related data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

put/v1/boarding/applications/{applicationId}/draft

Request samples

Payload
curl

{"businessInformation": {"mccCodeAliasId": "ac77ae78-04a5-4477-a958-5b153f233d12",
"detailedExplanationWhatDoYouSell": "Hardware store",
"merchantType": 0,
"dbaName": "string",
"legalName": "string",
"webSite": "https://risewithaurora.com",
"businessPhone": "+17701234567",
"customerServicePhone": "+17701234567",
"businessEmail": "test@gmail.com",
"isMerchantOptsOutOfReceivingFutureCommercialFromAmex": false,
"typeOfBusiness": 0,
"businessEstablishedDate": "2019-08-24T14:15:22Z",
"taxId": "20-1234567",
"documentationMailingAddress": 0,
"swiped": 100,
"keyed": 100,
"eCommerce": 100,
"desiredLimits": {"monthlyVMCD": 0,
"avgTicketVMCD": 0,
"highTicketVMCD": 0,
"monthlyAMEX": 0,
"avgTicketAMEX": 0,
"highTicketAMEX": 0
},
"sellingOutsideOfUS": true,
"siteInspectionType": 0,
"bankInfo": {"routing": "123456789",
"bank": "TEXAS BANK AND TRUST",
"account": "752111",
"accountName": "TEST LLC"
}
},
"locationAddress": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st",
"typeOfLocation": 0,
"locationIfOther": "string"
},
"isLegalAddressTheSame": true,
"legalAddress": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"owner1": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"owner2": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"owner3": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"owner4": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"ownership": 0
},
"authorizedSigner": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
}
},
"isPrimaryContactTheSame": true,
"primaryContact": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com"
},
"achProcessor": 0,
"achProcessorData": {"monthlyVolumeACH": 0,
"monthlyVolumeACHPayouts": 0,
"highTicketACH": 0,
"highTicketACHPayouts": 0,
"ticketCountACH": 0,
"ticketCountACHPayouts": 0,
"customerType": 0,
"paymentAuthorizationType": 0,
"statementDescriptor": "string",
"useOfPaymentServiceDescription": "string",
"billingRouting": "123456789",
"billingBank": "TEXAS BANK AND TRUST",
"billingAccount": "752111",
"billingAccountName": "TEST LLC"
},
"merchantPricing": {"zcpMode": 1,
"zcpRatePercentage": 0,
"useCardBrandFees": true,
"voyager": {"qualifiedFee": 1,
"otherItemRate": 0.5
},
"wex": {"qualifiedFee": 3,
"otherItemRate": 2.1
},
"additionalFees": {"authorizationFee": 0.25,
"avsFee": 0.1,
"voiceAuthFee": 0.5,
"aruFee": 0.2,
"voiceAvsFee": 0.15,
"batchSettlementFee": 1,
"salesTransactionFee": 0.3,
"otherVolumePercentage": 1.75,
"otherItemFee": 5,
"returnTransactionFee": 2.5,
"applicationFee": 50,
"annualFee": 99,
"earlyTerminationFee": 250,
"monthAnnualFeeBilled": 12
},
"achDeposit": {"discountType": 0,
"discountBillingType": 0
},
"monthlyFees": {"customerServiceFee": 15,
"onlineReportingFee": 10,
"regulatoryProductFee": 7.5,
"softwareFee": 12,
"wirelessFee": 20,
"statementFee": 5,
"equipmentFee": 18
},
"conditionalMonthlyFees": {"monthlyMinimumFee": 10,
"tinInvalidFee": 30,
"achRejectFee": 15,
"chargebackFee": 25,
"retrievalFee": 5
},
"pciFees": {"complianceFee": 25,
"nonComplianceFee": 50,
"billingFrequency": 0,
"tsysMonthAnnualFeeBilled": 6,
"fiservMonthAnnualFeeBilled": 0
},
"ebt": {"accountNumber": "987654321",
"cashPerItemFee": 1,
"foodPerItemFee": 0.5
},
"pinDebit": {"enabled": true,
"pinDebitSponsorship": false,
"monthlyAccessFee": 5,
"authorizationFee": 0.25,
"otherVolumeFeePercentage": 2.5
},
"amexFees": {"processingType": 0,
"existingEsaNumber": "123456",
"otherItemFee": 2,
"otherVolumeFeePercentage": 5
},
"miscellaneousFees": [{"type": 0,
"monthAnnualFeeBilled": 3,
"amount": 122,
"percentage": 3,
"startDate": "2025-06-20T00:00:00Z",
"endDate": "2025-07-20T00:00:00Z",
"description": "Monthly maintenance fee"
}
]
}
}

Response samples

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get Application Information.

Utilize this request to retrieve information about the application by providing the application ID

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

get/v1/boarding/applications/{applicationId}

Request samples

curl

Response samples

application/json

{"businessInformation": {"mccCodeAliasId": "ac77ae78-04a5-4477-a958-5b153f233d12",
"detailedExplanationWhatDoYouSell": "Hardware store",
"dbaName": "Market",
"legalName": "Market INC",
"webSite": "https://risewithaurora.com",
"businessPhone": "+17701234567",
"customerServicePhone": "+17701234567",
"businessEmail": "test@gmail.com",
"isMerchantOptsOutOfReceivingFutureCommercialFromAmex": false,
"typeOfBusiness": 0,
"businessEstablishedDate": "10/10/2022",
"taxId": "201234567",
"documentationMailingAddress": 0,
"swiped": 20,
"keyed": 20,
"eCommerce": 60,
"desiredLimits": {"monthlyVMCD": 20000,
"avgTicketVMCD": 100,
"highTicketVMCD": 5000,
"monthlyAMEX": 20000,
"avgTicketAMEX": 100,
"highTicketAMEX": 5000
},
"siteInspectionType": 0,
"bankInfo": {"routing": "123456789",
"bank": "TEXAS BANK AND TRUST",
"account": "752111",
"accountName": "TEST LLC"
}
},
"locationAddress": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US",
"typeOfLocation": 0,
"locationIfOther": "string"
},
"isLegalAddressTheSame": false,
"legalAddress": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"owner1": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"owner2": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"owner3": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"owner4": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"ownership": 25
},
"authorizedSigner": {"firstName": "Brian",
"lastName": "Harm",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com",
"ssn": "111223333",
"dateOfBirth": "10/10/1996",
"address": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
}
},
"isPrimaryContactTheSame": true,
"primaryContact": {"firstName": "Brian",
"lastName": "Tran",
"title": "Founder",
"phoneNumber": "+17701234567",
"email": "test@gmail.com"
},
"achProcessor": 0,
"achProcessorData": {"monthlyVolumeACH": 1,
"monthlyVolumeACHPayouts": 1,
"highTicketACH": 1,
"highTicketACHPayouts": 1,
"ticketCountACH": 1,
"ticketCountACHPayouts": 1,
"customerType": 0,
"paymentAuthorizationType": 0,
"statementDescriptor": "string",
"useOfPaymentServiceDescription": "string",
"billingRouting": "123456789",
"billingBank": "TEXAS BANK AND TRUST",
"billingAccount": "752111",
"billingAccountName": "TEST LLC",
"achBoardingStatus": 0
},
"applicationId": null,
"createdAt": "2019-08-24T14:15:22Z",
"applicationStatus": 1,
"mid": "string",
"applicationStatusName": "string",
"primaryAgent": {"firstName": "string",
"lastName": "string"
}
}

Soft delete Application

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Responses

204

No Content

401

Unauthorized

403

Forbidden

409

Conflict

delete/v1/boarding/applications/{applicationId}

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get Applications listing

SecurityJWT

Request

query Parameters

pageIndex	integer <int32> Default: 0 Current index of the paging
pageSize	integer <int32> Default: 20 Size of one page

Responses

200

401

Unauthorized

get/v1/boarding/applications

Request samples

curl

Response samples

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mid": "string",
"dbaName": "string",
"merchantStatus": "string",
"processor": "string",
"sponsor": "string",
"agentOffice": {"name": "string"
},
"agent": {"firstName": "string",
"lastName": "string"
},
"applicationStatus": 1,
"applicationStatusName": "string",
"applicationStatusStartedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"count": 0
}

Get url for signing

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Responses

200

401

Unauthorized

403

Forbidden

409

Conflict

get/v1/boarding/applications/{applicationId}/url-for-signing

Request samples

curl

Response samples

application/json

"string"

➔ Next to BoardingConfigurations

Boarding

Submit Application

Request Body schema: application/jsonapplication/json-patch+jsonapplication/json

Submit Draft Application

path Parameters

Create Draft Application

Request Body schema: application/jsonapplication/json-patch+jsonapplication/json

Update Draft Application

path Parameters

Request Body schema: application/jsonapplication/json-patch+jsonapplication/json

Get Application Information.

path Parameters

Soft delete Application

path Parameters

Get Applications listing

query Parameters

Get url for signing

path Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json