search

Get Status

Use this endpoint to retrieve the current state of a merchant onboarding application.

This applies to both:

  • Full applications created with POST /merchant-onboarding/applications

  • Minimal applications created with POST /merchant-onboarding/applications-short

Use this endpoint when you need to:

  • check the current onboarding status

  • determine whether the merchant has been boarded

  • retrieve the onboarded merchant record after approval

hashtag
Endpoint

GET /merchant-onboarding/applications/{applicationId}

Path parameter

  • applicationId — The onboarding application identifier returned when the application was created

hashtag
Authentication and headers

Onboarding requests use API key authentication.

X-Api-Key: {apiKey}
Accept: application/json

hashtag
Most important response fields

Start with these fields first:

  • id — The onboarding application identifier

  • merchantName — The merchant name associated with the application

  • status — Overall onboarding status for the application

  • onboardedMerchantId — The merchant identifier created after successful onboarding

These fields usually tell you whether the application is still in progress, needs attention, or is ready for downstream merchant setup and usage.

hashtag
Example request

hashtag
Example response

hashtag
How to use the response

A common pattern is:

  • use status to understand the overall application state

  • use onboardedMerchantId once the merchant is successfully boarded

  • use merchantName and id for display, support, and reconciliation workflows

hashtag
Full schema reference

For the complete response model and all available fields, refer to the OpenAPI spec and schema definitions in the Reference Guide.

Use the spec when you need details beyond the primary operational fields.

hashtag
Related pages

PreviousSubmit ApplicationNextResend Application

Last updated