MVS Pay APIMerchants

Onboard a merchant

Creates a merchant, auto-provisions an NMI connector + single→NMI routing (best-effort), and completes a deferred Plaid bank vault if supplied. Idempotent on idempotencyKey.

Authentication

x-api-keystring

A scoped MvsPayApiKey, e.g. mvspay_live_…. Mint and scope keys from the dashboard (Settings → API Keys).

Headers

Idempotency-KeystringOptional

Request

This endpoint expects an object.
idempotencyKeystringOptional
merchantIdstringOptional

Caller-supplied Hyperswitch merchant id; minted if omitted.

merchantNamestringOptional
displayNamestringOptional
businessmap from strings to anyOptional
ownermap from strings to anyOptional
bankAccountmap from strings to anyOptional

If it carries a payoutMethodId, the deferred Plaid bank vault is completed against the new merchant.

identityDocsmap from strings to anyOptional
metadatamap from strings to anyOptional

Response

The onboarded merchant.
mvs_extensionmap from strings to any
remediationmap from strings to any
connectorProvisionedboolean
bankVaultedboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
502
Bad Gateway Error