Skip to main content

API Reference

Welcome to the comprehensive API reference for Pay Here. This documentation provides development teams with detailed information about available APIs, integration patterns, and implementation guidance for building robust payment solutions.

Overview​

The Pay Here API suite enables software companies to integrate payment processing capabilities through secure, well-documented REST APIs. Our APIs handle everything from customer onboarding and compliance verification to payment processing and management.

API Categories​

Onboarding​

Comprehensive customer onboarding management with complete workflow orchestration. This API handles:

  • Customer Creation: Initialize new customer accounts with required business information
  • Status Tracking: Monitor onboarding progress through all assessment stages
  • Assessment Coordination: Manage integration with Credit Risk evaluation and Stripe Connect KYC processes
  • Webhook Integration: Receive real-time updates on onboarding status changes

Payments​

Direct payment processing capabilities powered by Stripe's infrastructure. Features include:

  • Transaction Processing: Secure payment collection using Stripe's proven platform
  • Payment Methods: Support for cards, digital wallets, and alternative payment options
  • Refund Management: Process partial and full refunds with automated fee calculations
  • Dispute Handling: Integrated chargeback and dispute resolution workflows

Payment Links management solution delivered by PaySuite.

Technical Specifications​

Response Format​

All APIs return consistent JSON responses with standard HTTP status codes for reliable error handling and integration:

Success Responses:

  • 200 OK - Request completed successfully
  • 201 Created - Resource created successfully
  • 202 Accepted - Request accepted for asynchronous processing

Client Error Responses:

  • 400 Bad Request - Invalid request data or parameters
  • 401 Unauthorized - Authentication required or credentials invalid
  • 403 Forbidden - Insufficient permissions for requested operation
  • 404 Not Found - Requested resource does not exist
  • 409 Conflict - Resource conflict or duplicate request

Server Error Responses:

  • 500 Internal Server Error - Unexpected server error occurred
  • 503 Service Unavailable - Temporary service unavailability

Error Response Schema​

Error responses include detailed information to help diagnose issues:

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Validation error",
  "status": 400,
  "detail": "One or more validation errors occurred.",
  "errors": {
    "field": ["Error message"]
  }
}

Integration Support​

Getting Started​

  • Review API category documentation for your specific use case
  • Obtain API credentials through the project setup process
  • Test integration using the demo environment
  • Implement error handling and rate limiting best practices
  • Deploy to production with appropriate monitoring

Developer Resources​

  • SDKs: Official client libraries available from Stripe for streamlined integration
  • cURL Examples: API request for testing and development

Support Channels​

For technical support, integration assistance, or API questions:

  • Documentation: Comprehensive guides and reference materials in the sections below
  • Technical Support: Contact PaySuite support team