Get Merchant

Endpoint

GET /api/{merchantId}

Header parameters

Header	Type	Required	Description
Ocp-Apim-Subscription-Key	string	Yes	Your PaySuite subscription key

Response parameters

Status Code: 200 OK

Parameter	Type	Description
merchantId	uuid	A unique identifier for the customer created by the Merchant API.
customerId	string	A unique identifier for the customer in the SoftCo product.
sessionId	string	A unique identifier to track the session.
creditRisk	object	Object containing the status of the credit risk assessment.
→ workflowRuntimeId	string	The credit risk assessment identifier.
→ dataCapture	object	Object contining the status of the credit risk data capture.
→ status	string	The status of the credit risk data capture. This will return values Pending or Complete.
→ updatedDate	dateTime	The date and time of last modification.
→ cra	object	Object contining the status of the credit risk assessment.
→ status	string	The status of the credit risk data capture. This will return values Pending, Approved or Rejected.
→ updatedDate	dateTime	The date and time of last updated.
stripe	object	Object containing the status of Stripe KYC.
→ connectAccountId	string	The Stripe Connect identifier for the customer. This will be required during payment processing.
→ dataCapture	object	Object contining the status of the KYC data capture.
→ status	string	The status of the KYC data capture. This will return values Pending or Complete. Note, ongoing verification can trigger a change to the status that requires further action to provide updated information.
→ updatedDate	dateTime	The date and time of last updated.
→ kyc	object	Object contining the status of the KYC check.
→ status	string	The status of the KYC check. This will return values Pending, Active or Inactive. Note, the status can also return a null. This should be treated the same as Pending.
→ updatedDate	dateTime	The date and time of last updated.
→ paymentsEnabled	boolean	Indicates whether payments are enabled to be processed for the customer.
→ payoutsEnabled	boolean	Indicates whether payouts are enabled for funds to be settled into the customers account.

Payload example

{
  "merchantId": "e4f585be-5705-4e41-985e-4c0af3099887",
  "customerId": "customer_123",
  "sessionId": "66c0df2ec03d8a3b582e615b83274816",
  "creditRisk": {
    "merchantId": "cmcx47znh01wyob0k3skac3t4",
    "dataCapture": {
        "status": "Complete",
        "updatedDate": "2025-07-10T08:41:05.8070869"
    },
    "cra": {
        "status": "Approved",
        "updatedDate": "2025-07-10T08:41:05.8070889"
    }
  },
  "stripe": {
    "connectAccountId": "acct_12345",
    "dataCapture": {
        "status": "Complete",
        "updatedDate": "2025-07-10T08:41:26.0475293"
    },
    "kyc": {
        "status": "Active",
        "updatedDate": "2025-07-10T08:41:26.0475299",
        "paymentsEnabled": true,
        "payoutsEnabled": true
    }
  }
}

Payload statuses

Credit Risk Data Capture Status

The creditRisk.dataCapture.status field can contain the following values.

Status	Description
Pending	Credit risk information has not yet been completed
Complete	Credit risk information has been fully captured

Credit Risk Assessment Status

The creditRisk.cra.status field can contain the following values.

Status	Description
Pending	Credit risk assessment not yet performed
Approved	Credit risk assessment approved
Rejected	Credit risk assessment rejected

Credit Risk Status Combination Interpretation

The overall credit risk state is determined by the combination of creditRisk.dataCapture.status and creditRisk.cra.status.

creditRisk.dataCapture.status	creditRisk.cra.status	Description
Pending	Pending	Information not yet filled in
Complete	Pending	Waiting for credit risk assessment
Complete	Approved	Credit risk assessment approved
Complete	Rejected	Credit risk assessment rejected

Note: creditRisk.cra.status should only transition to Approved or Rejected once creditRisk.dataCapture.status is Complete.

Stripe Data Capture Status

The stripe.dataCapture.status field can contain the following values.

Status	Description
Pending	Stripe data capture not started or not completed
Complete	Stripe data capture completed

Stripe KYC Status

The stripe.kyc.status field can contain the following values.

Status	Description
Pending or null	KYC verification not yet completed
Active	The account is active for payment processing and payouts
Inactive	The account is not active for payment processing

Payload handling

The SoftCo product should handle the webhook payload as follows. The data returned will help to answer the following questions.

Is data capture pending?

When a customer begins onboarding, the status of data capture will be Pending, indicating that the customer must provide information before payment processing can be enabled.

There are two data capture status fields that indicate the stage of onboarding

• creditRisk.dataCapture.status
• stripe.dataCapture.status

If either field is Pending, then the SoftCo product must perform an API request to the PUT endpoint. The response will return the next action to be performed in order to complete data capture.

If both fields are Complete, then no further information is required from the customer at this stage. Note: the status may change later.

Are payments enabled?

Before enabling payment processing in the SoftCo product for the customer, the status of credit risk assessment and know-your-customer must be verified.

The following fields will indicate the statuses

• creditRisk.cra.status - must be Approved
• stripe.kyc.status - must be Active

If both fields are not as set as above, then payments must be prevented.

Is the customer rejected?

On some occasions, the risk of onboarding a customer may be too high and therefore rejected from onboarding onto the platform.

The following fields will indicate the status

• creditRisk.cra.status - must be Rejected

There will be no further indication identifying the reason for rejection. This will be communicated to the customer via Risk & Compliance.

Timestamp Format

All timestamps use ISO 8601 format with UTC timezone:

• Format: YYYY-MM-DDTHH:mm:ssZ
• Example: 2024-01-16T14:30:00Z