Get Merchant

Retrieve the current onboarding status and payment processing capabilities for a specific merchant.

Endpoint

GET /api/v2/merchants/{merchantId}

Request

Headers

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

Path Parameters

Parameter	Type	Required	Description
merchantId	uuid	Yes	Unique merchant identifier

Response

Success Response (200 OK)

Parameter	Type	Description
divisionAccountId	string	SoftCo division identifier
merchantId	uuid	Unique merchant identifier
customerId	string	Customer identifier in SoftCo system
legalName	string	Resolved legal name of the merchant. For SoleProprietorship returns "firstName lastName", for Organisation returns the legal name.
traceId	string	Request trace identifier
creditRisk	object	Credit risk assessment status - see Credit Risk Object
stripe	object	Stripe KYC status. See Stripe Object
evo	object	EVO integration details - see Evo Object

Credit Risk Object

Parameter	Type	Description
merchantId	string	Identifier used internally for credit risk tracking. Note: in the GET response, this value is populated from the workflow runtime ID.
dataCapture	object	Data capture status
→ status	string	Data capture status: Pending or Completed
→ updatedDate	dateTime	Last update timestamp
cra	object	Credit risk assessment status
→ status	string	Assessment status: Pending, Approved, or Rejected
→ updatedDate	dateTime	Last update timestamp

Stripe Object

Parameter	Type	Description
connectAccountId	string	Stripe Connect account ID (required for payment processing)
dataCapture	object	KYC data capture status
→ status	string	Data capture status: Pending or Completed Note: Status may change if additional verification is required
→ updatedDate	dateTime	Last update timestamp
kyc	object	KYC verification status
→ status	string	KYC status: Pending, Active, Inactive, Restricted, or null Note: null should be treated as Pending
→ updatedDate	dateTime	Last update timestamp
→ paymentsEnabled	boolean	Payment processing enabled status
→ payoutsEnabled	boolean	Payout processing enabled status

Evo Object

Parameter	Type	Description
organisationId	string	EVO organisation identifier. Empty string if not an EVO-linked merchant.
customerReference	string	The customer code from Access Group Finance. Empty string if not set.

Example Response

{
  "divisionAccountId": "div_12345",
  "merchantId": "550e8400-e29b-41d4-a716-446655440000",
  "customerId": "CUST_001",
  "legalName": "Acme Ltd",
  "traceId": "trace_67890",
  "creditRisk": {
    "merchantId": "wf_abc123",
    "dataCapture": {
      "status": "Completed",
      "updatedDate": "2025-07-10T08:41:05.807Z"
    },
    "cra": {
      "status": "Approved",
      "updatedDate": "2025-07-10T08:41:05.807Z"
    }
  },
  "stripe": {
    "connectAccountId": "acct_stripe123",
    "dataCapture": {
      "status": "Completed",
      "updatedDate": "2025-07-10T08:41:26.047Z"
    },
    "kyc": {
      "status": "Active",
      "updatedDate": "2025-07-10T08:41:26.047Z",
      "paymentsEnabled": true,
      "payoutsEnabled": true
    }
  },
  "evo": {
    "organisationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customerReference": "CU12345"
  }
}

Status Reference

Credit Risk Statuses

Data Capture Status

Status	Description
Pending	Customer information collection in progress
Completed	All required information collected

Assessment Status

Status	Description
Pending	Credit assessment not yet completed
Approved	Credit assessment passed
Rejected	Credit assessment failed

Payment Provider Statuses

Data Capture Status

Status	Description
Pending	KYC information collection in progress
Completed	All KYC information collected

KYC Status

Status	Description
Pending / null	KYC verification not started or in progress
Active	Account verified and ready for payments
Inactive	Account verification failed or suspended
Restricted	Account has limitations (check paymentsEnabled/payoutsEnabled)

Integration Guide

Checking Data Capture Status

Monitor these fields to determine if customer action is required:

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

If any status is Pending, call the PUT /merchants/{id} endpoint to get the next required action.

Enabling Payment Processing

Before enabling payments, verify these conditions are met:

• creditRisk.cra.status = Approved
• stripe.kyc.status = Active or Restricted
• stripe.kyc.paymentsEnabled = true

Handling Rejections

If creditRisk.cra.status = Rejected, the customer cannot be onboarded. Risk & Compliance will communicate rejection details directly to the customer.

Timestamp Format

All timestamps use ISO 8601 format with UTC timezone:

• Format: YYYY-MM-DDTHH:mm:ss.fffZ
• Example: 2025-01-16T14:30:00.000Z