Update an Application

Path Params
string
required

ID of the application

Body Params
string

External Id from your system

boolean

Determines wether or not to create a user for the principals in the merchant application so they can have access to the payments portal. This setting can only be updated to True. We also recommend sending this property when replacing the current list of principals

coreBusinessInfo
object

Core business information

processingEstimates
object

Credit card processing volume estimates

achProcessingInformation
object

ACH processing volume estimates and other Information. Only required the onborading template used has ACH as an assigned payment method

bankingInformation
object

Banking information for transaction settlement/deposits

businessPrincipals
array of objects

Array of Business Principals. IMPORTANT: To update a principal record you must send the "id" property. If you do not send it, a new principal record will be created and the previous one will be replaced

businessPrincipals
paymentMethods
object

Payment Methods percentages information. The sum of its properties (onlinePaymentsPercentage, inStorePaymentsPercentage, keyedInPaymentsPercentage) must equal 100.

motoQuestionnaire
object

Moto Questionnaire. Only required when either paymentMethods.onlinePaymentsPercentage > 0 or paymentMethods.keyedInPaymentsPercentage > 0

processingEquipment
object

Object containing the physical equipment (terminals), payment gateways and/or online payment systems that the merchant will use

securityInfo
object

Object containing the merchant answers to security related questions

string
enum

When granting portal access to the users to leverage our hosted onboarding solution, this property allows you to set the current onboarding step/page that the merchant will be when he/she logs in. When not set, this property defaults to "BUSINESS_DETAILS". The most commonly used values are "business_details" (i.e. first onboarding page), "application_summary" (i.e. summary page), and "agreement_acceptance" (i.e. last onboarding page)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json