Create a new application
This endpoint allows for the submission of onboarding applications
Request
Endpoint
environment | HTTP method | endpoint |
---|---|---|
Sandbox testing | POST | https://api-sandbox.flex-charge.com/v1/onboarding/application |
Production environment | POST | https://api.flex-charge.com/v1/onboarding/application |
Required key
bearer token | The auth token returned by /oauth2/token |
body fields
The following table provides an overview of the objects and fields used in the payloads:
Object / Field | Type | Description |
---|---|---|
LegalEntityName | String | The registered legal name of the business. |
Dba | String | The "Doing Business As" name, if different from the legal name. |
PrimaryContact | Object | Details of the primary contact person for the application. |
- FirstName | String | First name of the contact person. |
- LastName | String | Last name of the contact person. |
- Email | String | Email address of the contact person. |
- Phone | String | Phone number of the contact person. |
TaxId | String | The tax identification number of the business. |
Descriptor | String | The billing descriptor displayed on customers' statements. |
CustomerSupportInformation | Object | Details for customer support. |
- SupportLink | String | URL for the support website. |
- SupportEmail | String | Email address for customer support. |
- SupportName | String | Name of the customer support team or department. |
- SupportPhone | String | Phone number for customer support. |
BankAccountInformation | Object | Banking details for payout purposes. |
- BankName | String | Name of the bank. |
- AccountNumber | String | Bank account number. |
- RoutingNumber | String | Routing number for the bank. |
- AccountType | String | Type of bank account (e.g., "Checking"). |
Address | Object | Business address details. |
- AddressLine1 | String | The primary address line. |
- AddressLine2 | String | Additional address details (e.g., suite, floor). |
- City | String | City of the business address. |
- Zipcode | String | Postal code of the business address. |
- Country | String | Country of the business address. |
- State | String | State of the business address. |
Owners / OwnersInformation | Array | Array of owner objects detailing individuals with ownership in the business. |
- Title | String | Role or title of the owner (e.g., "Founder"). |
- PrincipalType | String | Type of principal (e.g., "Individual", "Entity"). |
- FirstName | String | First name of the owner. |
- LastName | String | Last name of the owner. |
- DateOfBirth | String | Date of birth of the owner (YYYY-MM-DD format). |
- Email | String | Email address of the owner. |
- Phone | String | Phone number of the owner. |
- PercentOwnership | String | Percentage ownership of the business. |
- IndividualFormOfID | String | Type of identification (e.g., "Passport"). |
- IDNumber | String | Identification number. |
- OwnerAddressInformation | Object | Address details of the owner. |
BusinessModel | Object | Details about the industry and business operations. |
ProductInformation | Object | Details about the products and services offered. |
VolumeEstimates | Object | Estimated transaction volume and related metrics. |
Response
Application Object
Attribute | Type | Description |
---|---|---|
id | String | The unique identifier of the application. |
status | String | The current status of the application (Draft , Submitted , Approved ). |
createdOn | Date | The date and time the application was created. |
lastUpdatedOn | Date | The date and time the application was last updated. |
errors | Array | Any errors or issues encountered during processing. |
Payload examples
Request
{
"LegalEntityName": "Example Corporation",
"Dba": "Example Corp DBA",
"PrimaryContact": {
"FirstName": "Alice",
"LastName": "Smith",
"Email": "[email protected]",
"Phone": "+11234567890"
},
"TaxId": "987654321",
"Descriptor": "EXAMPLECORP",
"CustomerSupportInformation": {
"SupportLink": "https://support.example.com",
"SupportEmail": "[email protected]",
"SupportName": "Customer Support Team",
"SupportPhone": "+10123456789"
},
"BankAccountInformation": {
"BankName": "Example Bank",
"AccountNumber": "123456789",
"RoutingNumber": "021000021",
"AccountType": "Checking"
},
"Address": {
"AddressLine1": "456 Sample Avenue",
"AddressLine2": "Floor 2",
"City": "Sample City",
"Zipcode": "12345",
"Country": "United States",
"State": "NY"
},
"Owners": [
{
"Title": "Founder",
"PrincipalType": "Individual",
"FirstName": "Bob",
"LastName": "Johnson",
"DateOfBirth": "1975-05-15",
"Email": "[email protected]",
"Phone": "+10987654321",
"PercentOwnership": "100%",
"IndividualFormOfID": "Passport",
"IDNumber": "A12345678",
"OwnerAddressInformation": {
"AddressLine1": "789 Owner Lane",
"AddressLine2": "Apt 101",
"Country": "United States",
"State": "NY",
"City": "Owner City",
"Zipcode": "67890"
}
}
]
}
{
"LegalEntityName": "Tech Innovations Ltd.",
"Dba": "Tech Innovators",
"TaxId": "456789123",
"CompanyInUS": true,
"BusinessType": "LLC",
"EcommercePlatform": "-",
"EstablishedDate": "-",
"MCC": "5045",
"Descriptor": "TECH INNOV",
"WebsiteUrl": "https://www.techinnovations.com",
"Description": "-",
"PCIDSS": null,
"CustomerSupportInformation": {
"Name": "Customer Support Team",
"SupportLink": "https://support.examplecorp.com",
"Email": "[email protected]",
"Phone": "+10123456789"
},
"BankInformation": {
"DDA": "-",
"AccountNumber": "123456789",
"RoutingNumber": "021000021",
"BankName": "Example Bank"
},
"Address": {
"AddressLine1": "456 Elm St",
"AddressLine2": "Building B",
"City": "New York",
"Zipcode": "10001",
"Country": "United States",
"State": "NY"
},
"OwnersInformation": [
{
"Title": "Founder",
"PrincipalType": "Individual",
"FirstName": "Alice",
"LastName": "Smith",
"DateOfBirth": "1975-05-15",
"Email": "[email protected]",
"Phone": "+11234567890",
"PercentOwnership": "100%",
"IndividualFormOfID": "Passport",
"IDNumber": "A12345678",
"OwnerAddressInformation": {
"AddressLine1": "789 Owner Lane",
"AddressLine2": "Apt 101",
"Country": "United States",
"State": "NY",
"City": "Owner City",
"Zipcode": "67890"
}
}
],
"BusinessModel": {
"Industry": "Technology, Software, Electronics",
"UrlsForFlexProcessing": [
"https://www.examplecorp.com/shop",
"https://checkout.examplecorp.com",
"https://payments.examplecorp.com/transactions"
]
},
"ProductInformation": {
"MainSourcesOfCustomerAcquisition": [
"Paid Search",
"Social Media",
"Email",
"Partnerships / Collaborations",
"In Person Marketing"
],
"MaxSubscriptionDuration": "60 Days",
"TrialPeriod": "7-14 Days",
"DeliveryTime": "5-7 Days",
"ProductsSold": "Tangible",
"RegulatedBusiness": false,
"HealthcareRelated": false
},
"ContactInformation": {
"FirstName": "Bob",
"LastName": "Johnson",
"Email": "[email protected]",
"Phone": "+10987654321"
},
"VolumeEstimates": {
"AverageMonthlySalesVolumes": "$100K-$500K",
"AverageMonthlyDeclineRate": "5%-10%",
"AverageTransactionAmount": "$100-$200",
"AverageReturnRate": "2% - 5%",
"AverageChargebackRate": "0.5%-1%",
"AverageDisputeRate": "0.5%-1%"
}
}
Response
{
"id": "application_123456",
"status": "Submitted",
"createdOn": "2024-11-15T10:30:00Z",
"lastUpdatedOn": "2024-11-16T12:00:00Z",
"merchantId": "merchant_78901",
"errors": []
}
Updated 1 day ago