Skip to main content

Merchant API

The Merchant API provides comprehensive merchant lifecycle management for the Access PaySuite Group Payments platform. This API handles merchant creation, updates, status tracking, and integration with Credit Risk assessment and Stripe Connect onboarding processes.

info

Obtain your sandbox credentials from your project manager to test your integration.

Base URL​

Sandbox​

https://group.pay.accessacloud.com/pay-here-demo/

Production​

https://group.pay.accessacloud.com/pay-here/

Authentication​

All API requests require authentication using a subscription key. This is provided to SoftCo's during the registration. The subscription key must be supplied in the HTTP header of all API requests to identify and authorize your platform account.

`Ocp-Apim-Subscription-Key`: {PAYSUITE_SUBSCRIPTION_KEY}

Endpoints​

Error handling​

The API uses standard HTTP status codes and provides detailed error information in the response body. Common error scenarios include:

  • Validation Errors (400): Invalid request data or missing required fields
  • Authentication Errors (401): Missing or invalid platform account ID
  • Not Found Errors (404): Merchant not found or access denied
  • Conflict Errors (409): Duplicate merchant creation attempts
  • Server Errors (500): Internal processing errors

Error responses examples​

Status Code: 400 Bad Request​

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "customerId": ["The customerId field is required."],
    "redirectUrl": ["The redirectUrl field must be a valid URL."]
  }
}

Status Code: 401 Unauthorized​

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "You are not authorized to perform this action using the provided PlatformAccountId."
}

Support​

For technical support or questions about the Merchant API:

  • Review the error response details for troubleshooting guidance
  • Check the status endpoints for real-time merchant state information
  • Contact the Access PaySuite development team for integration assistance