Skip to main content
POST
Update a submerchant

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
subMerchantId
string
required

Submerchant identifier

Example:

"854738f390"

services
object

Optional. The services this merchant is applying to process.

Omit services to leave the current selection unchanged. If you send it, it replaces the current selection, so include both card and ach with the full intended selection — enabled: false for a service the merchant is not applying for.

The same rules as on create apply: enable at least one service, and only services enabled on the service provider product. Violations are rejected with provisioning_no_service_selected or provisioning_service_not_available.

identity
object

Identity details for the business and its owners.

payoutBankAccounts
object[]

Bank accounts where the merchant receives payouts.

feesTemplateId
string<uuid> | null

UUID of a fees template with predefined pricing. If omitted, the default template is used.

Example:

"415dd627-006f-4477-a2eb-47c6eb7a4534"

Response

200 - application/json

Submerchant updated successfully

code
string

Machine-readable result code. See the Error Codes reference.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

message
string

Human-readable result message.

data
object

The response payload.