Sign in
Merchant Applications

Update merchant application

Update a merchant application. Only fields included in the payload will be updated. Omitted fields will not be updated. To remove a field, set the value to null.

patch/v1/merchants/{merchant_id}/applications/{merchant_application_id}

Parameters

#/paths/~1v1~1merchants/get/parameters/0 — unresolved $ref
#/paths/~1v1~1merchants~1%7Bmerchant_id%7D/get/parameters/1 — unresolved $ref
#/paths/~1v1~1merchants~1%7Bmerchant_id%7D~1applications~1%7Bmerchant_application_id%7D/get/parameters/2 — unresolved $ref

Request body

merchant_application_idMerchantApplicationId — unresolved $ref
merchant_idMerchantId — unresolved $ref
platform_idPlatformId — unresolved $ref
billing_profile_idstring

The unique billing profile identifier.

Prefix is "bpf" in production and "sbx_bpf" in sandbox.

namestring

The unique identifier for the merchant business name.

dba_namestring

The merchant’s public-facing name. This may be the same as the legal name if the merchant does not operate under a different name.

legal_namestring

The merchant legal registered business name.

merchant_type'INDIVIDUAL' | 'LLC' | 'LLP' | 'PARTNERSHIP' | 'PRIVATE_CORPORATION' | 'PUBLIC_CORPORATION' | 'NON_PROFIT_ORG' | 'GOVERNMENT'

The merchant's type of business.

mccstring

The merchant category code.

mcc_descstring

The merchant category code description.

emailstring

The merchant business email.

websitestring

The merchant website. Must begin with http:// or https://

{"stackTrail":"paths:/v1/merchants/{merchant_id}/applications/{merchant_application_id}:patch:requestBody:content:application/json:schema:properties:website_validation_disabled","oasType":"schema","type":"unknown","description":"Boolean indicating if website validation should be disabled."}
phone_numberstring

The merchant phone number, including extension.

average_ticketinteger

The merchant average ticket amount, in USD minor units.

For example, 1000 is 10.00 USD.

high_ticketinteger

The merchant high ticket amount, in USD minor units.

For example, 1000 is 10.00 USD.

average_monthly_volumeinteger

The merchant average monthly volume amount, in USD minor units.

For example, 1000 is 10.00 USD.

encrypted_tax_idstring

The merchant tax ID, encrypted with RSA-OAEP-SHA256. Required for all merchant types except for INDIVIDUAL.

tax_id_last_4string

The last 4 digits of the merchant tax ID. Required for all merchant types except for INDIVIDUAL.

no_owner_has_25_percentboolean nullable

Indicates that no owner holds 25% or more ownership of the merchant. When set to true, owner ownership percentages are not required to be 25% or greater.

owner_2Owner1 — unresolved $ref
owner_3Owner1 — unresolved $ref
owner_4Owner1 — unresolved $ref
billing_frequencyBillingFrequency — unresolved $ref
billing_typeBillingType — unresolved $ref
deposit_frequencyDepositFrequency — unresolved $ref
card_release_delay_daysCardReleaseDelayDays — unresolved $ref
ach_release_delay_daysAchReleaseDelayDays — unresolved $ref
validated_ach_release_delay_daysValidatedAchReleaseDelayDays — unresolved $ref
balance_checked_ach_release_delay_daysBalanceCheckedAchReleaseDelayDays — unresolved $ref
allowed_payment_method_typesstring[]

The allowed payment method types available for processing.

deposit_routesobject

Object with key names that correspond to the purpose of deposit method.

For example, the deposit route for the PAYMENTS key represents the deposit method being used for the merchant's funding deposits. The deposit route for the BILLING key represents the deposit method being used for the merchant's billing deposits, only applicable for merchants on gross billing.

statusItems — unresolved $ref
created_atstring date-time

Date and time merchant application was created at in UTC RFC 3339 format.

updated_atstring date-time

Date and time merchant application was last updated at in UTC RFC 3339 format.

submitted_atstring date-time

Date and time merchant application was submitted at for approval in UTC RFC 3339 format.

in_review_atstring date-time

Date and time merchant application was moved to in review in UTC RFC 3339 format.

declined_atstring date-time

Date and time merchant application was declined in UTC RFC 3339 format.

approved_atstring date-time

Date and time merchant application was approved in UTC RFC 3339 format.

needs_information_atstring date-time

Date and time merchant application was set to require additional information UTC RFC 3339 format.

resubmitted_atstring date-time

Date and time merchant application was resubmitted after requiring additional information UTC RFC 3339 format.

Response

OK

statusStatus — unresolved $ref
dataSchema — unresolved $ref
errorsErrors — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.