v1
latestOpenAPI 3.1.02026-07-132363652.9 MBOnboarding
Update onboarding status for a merchant with a specific provider. Use 'enrolling' to start enrollment or 'onboarded' to complete it.
Update onboarding status for a merchant with a specific provider. Use 'enrolling' to start enrollment or 'onboarded' to complete it.
put/api/v1/merchants/{merchantId}/onboarding/{provider}/status
Path parameters
merchantIdstring uuid required
The unique identifier of the merchant
Example:123e4567-e89b-12d3-a456-426614174000
The unique identifier of the merchant
providerstring required
The provider name
Example:transfermate
The provider name
Request body
Response
Success
Example response
{
"success": true,
"data": {
"provider": "quidkey",
"requirements": [
{
"code": "LEGAL_ENTITY_EXISTS",
"label": "Legal entity attached",
"met": true,
"blocker": "Merchant must have a legal entity",
"problems": [
{
"field": "company_name",
"message": "Company name is required"
}
]
}
],
"depends_on": [
{
"provider": "quidkey",
"satisfied": true
}
]
}
}