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.SubmitAuthorizedSignerDto)

isPrimaryContactTheSame

boolean

Is Primary Contact the same as the Owner 1?

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitPrimaryContactDto)

achProcessor

string (RiseCRM.ExternalApi.HttpClient.Dto.v1.Enum.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

straddle

Value	Description
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/

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",
"isMerchantOptsOutReceivingFutureCommercialFromAmex": false,
"typeOfBusiness": "soleProprietor",
"businessEstablishedDate": "10/10/2022",
"taxId": "201234567",
"documentationMailingAddress": "legalAddress",
"swiped": 20,
"keyed": 20,
"e-commerce": 60,
"desiredLimits": {"monthlyVMcD": 20000,
"avgTicketVMcD": 100,
"highTicketVMcD": 5000,
"monthlyAmex": 20000,
"avgTicketAmex": 100,
"highTicketAmex": 5000
},
"siteInspectionType": "aurora",
"bankInfo": {"routing": "123456789",
"bank": "TEXAS BANK AND TRUST",
"account": "752111",
"accountName": "TEST LLC"
}
},
"locationAddress": {"typeOfLocation": "home",
"locationIfOther": "string",
"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"isLegalAddressTheSame": false,
"legalAddress": {"addressLine1": "1025 Market Blvd, Ste 580",
"addressLine2": null,
"city": "CONCORD",
"regionCode": "NC",
"postalCode": "28020",
"countryCode": "US"
},
"owner1": {"ownership": 25,
"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"
}
},
"owner2": {"ownership": 25,
"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"
}
},
"owner3": {"ownership": 25,
"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"
}
},
"owner4": {"ownership": 25,
"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"
}
},
"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": "straddle",
"achProcessorData": {"monthlyVolumeAch": 1,
"monthlyVolumeAchPayouts": 1,
"highTicketAch": 1,
"highTicketAchPayouts": 1,
"ticketCountAch": 1,
"ticketCountAchPayouts": 1,
"customerType": "individuals",
"paymentAuthorizationType": "signedContractOrAgreement",
"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

string (RiseCRM.ExternalApi.HttpClient.Dto.v1.Enum.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

straddle

Value	Description
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/

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.Fees.SaveInProgressAdditionalFeesDto)

Additional Fees

Array of objects or null (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressMiscellaneousFeeDto)

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressAchDepositDto)

ACH deposit

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressMonthlyFeesDto)

Monthly fees

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressPciFeesDto)

PCI

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressEbtDto)

EBT / Cash Benefits

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressConditionalMonthlyFeesDto)

Conditional monthly fees

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressPinDebitDto)

Pin-Debit

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressVoyagerDto)

Voyager

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressWexDto)

WEX

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.Fees.SaveInProgressAmexFeesDto)

Amex

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": "new",
"dbaName": "string",
"legalName": "string",
"website": "https://risewithaurora.com",
"businessPhone": "+17701234567",
"customerServicePhone": "+17701234567",
"businessEmail": "test@gmail.com",
"isMerchantOptsOutReceivingFutureCommercialFromAmex": false,
"typeOfBusiness": "soleProprietor",
"businessEstablishedDate": "2019-08-24T14:15:22Z",
"taxId": "20-1234567",
"documentationMailingAddress": "legalAddress",
"swiped": 100,
"keyed": 100,
"e-commerce": 100,
"desiredLimits": {"monthlyVMcD": 0,
"avgTicketVMcD": 0,
"highTicketVMcD": 0,
"monthlyAmex": 0,
"avgTicketAmex": 0,
"highTicketAmex": 0
},
"sellingOutsideOfUs": true,
"siteInspectionType": "aurora",
"bankInfo": {"routing": "123456789",
"bank": "TEXAS BANK AND TRUST",
"account": "752111",
"accountName": "TEST LLC"
}
},
"locationAddress": {"typeOfLocation": "home",
"locationIfOther": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"isLegalAddressTheSame": true,
"legalAddress": {"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"regionCode": "strin",
"postalCode": "string",
"countryCode": "st"
},
"owner1": {"ownership": 0,
"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"
}
},
"owner2": {"ownership": 0,
"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"
}
},
"owner3": {"ownership": 0,
"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"
}
},
"owner4": {"ownership": 0,
"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"
}
},
"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": "straddle",
"achProcessorData": {"monthlyVolumeAch": 0,
"monthlyVolumeAchPayouts": 0,
"highTicketAch": 0,
"highTicketAchPayouts": 0,
"ticketCountAch": 0,
"ticketCountAchPayouts": 0,
"customerType": "individuals",
"paymentAuthorizationType": "signedContractOrAgreement",
"statementDescriptor": "string",
"useOfPaymentServiceDescription": "string",
"billingRouting": "123456789",
"billingBank": "TEXAS BANK AND TRUST",
"billingAccount": "752111",
"billingAccountName": "TEST LLC"
},
"additionalFees": {"authorizationFee": 0,
"avsFee": 0,
"aruFee": 0,
"batchSettlementFee": 0,
"otherItemFee": 0,
"salesTransactionFee": 0,
"voiceAuthFee": 0,
"voiceAvsFee": 0,
"otherVolumePercentage": 0,
"returnTransactionFee": 0,
"applicationFee": 0,
"annualFee": 0,
"earlyTerminationFee": 0,
"monthAnnualFeeBilled": 1
},
"miscellaneousFees": [{"type": "perItem",
"monthAnnualFeeBilled": 1,
"amount": 0,
"percentage": 100,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"description": "string"
}
],
"achDeposit": {"discountType": "individualOrDeposit",
"discountBillingType": "daily"
},
"monthlyFees": {"customerServiceFee": 0,
"regulatoryProductFee": 0,
"wirelessFee": 0,
"equipmentFee": 0,
"onlineReportingFee": 0,
"softwareFee": 0,
"statementFee": 0
},
"pciFees": {"complianceFee": 0,
"nonComplianceFee": 0,
"billingFrequency": "monthly",
"tsysMonthAnnualFeeBilled": 1,
"fiservMonthAnnualFeeBilled": "january"
},
"ebt": {"accountNumber": "string",
"cashPerItemFee": 0,
"foodPerItemFee": 0
},
"conditionalMonthlyFees": {"monthlyMinimumFee": 0,
"tinInvalidFee": 0,
"achRejectFee": 0,
"chargebackFee": 0,
"retrievalFee": 0
},
"pinDebit": {"enabled": true,
"pinDebitSponsorship": true,
"monthlyAccessFee": 0,
"otherVolumeFeePercentage": 1,
"authorizationFee": 0
},
"voyager": {"qualifiedFee": 0,
"otherItemRate": 0
},
"wex": {"qualifiedFee": 0,
"otherItemRate": 0
},
"amexFees": {"processingType": "optBlue",
"existingEsaNumber": "string",
"otherItemFee": 0,
"otherVolumeFeePercentage": 1
},
"merchantPricing": {"zcpMode": "none",
"zcpRatePercentage": 0,
"useCardBrandFees": true
}
}

Response samples

application/json

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

Update Draft Application