Edit an application

This endpoint allows for editing an existing application identified by its unique ID ({id}). The request payload can update specific fields within the application, such as contact details, business information, or bank account details.

Use this API in your onboarding flow to update application data during the review or correction process.

Request
Response
Payload examples

Request

Endpoint

environment	HTTP method	endpoint
Sandbox testing	PUT	https://api-sandbox.flex-charge.com/v1/onboarding/application/{id}
Production environment	PUT	https://api.flex-charge.com/v1/onboarding/application/{id}

Required Key

Field	Description
`id`	The unique ID of the application to be updated.
`bearer token`	The authentication token returned by `/oauth2/token` for authorizing the API request.

Request Body

The request payload should include only the fields to be updated. All fields must adhere to the data format described in the table below.

Field Name	Field Type	Field Explanation
`legalEntityName`	String	The legal name of the business entity.
`dba`	String	The "Doing Business As" name of the entity, if applicable.
`taxId`	String	The tax identification number of the business.
`descriptor`	String	The billing descriptor associated with the business.
`primaryContact`	Object	Object containing details of the primary contact person for the application.
- `firstName`	String	First name of the primary contact.
- `lastName`	String	Last name of the primary contact.
- `email`	String	Email address of the primary contact.
- `phone`	String	Phone number of the primary contact.
`customerSupportInfo`	Object	Object containing customer support details.
- `supportLink`	String	URL for the customer support website.
- `supportEmail`	String	Email address for customer support.
- `supportPhone`	String	Phone number for customer support.
`address`	Object	Business address associated with the application.
- `addressLine1`	String	The main address line.
- `addressLine2`	String	Additional address details (e.g., suite, floor).
- `city`	String	City of the business address.
- `state`	String	State of the business address.
- `zipcode`	String	Postal code of the business address.
- `country`	String	Country of the business address.
`owners`	Array of Objects	Array of owners with details about individuals with ownership in the business.
- `title`	String	Title or role of the owner (e.g., Founder, CEO).
- `percentOwnership`	String	Ownership percentage held by the owner.
- `idNumber`	String	Identification number provided by the owner.
`bankAccountInfo`	Object	Object containing bank account details for payouts.
- `bankName`	String	Name of the bank.
- `accountNumber`	String	Account number for the business.
- `routingNumber`	String	Routing number for the bank.
`businessModel`	Object	Details about the business model and operations.
`productInfo`	Object	Information about the products or services offered by the business.
`volumeEstimates`	Object	Estimated transaction volumes, chargebacks, and disputes for the business.

Response

Field Definitions

Field Name	Field Type	Field Explanation
`id`	String	The unique identifier of the updated application.
`status`	String	The current status of the application after the update.
`updatedFields`	Array	List of fields that were successfully updated.
`errors`	Array	Any validation errors or issues encountered during the update process.

Payload Examples

Request

cURL Request Example

curl --request PUT \
     --url https://api-sandbox.flex-charge.com/v1/application/{id} \
     --header 'Authorization: bearer {the token returned by /oauth2}' \
     --header 'Content-Type: application/json' \
     --data '{
       "primaryContact": {
         "firstName": "John",
         "lastName": "Doe",
         "email": "[email protected]",
         "phone": "+11234567890"
       },
       "customerSupportInfo": {
         "supportLink": "https://support.example.com",
         "supportEmail": "[email protected]",
         "supportPhone": "+10123456789"
       }
     }'

Response

Example for a Successful Update

{
  "id": "application_123456",
  "status": "Submitted",
  "updatedFields": [
    "primaryContact.firstName",
    "primaryContact.lastName",
    "primaryContact.email",
    "customerSupportInfo.supportPhone"
  ],
  "errors": []
}

Example for an Update with Errors

{
  "id": "application_123456",
  "status": "Submitted",
  "updatedFields": [
    "primaryContact.firstName",
    "primaryContact.lastName"
  ],
  "errors": [
    {
      "field": "primaryContact.email",
      "message": "Invalid email format."
    },
    {
      "field": "customerSupportInfo.supportPhone",
      "message": "Phone number is required."
    }
  ]
}

Updated 4 months ago